sutil::CSystemClock Class Reference

#include <CSystemClock.hpp>

Inheritance diagram for sutil::CSystemClock:

Collaboration diagram for sutil::CSystemClock:

Static Public Member Functions
static bool	start ()
static suClock	getSysTime ()
static suClock	getSimTime ()
static void	tick (suClock arg_dt)
static void	progressToTime (const timeval &arg_t_start, const suClock arg_time_increment=1.0, const bool arg_increment_sim_clock=true)

Private Member Functions
	CSystemClock ()
	CSystemClock (const CSystemClock &)
CSystemClock &	operator= (const CSystemClock &)

Static Private Member Functions
static suClock	computeTDiff (const timeval &arg_t_start)
static SSystemClock *	getData ()
static bool	resetData ()

Private Attributes
SSystemClock	data_

Static Private Attributes
static CSingleton *	singleton_

Detailed Description

A system (global) clock to measure time in seconds.

Since it uses the singleton to ensure global time syncing, a "startClock" function must be called to initialize the time to zero.

NOTE : This class does not do any error checks while returning the time. Make sure that start() returns true.

Constructor & Destructor Documentation

sutil::CSystemClock::CSystemClock ( )

private

Private for the singleton

sutil::CSystemClock::CSystemClock ( const CSystemClock &  )

private

Private for the singleton

Member Function Documentation

static suClock sutil::CSystemClock::computeTDiff ( const timeval &  arg_t_start )

inlinestaticprivate

Computes the elapsed time (in seconds) since the passed timeval

static SSystemClock * sutil::CSingleton< SSystemClock >::getData ( )

staticinherited

Creates a singleton if necessary and returns it.

Returns a pointer instead of a reference to support a 0 return when there is an error

static suClock sutil::CSystemClock::getSimTime ( )

inlinestatic

Returns the current simulation time. Increment this by calling the tick() function

static suClock sutil::CSystemClock::getSysTime ( )

inlinestatic

Returns the system time (in seconds) since the clock was initialized.

CSystemClock& sutil::CSystemClock::operator= ( const CSystemClock &  )

private

Private for the singleton

static void sutil::CSystemClock::progressToTime ( const timeval &  arg_t_start, const suClock  arg_time_increment = 1.0, const bool  arg_increment_sim_clock = true  )

inlinestatic

Progresses the simulation time (sleeps if there is nothing to do).

Works approximately.

static bool sutil::CSingleton< SSystemClock >::resetData ( )

staticinherited

Deletes the singleton instance and creates a new one.

static bool sutil::CSystemClock::start ( )

inlinestatic

Forces the singleton to create the object (and hence set the start time through the constructor).

Member Data Documentation

SSystemClock sutil::CSingleton< SSystemClock >::data_

protectedinherited

Shared Memory: The publicly available data that will be shared across the different subsystems

CSingleton* sutil::CSingleton< SSystemClock >::singleton_

staticprotectedinherited

The singleton instance

This initializes the pointer to null

---

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

• /home/samir/Code/control/scl.git/3rdparty/sUtil/src/sutil/CSystemClock.hpp