adaptors/base/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) 2015 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
  28 namespace Internal
  29 {
  30
  31 namespace Adaptor
  32 {
  33
  34 class EnvironmentOptions;
  35
  36 /**
  37  * This outputs the status of the update as required.
  38  */
  39 class UpdateStatusLogger
  40 {
  41 public:
  42
  43   /**
  44    * Create the update-status-logger.
  45    * @param[in] environmentOptions environment options
  46    */
  47   UpdateStatusLogger( const EnvironmentOptions& environmentOptions );
  48
  49   /**
  50    * Non-virtual destructor; UpdateThread is not suitable as a base class.
  51    */
  52   ~UpdateStatusLogger();
  53
  54   /**
  55    * Optionally output the update thread status.
  56    * @param[in] keepUpdatingStatus Whether the update-thread requested further updates.
  57    */
  58   void Log( unsigned int keepUpdatingStatus );
  59
  60 private: // Data
  61
  62   unsigned int mStatusLogInterval;   ///< Interval in frames between status debug prints
  63   unsigned int mStatusLogCount;      ///< Used to count frames between status debug prints
  64 };
  65
  66 } // namespace Adaptor
  67
  68 } // namespace Internal
  69
  70 } // namespace Dali
  71
  72 #endif // __DALI_INTERNAL_UPDATE_STATUS_LOGGER_H__