CDPTimer myTimer;   // declaration

myTimer.Reset( 10.0 );    // Set timeout value in seconds
myTimer.Start();          // Will start timing from now

if (myTimer.TimedOut())
{
  myTimer.Restart();    // Start new timing cycle
  CDPMessage("This message will be written every 10s.\n")
}

CDPTimer myTimer;
myTimer.Start();

myTimer.TimedOut()
SomeFunctionWeWantToMesureDurationOf();
myTimer.TimedOut();
double duration = myTimer.DeltaTime();
CDPMessage("SomeFunctionWeWantToMesureDurationOf() took %f seconds.\n", duration);

Member Function Documentation

CDPTimer::CDPTimer(bool editableTimeout = false)

Constructs a CDPTimer

[virtual] void CDPTimer::Create(const char *shortName, CDPBaseObject *pParent)

Stores shortName, calls parent's RegisterCDPNode() and sets up callback when m_timeoutDelay changes.

double CDPTimer::Delay()

Gets the delay in seconds set by Reset(double delay)

double CDPTimer::DeltaTime()

Reads time in seconds between last two TimedOut() calls.

[virtual] void CDPTimer::Destroy()

Calls parent's UnRegisterCDPNode().

[override virtual] void CDPTimer::FillNodeChildren(CDP::StudioAPI::NodeStream &stream) const

Reimplemented from CDPNode::FillNodeChildren().

Writes its CDPSettings to stream.

double CDPTimer::Frequency()

Reads frequency in Hz of time interval between last two TimedOut() calls.

[static] int64_t CDPTimer::GetCountsPrSec(void)

[override virtual] const std::string CDPTimer::GetNodeName() const

Reimplemented from ICDPNode::GetNodeName().

Returns m_timerName

[override virtual] std::string CDPTimer::GetNodeTypeName() const

Reimplemented from ICDPNode::GetNodeTypeName().

Returns "CDPTimer"

[static] int CDPTimer::Init()

Initializes CDPTimer::zeroTime to current time if it is 0. Returns 0 if initialization failed.

bool CDPTimer::IsRunning()

Returns true if timer is running.

double CDPTimer::LastTime()

Gets time in seconds between last TimedOut() called and the first CDPTimer initialized.

void CDPTimer::Reset(double delay)

Resets and sets delay timeout in seconds.

This method automatically initializes the timer (calls Init()) if necessary. Remember to call Start() to enable the timeout timer after a call to Reset().

void CDPTimer::Reset()

Resets the timeout timer flag and stop the timer (m_timedout and m_running are set to false).

This method automatically initializes the timer (calls Init()) if necessary. Remember to call Start() to enable the timeout timer after a call to Reset().

void CDPTimer::Restart()

Resets and starts the timer.

Call this method after each TimedOut() with timeout to enable next timeout checking. Call this method to Reset and Start the timer (equals calling Reset() and Start())

[static protected] int64_t CDPTimer::SecondsToTimerCounts(double seconds)

Multiplies seconds with CDPTimer::l_timerCountsPrSec.

void CDPTimer::Set()

Sets m_timedout to true.

[static] void CDPTimer::SetCountsPrSec(int64_t ticks)

Sets ticks to the CDPTimer::l_timerCountsPrSec.

void CDPTimer::SetModel(const std::string &model)

Sets m_model of CDPTimer.

void CDPTimer::SetTimeoutDelayCallback(std::function<void( CDP::StudioAPI::CDPVariantValue ) > callback)

Sets up callback when m_timeoutDelay changes.

[static] void CDPTimer::SetZeroTime(double timeOffset)

Sets new zero time by muliplying CDPTimer::l_timerCountsPrSec with timeOffset.

[virtual] void CDPTimer::Start()

Starts timer.

bool CDPTimer::State()

Returns true if timer is timed out, as calculated in TimedOut().

[static] double CDPTimer::Time()

Gets current time in seconds since first CDPTimer initialized.

double CDPTimer::TimeElapsed()

Gets time in seconds from the last Start() (or Restart()) was called.

bool CDPTimer::TimedOut()

Returns true if timer has timed out. Updates delta time, returned by DeltaTime().

Remember to Restart() the timer after reaching timeout delay time. It is not necessary to call TimedOut() periodically at an accurate time interval, the timer keeps track of real time internally.

See also DeltaTime() and Time().

[static protected] double CDPTimer::TimerCountsToSeconds(int64_t counts)

Divides counts with CDPTimer::l_timerCountsPrSec.