VSM C++ SDK
Vehicle Specific Modules SDK
ugcs::vsm::Timer_processor::Timer Class Reference

Represents timer instance. More...

#include <timer_processor.h>

Inheritance diagram for ugcs::vsm::Timer_processor::Timer:

Public Types

typedef std::shared_ptr< TimerPtr
 Pointer type.
 
typedef std::weak_ptr< TimerWeak_ptr
 Pointer type.
 

Public Member Functions

 Timer (const Timer_processor::Ptr &processor, std::chrono::milliseconds interval)
 Construct timer instance associated with a processor. More...
 
void Cancel ()
 Cancel running timer. More...
 
bool Is_running () const
 Check if the timer still is running - i.e. More...
 
std::chrono::steady_clock::time_point Get_fire_time () const
 Get time of next timer firing. More...
 

Static Public Member Functions

template<typename... Args>
static Ptr Create (Args &&...args)
 Create an instance. More...
 

Friends

class Timer_processor
 

Detailed Description

Represents timer instance.

Constructor & Destructor Documentation

ugcs::vsm::Timer_processor::Timer::Timer ( const Timer_processor::Ptr processor,
std::chrono::milliseconds  interval 
)

Construct timer instance associated with a processor.

Member Function Documentation

void ugcs::vsm::Timer_processor::Timer::Cancel ( )

Cancel running timer.

Do nothing if timer is not running.

template<typename... Args>
static Ptr ugcs::vsm::Timer_processor::Timer::Create ( Args &&...  args)
inlinestatic

Create an instance.

std::chrono::steady_clock::time_point ugcs::vsm::Timer_processor::Timer::Get_fire_time ( ) const
inline

Get time of next timer firing.

bool ugcs::vsm::Timer_processor::Timer::Is_running ( ) const

Check if the timer still is running - i.e.

will produce handler invocations.


The documentation for this class was generated from the following file: