IGSTK
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
igstk::PulseGenerator Class Reference

This class produces ClockTickEvents at a user-defined frequency. More...

#include <igstkPulseGenerator.h>

Inheritance diagram for igstk::PulseGenerator:
Inheritance graph
[legend]
Collaboration diagram for igstk::PulseGenerator:
Collaboration graph
[legend]

Public Member Functions

void RequestStop ()
 Request to stop generating pulses. More...
 
virtual double GetFrequency ()
 Return the value set for the frequency of this pulse generator. More...
 
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
 
void SetLogger (LoggerType *logger)
 Connect the Logger for this class. More...
 
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. More...
 
static void Sleep (unsigned int milliseconds)
 Sleep for a number of milliseconds. More...
 
- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
 

Protected Member Functions

 PulseGenerator (void)
 Constructor is protected in order to enforce the use of the New() operator. More...
 
virtual ~PulseGenerator (void)
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information. More...
 
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator. More...
 
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. More...
 
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects. More...
 

Additional Inherited Members

- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs. More...
 
typedef ::itk::Object Superclass
 
typedef ::itk::SmartPointer< SelfPointer
 
typedef ::itk::SmartPointer
< const Self
ConstPointer
 
typedef igstk::Logger LoggerType
 

Detailed Description

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.

igstkPulseGenerator.png

"PulseGenerator State Machine Diagram" "PulseGenerator State Machine Diagram"

Definition at line 49 of file igstkPulseGenerator.h.

Constructor & Destructor Documentation

igstk::PulseGenerator::PulseGenerator ( void  )
protected

Constructor is protected in order to enforce the use of the New() operator.

virtual igstk::PulseGenerator::~PulseGenerator ( void  )
protectedvirtual

Member Function Documentation

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
protectedvirtual

Print the object information.

Reimplemented from igstk::Object.


The documentation for this class was generated from the following file: