PikeAero::CEvent Class Reference

#include <cevent.h>

Inheritance diagram for PikeAero::CEvent:

Inheritance graph
[legend]
Collaboration diagram for PikeAero::CEvent:

Collaboration graph
[legend]

Public Types


Public Member Functions

 CEvent (CEvent *other)
 CEvent (CObject *sender=NULL, bool senderOwns=false)
virtual void copy (CEvent *other)
Priority priority ()
CObjectsender ()
bool senderOwns ()
void setPriority (Priority p)
void setSender (CObject *object)
void setSenderOwns (bool senderOwns)
void setType (Type type)
Type type ()
virtual ~CEvent ()

Private Attributes

Priority mPriority
CObjectmSender
bool mSenderOwns
Type mType

Detailed Description

Implements an event object.

Author:
Michael Sharkey <mike@pikeaero.com>

Definition at line 33 of file cevent.h.


Member Enumeration Documentation

Enumerator:
PriorityLow 
PriorityStandard 
PriorityHigh 

Definition at line 48 of file cevent.h.

00048                      {
00049             PriorityLow=0,
00050             PriorityStandard,
00051             PriorityHigh
00052         } Priority;

Enumerator:
Invalid 
Tick 
Clock 
Timeout 
AnalogToDigital 
Pump 
EngineTiming 
EngineRPM 
OneShot 
Maximum 

Definition at line 36 of file cevent.h.

00036                      {
00037             Invalid             = 0,        /* invalid or any event type depending on context */
00038             Tick,                           /* timer tick (1/10th second resolution) */
00039             Clock,                          /* wall clock event (1 second) */
00040             Timeout,                        /* some sort of timeout occured */
00041             AnalogToDigital,                /* raw analog to digital readings event */
00042             Pump,                           /* shut pumps on/off */
00043             EngineTiming,                   /* engine timing source */
00044             EngineRPM,                      /* engine RPM broadcast*/
00045             OneShot,                        /* one shot timer event */
00046             Maximum                         /* must be last enum!! */
00047         } Type;


Constructor & Destructor Documentation

PikeAero::CEvent::CEvent ( CObject sender = NULL,
bool  senderOwns = false 
)

Definition at line 24 of file cevent.cpp.

00025  : CObject()
00026 , mSender(sender)
00027 , mType(Invalid)
00028 , mPriority(PriorityLow)
00029 , mSenderOwns(senderOwns)
00030 {
00031 }

PikeAero::CEvent::CEvent ( CEvent other  )  [inline]

Definition at line 55 of file cevent.h.

References copy().

00055 {copy(other);}

Here is the call graph for this function:

PikeAero::CEvent::~CEvent (  )  [virtual]

Definition at line 34 of file cevent.cpp.

00035 {
00036 }


Member Function Documentation

void PikeAero::CEvent::copy ( CEvent other  )  [virtual]

Definition at line 38 of file cevent.cpp.

References priority(), sender(), setPriority(), setSender(), setType(), and type().

Referenced by CEvent().

00039 {
00040     setPriority( other->priority() );
00041     setType( other->type() );
00042     setSender( other->sender() );
00043 }

Here is the call graph for this function:

Here is the caller graph for this function:

Priority PikeAero::CEvent::priority (  )  [inline]

Definition at line 61 of file cevent.h.

References mPriority.

Referenced by copy().

00061 {return mPriority;}

Here is the caller graph for this function:

CObject* PikeAero::CEvent::sender (  )  [inline]

Definition at line 67 of file cevent.h.

References mSender.

Referenced by PikeAero::CInputTimingToothCounter::callback(), and copy().

00067 {return mSender;}

Here is the caller graph for this function:

bool PikeAero::CEvent::senderOwns (  )  [inline]

Definition at line 70 of file cevent.h.

References mSenderOwns.

00070 {return mSenderOwns;}

void PikeAero::CEvent::setPriority ( Priority  p  )  [inline]

Definition at line 60 of file cevent.h.

References mPriority.

Referenced by copy().

00060 {mPriority = p;}

Here is the caller graph for this function:

void PikeAero::CEvent::setSender ( CObject object  )  [inline]

Definition at line 66 of file cevent.h.

References mSender.

Referenced by copy(), and PikeAero::CObject::dispatch().

00066 {mSender=object;}

Here is the caller graph for this function:

void PikeAero::CEvent::setSenderOwns ( bool  senderOwns  )  [inline]

Definition at line 69 of file cevent.h.

References mSenderOwns.

void PikeAero::CEvent::setType ( Type  type  )  [inline]

Type PikeAero::CEvent::type (  )  [inline]


Field Documentation

Definition at line 75 of file cevent.h.

Referenced by priority(), and setPriority().

Definition at line 73 of file cevent.h.

Referenced by sender(), and setSender().

Definition at line 76 of file cevent.h.

Referenced by senderOwns(), and setSenderOwns().

Definition at line 74 of file cevent.h.

Referenced by setType(), and type().


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

Generated on Sun Oct 25 14:00:01 2009 for stingray3 by  doxygen 1.5.8