Blueprint Help Send comments on this topic.
The Timer Object

Glossary Item Box

Description

 

This executable object allows active objects (methods, call-backs and threads) to sleep until unblocked by an event from the timer object.  The object can be configured to generate periodic events at any frequency supported by the host operating system.  If the sleep period is significant then over-all performance could be affected by the blocking of methods or call backs and so timer objects are typically associated with threads.

Executable timers are referenced through access functions whose names are derived from timer instance names.

Creation Attributes

Name

Instance name (see Object Names)

Dimension

Instance dimensionality (see Object Dimensionality)

Presence

Instance presence flag (see Object Presence)

Member Functions

SetPeriod( Uns )

This function takes a single (unsigned integer) argument which determines the timer period in milliseconds. 

Synch()

This function resets the timer.  Events will be generated periodically from the reset time.

WaitEvent()

This function blocks the calling thread until the next timer event.

Example

See Generating a Periodic Timer Event.