// In header file
CDPParameterTimerMs myCDPParameterTimerMs;

// In Create()
myCDPParameterTimerMs.Create("MyCDPParameterTimerMs", this);

// In end of Configure() or Activate()
myCDPParameterTimerMs.Restart();      // Will start timing from now

// In ProcessSomething()
if (myCDPParameterTimerMs.TimedOut())
{
  myCDPParameterTimerMs.Restart();    // Start new timing cycle
  CDPMessage("Will be written every time the period specified in the parameter times out.\n")
}

Member Function Documentation

CDPParameterTimerMs::CDPParameterTimerMs()

Default constructs an instance of CDPParameterTimerMs.

[override virtual] void CDPParameterTimerMs::Configure(const char *xml)

Reimplemented from CDPObject::Configure().

Configures CDPParameter from an xml-string and sets up the timer.

[override virtual] void CDPParameterTimerMs::Configure(XMLElementEx *pParameterElement)

Reimplemented from CDPObject::Configure().

Configures CDPParameter from an xml element and sets up the timer.

[override virtual] void CDPParameterTimerMs::Create(const char *shortName, CDPComponent *pParent)

Reimplemented from CDPObject::Create().

Calls CDPParameter::Create(), m_cTimer.Create() and sets up callback when m_timeoutDelay changes.

CDPParameter::Create() will be called with shortName, while m_cTimer.Create() will be called with shortName+"Timer" (to avoid same name for these objects).

double CDPParameterTimerMs::Delay()

Returns the delay set by Reset(delay).

double CDPParameterTimerMs::DeltaTime()

Returns time [s] between last two TimedOut() calls.

[override virtual] void CDPParameterTimerMs::Destroy()

Reimplemented from CDPBaseObject::Destroy().

Destroys the CDPParameter and timer instance.

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

Reimplemented from CDPNode::FillNodeChildren().

Writes its CDPSettings to stream.

double CDPParameterTimerMs::Frequency()

Returns frequency in Hz of time interval between last two TimedOut() calls (equals 1.0/DeltaTime()).

bool CDPParameterTimerMs::IsRunning()

Returns true if timer is running.

double CDPParameterTimerMs::LastTime()

Returns time [s] (since application startup), as calculated by the previous TimedOut() call.

void CDPParameterTimerMs::Reset(double delay)

Resets and sets specified delay timeout in seconds.

Stores the parameter-value and resets the timer.

void CDPParameterTimerMs::Reset()

Resets and sets delay timeout in seconds with value from CDPParameter.

Will call m_cTimer.Reset(Value()).

void CDPParameterTimerMs::Restart()

Resets and starts the timer with value from CDPParameter

void CDPParameterTimerMs::Set()

Sets the timeout flag state to true.

[override virtual] void CDPParameterTimerMs::SetValue(double newValue)

Reimplemented from CDPParameter::SetValue().

Sets the parameter-value and resets the timer.

[virtual] void CDPParameterTimerMs::Start()

Deprecated, use Restart() instead.

bool CDPParameterTimerMs::State()

Returns the state of the timeout flag as calculated by the previous TimedOut() call.

double CDPParameterTimerMs::TimeElapsed()

Returns time [s] elapsed since Start() or Restart() was called.

bool CDPParameterTimerMs::TimedOut()

Updates delta time, checks if timeout and returns true if timeout.