YARP
Yet Another Robot Platform
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
yarp::os::Timer::PrivateImpl Class Referenceabstract
+ Inheritance diagram for yarp::os::Timer::PrivateImpl:

Public Types

using TimerCallback = yarp::os::Timer::TimerCallback
 

Public Member Functions

 PrivateImpl (const TimerSettings &sett, TimerCallback call, yarp::os::Mutex *mutex)
 
 PrivateImpl (const TimerSettings &sett, TimerCallback call, std::mutex *mutex=nullptr)
 
virtual ~PrivateImpl ()=default
 
virtual bool startTimer ()=0
 
virtual void stopTimer ()=0
 
virtual bool stepTimer ()=0
 
virtual bool timerIsRunning ()=0
 

Public Attributes

TimerSettings m_settings
 
TimerCallback m_callback
 
double m_startStamp {0.0}
 
double m_lastReal {0.0}
 
std::mutex * m_mutex {nullptr}
 
yarp::os::Mutex * m_old_mutex {nullptr}
 

Protected Member Functions

yarp::os::YarpTimerEvent getEventNow (unsigned int iteration)
 
bool runTimer (unsigned int iteration, YarpTimerEvent event)
 

Detailed Description

Definition at line 24 of file Timer.cpp.

Member Typedef Documentation

◆ TimerCallback

using yarp::os::Timer::PrivateImpl::TimerCallback = yarp::os::Timer::TimerCallback

Definition at line 32 of file Timer.cpp.

Constructor & Destructor Documentation

◆ PrivateImpl() [1/2]

yarp::os::Timer::PrivateImpl::PrivateImpl ( const TimerSettings &  sett,
TimerCallback  call,
yarp::os::Mutex *  mutex 
)
inline

Definition at line 37 of file Timer.cpp.

◆ PrivateImpl() [2/2]

yarp::os::Timer::PrivateImpl::PrivateImpl ( const TimerSettings &  sett,
TimerCallback  call,
std::mutex *  mutex = nullptr 
)
inline

Definition at line 48 of file Timer.cpp.

◆ ~PrivateImpl()

virtual yarp::os::Timer::PrivateImpl::~PrivateImpl ( )
virtualdefault

Member Function Documentation

◆ getEventNow()

YarpTimerEvent yarp::os::Timer::PrivateImpl::getEventNow ( unsigned int  iteration)
protected

Definition at line 370 of file Timer.cpp.

◆ runTimer()

bool yarp::os::Timer::PrivateImpl::runTimer ( unsigned int  iteration,
YarpTimerEvent  event 
)
protected

Definition at line 383 of file Timer.cpp.

◆ startTimer()

virtual bool yarp::os::Timer::PrivateImpl::startTimer ( )
pure virtual

Implemented in ThreadedTimer, and MonoThreadTimer.

◆ stepTimer()

virtual bool yarp::os::Timer::PrivateImpl::stepTimer ( )
pure virtual

Implemented in ThreadedTimer, and MonoThreadTimer.

◆ stopTimer()

virtual void yarp::os::Timer::PrivateImpl::stopTimer ( )
pure virtual

Implemented in ThreadedTimer, and MonoThreadTimer.

◆ timerIsRunning()

virtual bool yarp::os::Timer::PrivateImpl::timerIsRunning ( )
pure virtual

Implemented in ThreadedTimer, and MonoThreadTimer.

Member Data Documentation

◆ m_callback

TimerCallback yarp::os::Timer::PrivateImpl::m_callback

Definition at line 69 of file Timer.cpp.

◆ m_lastReal

double yarp::os::Timer::PrivateImpl::m_lastReal {0.0}

Definition at line 71 of file Timer.cpp.

◆ m_mutex

std::mutex* yarp::os::Timer::PrivateImpl::m_mutex {nullptr}

Definition at line 72 of file Timer.cpp.

◆ m_old_mutex

yarp::os::Mutex* yarp::os::Timer::PrivateImpl::m_old_mutex {nullptr}

Definition at line 76 of file Timer.cpp.

◆ m_settings

TimerSettings yarp::os::Timer::PrivateImpl::m_settings

Definition at line 68 of file Timer.cpp.

◆ m_startStamp

double yarp::os::Timer::PrivateImpl::m_startStamp {0.0}

Definition at line 70 of file Timer.cpp.

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