IGSTK
|
This class produces ClockTickEvents at a user-defined frequency. More...
#include <igstkPulseGenerator.h>
Public Member Functions | |
void | RequestStop () |
Request to stop generating pulses. | |
virtual double | GetFrequency () |
Return the value set for the frequency of this pulse generator. | |
![]() | |
virtual const char * | GetNameOfClass () const |
void | SetLogger (LoggerType *logger) |
Connect the Logger for this class. | |
void | RemoveObserver (unsigned long tag) const |
Static Public Member Functions | |
static void | CheckTimeouts () |
Method to be called from the main event loop in order to keep the timers counting. | |
static void | Sleep (unsigned int milliseconds) |
Sleep for a number of milliseconds. | |
![]() | |
static Pointer | New (void) |
Protected Member Functions | |
PulseGenerator (void) | |
Constructor is protected in order to enforce the use of the New() operator. | |
virtual | ~PulseGenerator (void) |
virtual void | PrintSelf (std::ostream &os, itk::Indent indent) const |
Print the object information. | |
![]() | |
LoggerType * | GetLogger () const |
Object (void) | |
Constructor is protected in order to enforce the use of the New() operator. | |
virtual | ~Object (void) |
void | RegisterObservedObject (const ::igstk::Object *object, unsigned long tag) |
Register observed objects in an internal array so that they can be disconnected upon destruction. | |
void | RemoveFromObservedObjects () |
Remove observers that this object may have connected to other objects. |
Additional Inherited Members | |
![]() | |
typedef Object | Self |
General Typedefs. | |
typedef ::itk::Object | Superclass |
typedef ::itk::SmartPointer< Self > | Pointer |
typedef ::itk::SmartPointer < const Self > | ConstPointer |
typedef igstk::Logger | LoggerType |
This class produces ClockTickEvents at a user-defined frequency.
The PulseGenerator is used for generating ClockTickEvents at regular intervals. The pulses are used by classes that need to perform tasks at user-defined frequencies. For example the View classes use the PulseGenerator in order to refresh a predefined frame rate. The precision of the time interval between the pulses is limited by the underlying time functions of the platform. In most cases you should not expect precision below the millisecond range.
"PulseGenerator State Machine Diagram" "PulseGenerator State Machine Diagram"
Definition at line 49 of file igstkPulseGenerator.h.
|
protected |
Constructor is protected in order to enforce the use of the New() operator.
|
protectedvirtual |
void igstk::PulseGenerator::RequestStop | ( | ) |
Request to stop generating pulses.
This is only a request. It may or may not be honored depending on the current state of the StateMachine.
|
virtual |
Return the value set for the frequency of this pulse generator.
|
static |
Method to be called from the main event loop in order to keep the timers counting.
|
static |
Sleep for a number of milliseconds.
|
protectedvirtual |
Print the object information.
Reimplemented from igstk::Object.