WMMonitorBehavior Class Reference
#include <WMMonitorBehavior.h>
Inheritance diagram for WMMonitorBehavior:
Detailed Description
Listens to wmmonitor control commands coming in from the command port.
Definition at line 25 of file WMMonitorBehavior.h.
Public Member Functions | |
| WMMonitorBehavior () | |
| constructor | |
| virtual | ~WMMonitorBehavior () |
| destructor | |
| void | registerData (const std::string &s) |
| processes input from the GUI | |
| WMitem_base * | find (std::string &s) |
| Finds the item with the corresponding name. | |
| void | report (const std::string &var_type, const std::string &var_name, const std::string &value) |
| Writes out the passed information to cmdsock. | |
| void | report (const std::string &var_type, const std::string &var_name, const char *value, int value_length) |
| Writes out the passed information to cmdsock. | |
| void | report (const char *var_type, int var_type_length, const char *var_name, int var_name_length, const char *value, int value_length) |
| Writes out the passed information to cmdsock. | |
| virtual void | DoStart () |
| By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods. | |
| virtual void | DoStop () |
By default, subtracts from the reference counter (RemoveReference()), and thus may deletex if zero; Don't forget to still call this when you override this; Warning: call this at the end of your DoStop(), not beginning (it might delete this ). | |
| virtual void | processEvent (const EventBase &e) |
| By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing. | |
| virtual unsigned int | getPort () const |
| returns network port from config | |
| virtual std::string | getDescription () const |
| Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis). | |
Static Public Member Functions | |
| static std::string | getClassDescription () |
| Gives a short description of what this class of behaviors does... you should override this (but don't have to). | |
Static Protected Member Functions | |
| static void | encodeHeader (char **dst, unsigned int pformat) |
| writes packet type and timestamp | |
| template<class T> | |
| static void | encode (char **dst, const T &value) |
| writes value to dst and advances dst | |
| template<class T> | |
| static void | encode (char **dst, const T *src, int num) |
| writes length bytes from src to dst | |
Protected Attributes | |
| Socket * | cmdsock |
| The input command stream socket. | |
Static Protected Attributes | |
| static const unsigned int | packet_wmclass = 14 |
Private Member Functions | |
| WMMonitorBehavior (const WMMonitorBehavior &) | |
| don't call | |
| WMMonitorBehavior | operator= (const WMMonitorBehavior &) |
| don't call | |
Member Function Documentation
| static std::string WMMonitorBehavior::getClassDescription | ( | ) | [inline, static] |
Gives a short description of what this class of behaviors does... you should override this (but don't have to).
If you do override this, also consider overriding getDescription() to return it
Reimplemented from BehaviorBase.
Definition at line 101 of file WMMonitorBehavior.h.
Referenced by getDescription().
| virtual std::string WMMonitorBehavior::getDescription | ( | ) | const [inline, virtual] |
Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis).
By default simply returns getName(), because any calls from a BehaviorBase function to getClassDescription() are going to call BehaviorBase::getClassDescription(), not ~YourSubClass~getClassDescription(), because static functions can't be virtual in C++ (doh!)
This means that getDescription called on a pointer to a BehaviorBase of unknown subtype would always return an empty string, which is pretty useless. So instead we return the name in this situation. If you want getDescription to return getClassDescription, you'll have to override it in your subclass to do so.
Reimplemented from BehaviorBase.
Definition at line 106 of file WMMonitorBehavior.h.
Member Data Documentation
const unsigned int WMMonitorBehavior::packet_wmclass = 14 [static, protected] |
magic id number, corresponds to Listener.java PACKET_WMCLASS
Definition at line 109 of file WMMonitorBehavior.h.
Referenced by report().
The documentation for this class was generated from the following files:
