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

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