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. | |
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. | |
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. |
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.
igstk::PulseGenerator::PulseGenerator | ( | void | ) | [protected] |
Constructor is protected in order to enforce the use of the New() operator.
virtual igstk::PulseGenerator::~PulseGenerator | ( | void | ) | [protected, virtual] |
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 double igstk::PulseGenerator::GetFrequency | ( | ) | [virtual] |
Return the value set for the frequency of this pulse generator.
static void igstk::PulseGenerator::CheckTimeouts | ( | ) | [static] |
Method to be called from the main event loop in order to keep the timers counting.
static void igstk::PulseGenerator::Sleep | ( | unsigned int | milliseconds | ) | [static] |
Sleep for a number of milliseconds.
virtual void igstk::PulseGenerator::PrintSelf | ( | std::ostream & | os, |
itk::Indent | indent | ||
) | const [protected, virtual] |
Print the object information.
Reimplemented from igstk::Object.