All Frameworks Class Hierarchy This Framework Previous Next Indexes
Visualization Class CATVREventIterator
CATVREventIterator
Usage: you must use this class as is. You should never derive it.
public class CATVREventIterator
Class to directly access the device driver events in the event set structure.
Role : Whereas the CATVRDispatcherOnIdle gives you access to the event on every idle, the CATVREventIterator allows you to directly access the event set
structure anytime.
The iterator also acts as a filter so that you can only access the events whose types
were specifified at the object construction.
You iterate on a frozen event set. Call
Synchronize to update that frozen set with the newly arrived events.
You may access the event set from any thread.
Constructor and Destructor Index
- o
CATVREventIterator(CATListOfCATVRDeviceEvent)
- Construct a CATVREventIterator
Do not use the created instance in a thread different from the one
used for creation.
- o
~CATVREventIterator()
-
Method Index
- o
Current()
- Return the current pointed event.
- o
Newer()
- Return the event immediatly more recent than the last pointed event.
- o
Newest()
- Return the newest event you may access in the event set.
- o
Older()
- Return the event immediatly older than the last pointed event.
- o
Oldest()
- Return the oldest event you may access in the event set.
- o
Synchronize()
- Update the frozen iteration event set on the dynamic event set.
Constructor and Destructor
o CATVREventIterator
-
Construct a CATVREventIterator
Do not use the created instance in a thread different from the one
used for creation.
- Parameters:
-
- iEventsToParse
- iEventsToParse refers to the event types you are interested in.
You will then iterate on these event types only.
o ~CATVREventIterator
public ~CATVREventIterator( | ) |
-
Methods
o Current
-
Return the current pointed event.
o Newer
-
Return the event immediatly more recent than the last pointed event.
Legal values: The returned event pointer may be NULL.
o Newest
-
Return the newest event you may access in the event set.
o Older
-
Return the event immediatly older than the last pointed event.
Legal values: The returned event pointer may be NULL.
o Oldest
-
Return the oldest event you may access in the event set.
o Synchronize
public void Synchronize( | ) |
-
Update the frozen iteration event set on the dynamic event set.
At anytime, you may only access the events posted between the two last
calls to Synchronize. This call is time consuming. You should not
use it at a frequency high above the draw rate.
This object is included in the file: CATVREventIterator.h
If needed, your Imakefile.mk should include the module: CATVisVR