KoduSayEvent Class Reference
#include <KoduSayEvent.h>
Detailed Description
Definition at line 8 of file KoduSayEvent.h.
Public Member Functions | |
| KoduSayEvent () | |
| KoduSayEvent (const std::string &phrase) | |
| ~KoduSayEvent () | |
| virtual std::string | getDescription (bool showTypeSpecific, unsigned int verbosity) 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 | saveBinaryBuffer (char buf[], unsigned int len) const |
| save to binary format | |
| virtual unsigned int | loadBinaryBuffer (const char buf[], unsigned int len) |
| load from binary format | |
| std::string | getPhrase () const |
Static Public Attributes | |
| static const char * | classID = "KoduEventBase::KoduSayEvent" |
Private Attributes | |
| std::string | _phrase |
Constructor & Destructor Documentation
| KoduSayEvent::KoduSayEvent | ( | ) |
Definition at line 15 of file KoduSayEvent.h.
| KoduSayEvent::KoduSayEvent | ( | const std::string & | phrase | ) |
Definition at line 17 of file KoduSayEvent.h.
| KoduSayEvent::~KoduSayEvent | ( | ) |
Definition at line 19 of file KoduSayEvent.h.
Member Function Documentation
| unsigned int KoduSayEvent::getBinSize | ( | ) | const [virtual] |
should return the minimum size needed if using binary format (i.e. not XML)
Reimplemented from KoduEventBase.
Definition at line 13 of file KoduSayEvent.cc.
| std::string KoduSayEvent::getDescription | ( | bool | showTypeSpecific, | |
| unsigned int | verbosity | |||
| ) | 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 KoduEventBase.
Definition at line 5 of file KoduSayEvent.cc.
| std::string KoduSayEvent::getPhrase | ( | ) | const |
Definition at line 40 of file KoduSayEvent.cc.
Referenced by KoduInterpreter::KoduEventListener::doEvent().
| unsigned int KoduSayEvent::loadBinaryBuffer | ( | const char | buf[], | |
| unsigned int | len | |||
| ) | [virtual] |
load from binary format
Reimplemented from KoduEventBase.
Definition at line 32 of file KoduSayEvent.cc.
| unsigned int KoduSayEvent::saveBinaryBuffer | ( | char | buf[], | |
| unsigned int | len | |||
| ) | const [virtual] |
save to binary format
Reimplemented from KoduEventBase.
Definition at line 24 of file KoduSayEvent.cc.
Member Data Documentation
std::string KoduSayEvent::_phrase [private] |
Definition at line 10 of file KoduSayEvent.h.
Referenced by getBinSize(), getDescription(), getPhrase(), loadBinaryBuffer(), and saveBinaryBuffer().
const char * KoduSayEvent::classID = "KoduEventBase::KoduSayEvent" [static] |
Reimplemented from KoduEventBase.
Definition at line 13 of file KoduSayEvent.h.
Referenced by getBinSize(), KoduEventBase::getInstance(), loadBinaryBuffer(), and saveBinaryBuffer().
The documentation for this class was generated from the following files:
