User Documentation
Centre for Vision, Speech & Signal Processing
DEVELOP IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
TimedEventQueueC::TimedEventQueueC(void)
TimedEventQueueC::TimedEventQueueC(BooleanT)
TimedEventQueueC::Schedule(RealT,const SignalEventC &)
TimedEventQueueC::Schedule(DateC &,const SignalEventC &)
TimedEventQueueC::Cancel(UIntT)
TimedEventQueueC::Shutdown(void)
RCHandleC::IsValid(void) const
RCHandleC::IsValidObject(void) const
RCHandleC::operator=(const RCHandleC &)
RCHandleC::operator==(const RCHandleC &) const
RCHandleC::operator!=(const RCHandleC &) const
RCHandleC::Hash(void) const
RCHandleC::IsConst(void) const
RCHandleC::IsNotConst(void) const
RCHandleC::SetConst(void) const
RCHandleC::Invalidate(void)
RCHandleC::Body(void)
RCHandleC::Body(void) const
TimedEventQueueC
 
Timed event queue body.
 
include "amma/PThread/TimedEventQueue.hh"
User Level:Default
Library:PThreadTools
Example:exChild.cc
Section:Utilities.Threads Utilities.Timing
In Scope:PThread

Parent Classes:

Methods:
TimedEventQueueC()
Default constructor.
Creates an invalid handle.

TimedEventQueueC(BooleanT)
Default constructor.
Creates an invalid handle.

UIntT Schedule(RealT t,const SignalEventC & se)
Schedule event for running after time 't' (in seconds).
Thread safe. Returns an ID for the event, which can be used for canceling it.

UIntT Schedule(DateC & at,const SignalEventC & se)
Schedule event for running.
Thread safe. Returns an ID for the event, which can be used for canceling it.

BooleanT Cancel(UIntT eventID)
Cancel pending event.
Will return TRUE if event in canceled before it was run.

void Shutdown()
Shutdown even queue.
NB. This will block until shutdown is complete

#include "amma/RCHandle.hh"
BooleanT IsValid() const
Check its a valid handle.

BooleanT IsValidObject() const
Check its a valid handle, and that the object is pointed to is also valid.

RCHandleC<TimedEventQueueBodyC> & operator=(const RCHandleC<TimedEventQueueBodyC> & oth)
Assignment.

BooleanT operator==(const RCHandleC<TimedEventQueueBodyC> & oth) const
Comparison operator.

BooleanT operator!=(const RCHandleC<TimedEventQueueBodyC> & oth) const
Comparison operator.

UIntT Hash() const
Hash function.x

BooleanT IsConst() const
Is object constant ?

BooleanT IsNotConst() const
Is object not constant ?

void SetConst(void) const
Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:

void Invalidate()
Turn this into an invalid handle.

TimedEventQueueBodyC & Body()
Direct access to body.

const TimedEventQueueBodyC & Body() const
Constant access to body.


Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001