LookoutIREvent Class Reference
#include <LookoutEvents.h>
Inheritance diagram for LookoutIREvent:
Detailed Description
Definition at line 77 of file LookoutEvents.h.
Public Member Functions | |
| virtual LookoutEventType_t | getLookoutEventType () const |
| LookoutIREvent (float dist, const NEWMAT::Matrix &mat) | |
| LookoutIREvent (float dist, const NEWMAT::Matrix &mat, EventGeneratorID_t gid, unsigned int sid, EventTypeID_t tid, unsigned int dur=0) | |
| LookoutIREvent (float dist, const NEWMAT::Matrix &mat, EventGeneratorID_t gid, unsigned int sid, EventTypeID_t tid, unsigned int dur, const std::string &n, float mag) | |
| virtual EventBase * | clone () const |
| allows a copy to be made of an event, supporting polymorphism | |
| virtual unsigned int | getClassTypeID () const |
| All subclasses should override this and return a unique ID for their class. | |
| virtual std::string | getDescription (bool showTypeSpecific=true, unsigned int verbosity=0) const |
| generates a description of the event with variable verbosity | |
| virtual unsigned int | getBinSize () const |
| should return the minimum size needed if using binary format (i.e. not XML) | |
| virtual unsigned int | loadBinaryBuffer (const char buf[], unsigned int len) |
| load from binary format | |
| virtual unsigned int | saveBinaryBuffer (char buf[], unsigned int len) const |
| save to binary format | |
| virtual void | loadXML (xmlNode *node) |
| load from XML format | |
| virtual void | saveXML (xmlNode *node) const |
| save to XML format | |
Public Attributes | |
| float | distance |
Constructor & Destructor Documentation
| LookoutIREvent::LookoutIREvent | ( | float | dist, | |
| const NEWMAT::Matrix & | mat | |||
| ) | [inline] |
| LookoutIREvent::LookoutIREvent | ( | float | dist, | |
| const NEWMAT::Matrix & | mat, | |||
| EventGeneratorID_t | gid, | |||
| unsigned int | sid, | |||
| EventTypeID_t | tid, | |||
| unsigned int | dur = 0 | |||
| ) | [inline] |
Definition at line 82 of file LookoutEvents.h.
| LookoutIREvent::LookoutIREvent | ( | float | dist, | |
| const NEWMAT::Matrix & | mat, | |||
| EventGeneratorID_t | gid, | |||
| unsigned int | sid, | |||
| EventTypeID_t | tid, | |||
| unsigned int | dur, | |||
| const std::string & | n, | |||
| float | mag | |||
| ) | [inline] |
Definition at line 85 of file LookoutEvents.h.
Member Function Documentation
| virtual EventBase* LookoutIREvent::clone | ( | ) | const [inline, 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 LookoutPointAtEvent.
Definition at line 88 of file LookoutEvents.h.
| unsigned int LookoutIREvent::getBinSize | ( | ) | const [virtual] |
should return the minimum size needed if using binary format (i.e. not XML)
Reimplemented from LookoutPointAtEvent.
Definition at line 141 of file LookoutEvents.cc.
| virtual unsigned int LookoutIREvent::getClassTypeID | ( | ) | const [inline, 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 LookoutPointAtEvent.
Definition at line 89 of file LookoutEvents.h.
| std::string LookoutIREvent::getDescription | ( | bool | showTypeSpecific = true, |
|
| unsigned int | verbosity = 0 | |||
| ) | const [virtual] |
generates a description of the event with variable verbosity
- Parameters:
-
showTypeSpecific should be read by subclasses to add additional information verbosity can be one of the following values: - 0 - Basic: event_name \t generator_id \t source_id \t type_id
- 1 - Numerics: event_name \t generator_id \t source_id \t type_id
- 2 - Timing: event_name \t generator_id \t source_id \t type_id \t duration \t timestamp
- 3 and above - Full: event_name \t generator_id \t source_id \t type_id \t duration \t timestamp \t magnitude if showTypeSpecific, additional fields will be added after the common fields listed above.
Reimplemented from LookoutPointAtEvent.
Definition at line 131 of file LookoutEvents.cc.
| virtual LookoutEventType_t LookoutIREvent::getLookoutEventType | ( | ) | const [inline, virtual] |
| unsigned int LookoutIREvent::loadBinaryBuffer | ( | const char | buf[], | |
| unsigned int | len | |||
| ) | [virtual] |
load from binary format
Reimplemented from LookoutPointAtEvent.
Definition at line 152 of file LookoutEvents.cc.
| void LookoutIREvent::loadXML | ( | xmlNode * | node | ) | [virtual] |
load from XML format
Reimplemented from LookoutPointAtEvent.
Definition at line 177 of file LookoutEvents.cc.
| unsigned int LookoutIREvent::saveBinaryBuffer | ( | char | buf[], | |
| unsigned int | len | |||
| ) | const [virtual] |
save to binary format
Reimplemented from LookoutPointAtEvent.
Definition at line 165 of file LookoutEvents.cc.
| void LookoutIREvent::saveXML | ( | xmlNode * | node | ) | const [virtual] |
save to XML format
Reimplemented from LookoutPointAtEvent.
Definition at line 206 of file LookoutEvents.cc.
Member Data Documentation
| float LookoutIREvent::distance |
Definition at line 79 of file LookoutEvents.h.
Referenced by getBinSize(), getDescription(), loadBinaryBuffer(), loadXML(), saveBinaryBuffer(), and saveXML().
The documentation for this class was generated from the following files:
