iso::event::Event Class Reference

#include <iso_event.h>

List of all members.

Public Member Functions

 Event ()
 default constructor
 Event (double pTime, double pDuration, EventTime pTimeMode)
 create event
 Event (const Event &pEvent)
 copy constructor
 Event (double pTime, const Event &pEvent)
 copy constructor
virtual ~Event ()
 destructor
virtual Eventcopy () const=0
 copy event
virtual Eventcopy (double pTime) const =0
 copy event
base::int64 time () const
 returns absolute time of event (in microsecs)
EventTime timeMode () const
 return event time mode
base::int64 duration () const
 returns event duration (in microsecs)
bool started () const
 check if event has started executing
bool finished () const
 check if event has completely executed
void setTime (double pTime, EventTime pTimeMode)
 set time
void setTime (base::int64 pTime)
 set time
virtual void execute ()=0 throw (EventException)
 execute event
virtual base::String info () const
 obtain textual event information

Protected Attributes

EventTime mTimeMode
base::int64 mTime
 time mode
base::int64 mDuration
 absolute time (in microsecs), this event is going to happen
bool mStarted
 duration (in microsecs), over which the event takes place
bool mFinished
 event started flag

Friends

std::ostream & operator<< (std::ostream &pOstream, const Event &pEvent)
 print event information


Constructor & Destructor Documentation

Event::Event (  ) 

default constructor

Event::Event ( double  pTime,
double  pDuration,
EventTime  pTimeMode 
)

create event

Parameters:
pTime time in milisecs when event will take place
pDuration duration over which the event takes place
pTimeMode whether pTime is relative to current time or absolute (with regard to start of program)

Event::Event ( const Event pEvent  ) 

copy constructor

Parameters:
pEvent event to copy from

Event::Event ( double  pTime,
const Event pEvent 
)

copy constructor

Parameters:
pTime time in milisecs when event will take place
pEvent event to copy from

Event::~Event (  )  [virtual]

destructor


Member Function Documentation

virtual Event* iso::event::Event::copy (  )  const [pure virtual]

copy event

Returns:
copy of event

virtual Event* iso::event::Event::copy ( double  pTime  )  const [pure virtual]

copy event

Parameters:
pTime time in milisecs when event will take place
Returns:
copy of event

base::int64 Event::time (  )  const

returns absolute time of event (in microsecs)

Returns:
absolute time of event (in microsecs)

event::EventTime Event::timeMode (  )  const

return event time mode

Returns:
event time mode

base::int64 Event::duration (  )  const

returns event duration (in microsecs)

Returns:
event duration (in microsecs)

bool Event::started (  )  const

check if event has started executing

Returns:
bool

bool Event::finished (  )  const

check if event has completely executed

Returns:
bool

void Event::setTime ( double  pTime,
EventTime  pTimeMode 
)

set time

Parameters:
pTime time (in milisecs)
pTimeMode whether pTime is relative to current time or absolute (with regard to start of program)

void Event::setTime ( base::int64  pTime  ) 

set time

Parameters:
pTime time (in microsecs)
time is set in absolute mode

virtual void iso::event::Event::execute (  )  throw (EventException) [pure virtual]

execute event

base::String Event::info (  )  const [virtual]

obtain textual event information

Returns:
base::String containing event information


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  pOstream,
const Event pEvent 
) [friend]

print event information

Parameters:
pOstream output stream
pEvent event


Member Data Documentation

EventTime iso::event::Event::mTimeMode [protected]

base::int64 iso::event::Event::mTime [protected]

time mode

base::int64 iso::event::Event::mDuration [protected]

absolute time (in microsecs), this event is going to happen

bool iso::event::Event::mStarted [protected]

duration (in microsecs), over which the event takes place

bool iso::event::Event::mFinished [protected]

event started flag


The documentation for this class was generated from the following files:
Generated on Fri Feb 25 13:58:19 2011 for iso_event by  doxygen 1.5.1