TextMsgEvent Class Reference
Extends EventBase to also include actual message text. More...
#include <TextMsgEvent.h>
Detailed Description
Extends EventBase to also include actual message text.
Definition at line 8 of file TextMsgEvent.h.
Public Member Functions | |
| TextMsgEvent () | |
| Constructor. | |
| TextMsgEvent (const std::string &text, size_t srcID=-1U) | |
| Constructor, pass a text msg. | |
| 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. | |
| std::string | getText () const |
| returns the text | |
| TextMsgEvent & | setText (const std::string &text) |
| sets the text | |
| 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 | |
Protected Attributes | |
| std::string | _text |
| the unmodified arguments passed to the command | |
Static Protected Attributes | |
| static const EventBase::classTypeID_t | autoRegisterTextMsgEvent = getTypeRegistry().registerType<TextMsgEvent>(makeClassTypeID("TXTM")) |
| causes class type id to automatically be regsitered with EventBase's FamilyFactory (getTypeRegistry()) | |
Constructor & Destructor Documentation
| TextMsgEvent::TextMsgEvent | ( | ) |
| TextMsgEvent::TextMsgEvent | ( | const std::string & | text, | |
| size_t | srcID = -1U | |||
| ) |
Constructor, pass a text msg.
Definition at line 14 of file TextMsgEvent.h.
Member Function Documentation
| virtual EventBase* TextMsgEvent::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 16 of file TextMsgEvent.h.
| unsigned int TextMsgEvent::getBinSize | ( | ) | const [virtual] |
should return the minimum size needed if using binary format (i.e. not XML)
Reimplemented from EventBase.
Definition at line 17 of file TextMsgEvent.cc.
| virtual unsigned int TextMsgEvent::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 18 of file TextMsgEvent.h.
| std::string TextMsgEvent::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 EventBase.
Definition at line 8 of file TextMsgEvent.cc.
| std::string TextMsgEvent::getText | ( | ) | const |
returns the text
Definition at line 20 of file TextMsgEvent.h.
Referenced by CameraBehavior::doEvent(), and MoCapLogger::gotTxtMsgSingle().
| unsigned int TextMsgEvent::loadBinaryBuffer | ( | const char | buf[], | |
| unsigned int | len | |||
| ) | [virtual] |
load from binary format
Reimplemented from EventBase.
Definition at line 29 of file TextMsgEvent.cc.
| void TextMsgEvent::loadXML | ( | xmlNode * | node | ) | [virtual] |
| unsigned int TextMsgEvent::saveBinaryBuffer | ( | char | buf[], | |
| unsigned int | len | |||
| ) | const [virtual] |
| void TextMsgEvent::saveXML | ( | xmlNode * | node | ) | const [virtual] |
| TextMsgEvent& TextMsgEvent::setText | ( | const std::string & | text | ) |
sets the text
Definition at line 21 of file TextMsgEvent.h.
Member Data Documentation
std::string TextMsgEvent::_text [protected] |
the unmodified arguments passed to the command
Definition at line 32 of file TextMsgEvent.h.
Referenced by getBinSize(), getDescription(), getText(), loadBinaryBuffer(), loadXML(), saveBinaryBuffer(), saveXML(), and setText().
const EventBase::classTypeID_t TextMsgEvent::autoRegisterTextMsgEvent = getTypeRegistry().registerType<TextMsgEvent>(makeClassTypeID("TXTM")) [static, protected] |
causes class type id to automatically be regsitered with EventBase's FamilyFactory (getTypeRegistry())
Definition at line 35 of file TextMsgEvent.h.
Referenced by getClassTypeID().
The documentation for this class was generated from the following files:
