SENSSimClock Class Reference

#include <SENSSimClock.h>

Public Member Functions
	SENSSimClock (SENSTimePt startTimePt, SENSTimePt simStartTimePt)
void	pause ()
	pause simulation More...
bool	isPaused () const
void	resume ()
	resume simulation More...
void	reset ()
SENSMicroseconds	passedTime () const
	get passed simulation time More...
SENSTimePt	now () const
	get current simulation time (const function which should be thread save) More...

Private Attributes
std::atomic_bool	_pause {true}
	atomic, because we use it in now without mutex More...
SENSTimePt	_pauseTimePt
std::mutex	_pauseMutex
SENSMicroseconds	_pauseTime {0}
	Offset from pause state: we have to accumulate pause times and subtract it from sim time. More...
SENSTimePt	_startTimePt
	real start time point in the present (when SENSSimulation::start was called) More...
SENSTimePt	_simStartTimePt
	start time point of simulation in the past More...

Detailed Description

SENSSimClock Clock used for sensor simulation in SENSSimulator and SENSSimulated

Definition at line 11 of file SENSSimClock.h.

Constructor & Destructor Documentation

SENSSimClock()

SENSSimClock::SENSSimClock ( SENSTimePt  startTimePt, SENSTimePt  simStartTimePt  )

inline

Definition at line 14 of file SENSSimClock.h.

      : _startTimePt(startTimePt),
        _simStartTimePt(simStartTimePt)
    {
        _pause       = true;
        _pauseTimePt = (SENSTimePt)SENSClock::now();
    }

Member Function Documentation

isPaused()

bool SENSSimClock::isPaused ( ) const

inline

Definition at line 30 of file SENSSimClock.h.

    {
        return _pause;
    }

now()

SENSTimePt SENSSimClock::now ( ) const

inline

get current simulation time (const function which should be thread save)

Definition at line 71 of file SENSSimClock.h.

    {
        SENSMicroseconds passedSimTime;
        if (_pause)
        {
            const std::lock_guard<std::mutex> lock(_pauseMutex);
            passedSimTime = std::chrono::duration_cast<SENSMicroseconds>(_pauseTimePt - _startTimePt) - _pauseTime;
        }
        else
        {
            passedSimTime = std::chrono::duration_cast<SENSMicroseconds>((SENSTimePt)SENSClock::now() - _startTimePt) - _pauseTime;
        }
 
        return _simStartTimePt + passedSimTime;
    }

passedTime()

SENSMicroseconds SENSSimClock::passedTime ( ) const

inline

get passed simulation time

Definition at line 54 of file SENSSimClock.h.

    {
        SENSMicroseconds passedSimTime;
        if (_pause)
        {
            const std::lock_guard<std::mutex> lock(_pauseMutex);
            passedSimTime = std::chrono::duration_cast<SENSMicroseconds>(_pauseTimePt - _startTimePt) - _pauseTime;
        }
        else
        {
            passedSimTime = std::chrono::duration_cast<SENSMicroseconds>((SENSTimePt)SENSClock::now() - _startTimePt) - _pauseTime;
        }
 
        return passedSimTime;
    }

pause()

void SENSSimClock::pause ( )

inline

pause simulation

Definition at line 23 of file SENSSimClock.h.

    {
        std::lock_guard<std::mutex> lock(_pauseMutex);
        _pause       = true;
        _pauseTimePt = (SENSTimePt)SENSClock::now();
    }

reset()

void SENSSimClock::reset ( )

inline

reset simulation (we switch to pause when setting new start, in this way now becomes thread save and we increase performance of now() (no mutex in nomal use))

Definition at line 45 of file SENSSimClock.h.

    {
        pause();
        _startTimePt = SENSClock::now();
        _pauseTime   = SENSMicroseconds(0);
        resume();
    }

resume()

void SENSSimClock::resume ( )

inline

resume simulation

Definition at line 36 of file SENSSimClock.h.

    {
        std::lock_guard<std::mutex> lock(_pauseMutex);
        _pause     = false;
        _pauseTime = _pauseTime + std::chrono::duration_cast<SENSMicroseconds>((SENSTimePt)SENSClock::now() - _pauseTimePt);
    }

Member Data Documentation

_pause

std::atomic_bool SENSSimClock::_pause {true}

private

atomic, because we use it in now without mutex

Definition at line 89 of file SENSSimClock.h.

_pauseMutex

std::mutex SENSSimClock::_pauseMutex

mutableprivate

Definition at line 92 of file SENSSimClock.h.

_pauseTime

SENSMicroseconds SENSSimClock::_pauseTime {0}

private

Offset from pause state: we have to accumulate pause times and subtract it from sim time.

Definition at line 95 of file SENSSimClock.h.

_pauseTimePt

SENSTimePt SENSSimClock::_pauseTimePt

private

Definition at line 90 of file SENSSimClock.h.

_simStartTimePt

SENSTimePt SENSSimClock::_simStartTimePt

private

start time point of simulation in the past

Definition at line 99 of file SENSSimClock.h.

_startTimePt

SENSTimePt SENSSimClock::_startTimePt

private

real start time point in the present (when SENSSimulation::start was called)

Definition at line 97 of file SENSSimClock.h.

---

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

• SENSSimClock.h