Public Member Functions | Protected Member Functions

zeus::TTimerEvent Class Reference

#include <TimerEvent.h>

Inheritance diagram for zeus::TTimerEvent:
zeus::TZObject zeus::IZUnknown

List of all members.

Public Member Functions

 TTimerEvent (ITimerEventObserver &rObserver, bool bPeriodic, Int iObserverThreadID, Int iEventHandle, Int iTime)
ITimerEventObservergetObserver ()
bool getPeriodicState ()
Int getObserverThreadID ()
Int getEventHandle ()
Int getTime ()
virtual Retval MQUALIFIER askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER addRef () const
virtual void MQUALIFIER release () const

Protected Member Functions

virtual ~TTimerEvent ()

Detailed Description

The timer event class holds all needable data to make a timer event callback on an observer object.


Constructor & Destructor Documentation

TTimerEvent::TTimerEvent ( ITimerEventObserver rObserver,
bool  bPeriodic,
Int  iObserverThreadID,
Int  iEventHandle,
Int  iTime 
)

Constructor.

Parameters:
INOUT]rObserver: Reference to observer object
IN]bPeriodic: Mark observer as periodic, not single shot
IN]iObserverThreadID: Thread ID of observer thread
IN]iEventHandle: Unique event handle
IN]iTime: Time gap value
TTimerEvent::~TTimerEvent (  ) [protected, virtual]

Destructor.


Member Function Documentation

virtual void MQUALIFIER zeus::TTimerEvent::addRef (  ) const [virtual]
See also:
IZUnknown::addRef

Reimplemented from zeus::TZObject.

virtual Retval MQUALIFIER zeus::TTimerEvent::askForInterface ( const InterfaceID rInterfaceID,
IZUnknown *&  rpIface 
) [virtual]
See also:
IZUnknown::askForInterface

Reimplemented from zeus::TZObject.

Int TTimerEvent::getEventHandle (  )

Returns the unique timer event handle number.

Returns:
Handle: Timer event handle
ITimerEventObserver & TTimerEvent::getObserver (  )

Returns a reference the registered observer.

Returns:
Reference: Registered observer
Int TTimerEvent::getObserverThreadID (  )

Returns registered observers thread id.

/return ID: Thread id.

bool TTimerEvent::getPeriodicState (  )

Returns the is peroiodic timer event state flag.

Returns:
Flag: Event is periodic, not single shot
Int TTimerEvent::getTime (  )

Returns the time gap value.

Returns:
Value: Time gap value
virtual void MQUALIFIER zeus::TTimerEvent::release (  ) const [virtual]
See also:
IZUnknown::release

Reimplemented from zeus::TZObject.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Sun Jan 22 2012 15:28:41