LookoutScanEvent Class Reference
#include <LookoutEvents.h>
Detailed Description
Definition at line 112 of file LookoutEvents.h.
Public Member Functions | |
| virtual LookoutEventType_t | getLookoutEventType () const |
| LookoutScanEvent () | |
| LookoutScanEvent (std::vector< DualCoding::LookoutScanRequest::Task * > &_tasks) | |
| LookoutScanEvent (std::vector< DualCoding::LookoutScanRequest::Task * > &_tasks, EventGeneratorID_t gid, size_t sid, EventTypeID_t tid, unsigned int dur=0) | |
| LookoutScanEvent (std::vector< DualCoding::LookoutScanRequest::Task * > &_tasks, EventGeneratorID_t gid, size_t sid, EventTypeID_t tid, unsigned int dur, const std::string &n, float mag) | |
| LookoutScanEvent (const LookoutScanEvent &lose) | |
| copy constructor (shallow copy) | |
| const LookoutScanEvent & | operator= (const LookoutScanEvent &lose) |
| assignment operator (shallow copy) | |
| virtual EventBase * | clone () const |
| allows a copy to be made of an event, supporting polymorphism | |
| const std::vector < DualCoding::LookoutScanRequest::Task * > & | getTasks () const |
| virtual unsigned int | getClassTypeID () const |
| All subclasses should override this and return a unique ID for their class. | |
Protected Attributes | |
| std::vector < DualCoding::LookoutScanRequest::Task * > * | tasks |
| pointer to tasks implemented during the scan | |
Static Protected Attributes | |
| static const EventBase::classTypeID_t | autoRegisterLookoutScanEvent = getTypeRegistry().registerType<LookoutScanEvent>(makeClassTypeID("LSCN")) |
| causes class type id to automatically be regsitered with EventBase's FamilyFactory (getTypeRegistry()) | |
Constructor & Destructor Documentation
| LookoutScanEvent::LookoutScanEvent | ( | ) |
Definition at line 118 of file LookoutEvents.h.
Referenced by clone().
| LookoutScanEvent::LookoutScanEvent | ( | std::vector< DualCoding::LookoutScanRequest::Task * > & | _tasks | ) |
Definition at line 119 of file LookoutEvents.h.
| LookoutScanEvent::LookoutScanEvent | ( | std::vector< DualCoding::LookoutScanRequest::Task * > & | _tasks, | |
| EventGeneratorID_t | gid, | |||
| size_t | sid, | |||
| EventTypeID_t | tid, | |||
| unsigned int | dur = 0 | |||
| ) |
Definition at line 120 of file LookoutEvents.h.
| LookoutScanEvent::LookoutScanEvent | ( | std::vector< DualCoding::LookoutScanRequest::Task * > & | _tasks, | |
| EventGeneratorID_t | gid, | |||
| size_t | sid, | |||
| EventTypeID_t | tid, | |||
| unsigned int | dur, | |||
| const std::string & | n, | |||
| float | mag | |||
| ) |
Definition at line 123 of file LookoutEvents.h.
| LookoutScanEvent::LookoutScanEvent | ( | const LookoutScanEvent & | lose | ) |
copy constructor (shallow copy)
Definition at line 127 of file LookoutEvents.h.
Member Function Documentation
| virtual EventBase* LookoutScanEvent::clone | ( | ) | const [virtual] |
allows a copy to be made of an event, supporting polymorphism
Must be overridden by all subclasses to allow this to happen
I would like to switch this over to the cloneable interface once the compiler gets updated out of the 3.3 branch... see Cloneable::clone() for a discussion of the issue and implementation notes.
Reimplemented from EventBase.
Definition at line 136 of file LookoutEvents.h.
| virtual unsigned int LookoutScanEvent::getClassTypeID | ( | ) | const [virtual] |
All subclasses should override this and return a unique ID for their class.
All IDs corresponding to all-capital letters are reserved for future framework expansion. (Thus, user subclasses should contain at least one lower-case letter.) This code can be used when serializing to allow quick identification of the class type by the receiver.
Reimplemented from EventBase.
Definition at line 139 of file LookoutEvents.h.
| virtual LookoutEventType_t LookoutScanEvent::getLookoutEventType | ( | ) | const [virtual] |
Implements LookoutEvent.
Definition at line 117 of file LookoutEvents.h.
| const std::vector<DualCoding::LookoutScanRequest::Task*>& LookoutScanEvent::getTasks | ( | ) | const |
Definition at line 137 of file LookoutEvents.h.
| const LookoutScanEvent& LookoutScanEvent::operator= | ( | const LookoutScanEvent & | lose | ) |
assignment operator (shallow copy)
Definition at line 130 of file LookoutEvents.h.
Member Data Documentation
const EventBase::classTypeID_t LookoutScanEvent::autoRegisterLookoutScanEvent = getTypeRegistry().registerType<LookoutScanEvent>(makeClassTypeID("LSCN")) [static, protected] |
causes class type id to automatically be regsitered with EventBase's FamilyFactory (getTypeRegistry())
Definition at line 142 of file LookoutEvents.h.
Referenced by getClassTypeID().
std::vector<DualCoding::LookoutScanRequest::Task*>* LookoutScanEvent::tasks [protected] |
pointer to tasks implemented during the scan
Definition at line 115 of file LookoutEvents.h.
Referenced by getTasks(), and operator=().
The documentation for this class was generated from the following files:
