dali/internal/system/common/timer-interface.h

   1 #ifndef DALI_INTERNAL_ADAPTOR_SYSTEM_COMMON_TIMER_INTERFACE_H
   2 #define DALI_INTERNAL_ADAPTOR_SYSTEM_COMMON_TIMER_INTERFACE_H
   3
   4 /*
   5  * Copyright (c) 2023 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 #include <cstdint>
  23
  24 namespace Dali
  25 {
  26 namespace Internal
  27 {
  28 namespace Adaptor
  29 {
  30 /**
  31  * Interface for a timer class
  32  */
  33 class TimerInterface
  34 {
  35 public:
  36   /**
  37    * @copydoc Dali::Timer::Start()
  38    */
  39   virtual void Start() = 0;
  40
  41   /**
  42    * @copydoc Dali::Timer::Stop()
  43    */
  44   virtual void Stop() = 0;
  45
  46   /**
  47    * @copydoc Dali::Timer::Pause()
  48    */
  49   virtual void Pause() = 0;
  50
  51   /**
  52    * @copydoc Dali::Timer::Resume()
  53    */
  54   virtual void Resume() = 0;
  55
  56   /**
  57    * @copydoc Dali::Timer::SetInterval()
  58    */
  59   virtual void SetInterval(uint32_t intervalInMilliseconds, bool restart) = 0;
  60
  61   /**
  62    * @copydoc Dali::Timer::GetInterval()
  63    */
  64   virtual uint32_t GetInterval() const = 0;
  65
  66   /**
  67    * @copydoc Dali::Timer::IsRunning()
  68    */
  69   virtual bool IsRunning() const = 0;
  70
  71 protected:
  72   /**
  73    * Virtual protected destructor, no deletion through this interface
  74    */
  75   virtual ~TimerInterface()
  76   {
  77   }
  78 };
  79
  80 } // namespace Adaptor
  81 } // namespace Internal
  82 } // namespace Dali
  83
  84 #endif // DALI_INTERNAL_ADAPTOR_SYSTEM_COMMON_TIMER_INTERFACE_H