dali/internal/system/common/update-status-logger.h

   1 #ifndef DALI_INTERNAL_UPDATE_STATUS_LOGGER_H
   2 #define DALI_INTERNAL_UPDATE_STATUS_LOGGER_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22
  23 // INTERNAL INCLUDES
  24
  25 namespace Dali
  26 {
  27 namespace Internal
  28 {
  29 namespace Adaptor
  30 {
  31 class EnvironmentOptions;
  32
  33 /**
  34  * This outputs the status of the update as required.
  35  */
  36 class UpdateStatusLogger
  37 {
  38 public:
  39   /**
  40    * Create the update-status-logger.
  41    * @param[in] environmentOptions environment options
  42    */
  43   UpdateStatusLogger(const EnvironmentOptions& environmentOptions);
  44
  45   /**
  46    * Non-virtual destructor; UpdateThread is not suitable as a base class.
  47    */
  48   ~UpdateStatusLogger();
  49
  50   /**
  51    * Optionally output the update thread status.
  52    * @param[in] keepUpdatingStatus Whether the update-thread requested further updates.
  53    */
  54   void Log(unsigned int keepUpdatingStatus);
  55
  56 private:                           // Data
  57   unsigned int mStatusLogInterval; ///< Interval in frames between status debug prints
  58   unsigned int mStatusLogCount;    ///< Used to count frames between status debug prints
  59 };
  60
  61 } // namespace Adaptor
  62
  63 } // namespace Internal
  64
  65 } // namespace Dali
  66
  67 #endif // DALI_INTERNAL_UPDATE_STATUS_LOGGER_H