Reference

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 getName () const

returns name of behavior

Static Public Member Functions

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

void encodeHeader (char **dst, unsigned int pformat)

writes packet type and timestamp

template<class T> void encode (char **dst, const T &value)

writes value to dst and advances dst

template<class T> 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

const unsigned int packet_wmclass = 12

Private Member Functions

WMMonitorBehavior (const WMMonitorBehavior &)

don't call

WMMonitorBehavior operator= (const WMMonitorBehavior &)

don't call

Constructor & Destructor Documentation

WMMonitorBehavior::WMMonitorBehavior ( const WMMonitorBehavior & ) [private]

don't call

WMMonitorBehavior::WMMonitorBehavior ( ) [inline]

constructor

Definition at line 36 of file WMMonitorBehavior.h.

virtual WMMonitorBehavior::~WMMonitorBehavior ( ) [inline, virtual]

destructor

Definition at line 41 of file WMMonitorBehavior.h.

Member Function Documentation

virtual void WMMonitorBehavior::DoStart ( ) [inline, virtual]

By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.

Reimplemented from BehaviorBase.
Definition at line 64 of file WMMonitorBehavior.h.

virtual void WMMonitorBehavior::DoStop ( ) [inline, virtual]

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 ).

Reimplemented from BehaviorBase.
Definition at line 78 of file WMMonitorBehavior.h.

template<class T>

void WMMonitorBehavior::encode ( char ** dst,

const T * src,

int num

) [inline, static, protected]

writes length bytes from src to dst

Definition at line 126 of file WMMonitorBehavior.h.

template<class T>

void WMMonitorBehavior::encode ( char ** dst,

const T & value

) [inline, static, protected]

writes value to dst and advances dst

Definition at line 117 of file WMMonitorBehavior.h.
Referenced by encodeHeader(), and report().

void WMMonitorBehavior::encodeHeader ( char ** dst,

unsigned int pformat

) [inline, static, protected]

writes packet type and timestamp

Definition at line 111 of file WMMonitorBehavior.h.
Referenced by report().

WMitem_base * WMMonitorBehavior::find ( std::string & s )

Finds the item with the corresponding name.

Definition at line 54 of file WMMonitorBehavior.cc.
Referenced by registerData().

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).

Reimplemented from BehaviorBase.
Definition at line 102 of file WMMonitorBehavior.h.

virtual std::string WMMonitorBehavior::getName ( ) const [inline, virtual]

returns name of behavior

Implements BehaviorBase.
Definition at line 101 of file WMMonitorBehavior.h.

virtual unsigned int WMMonitorBehavior::getPort ( ) const [inline, virtual]

returns network port from config

Definition at line 99 of file WMMonitorBehavior.h.

WMMonitorBehavior WMMonitorBehavior::operator= ( const WMMonitorBehavior & ) [private]

don't call

virtual void WMMonitorBehavior::processEvent ( const EventBase & e ) [inline, virtual]

By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.

Reimplemented from BehaviorBase.
Definition at line 88 of file WMMonitorBehavior.h.

void WMMonitorBehavior::registerData ( const std::string & s )

processes input from the GUI

Definition at line 8 of file WMMonitorBehavior.cc.
Referenced by wmmonitorcmd_callback().

void WMMonitorBehavior::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.

Definition at line 98 of file WMMonitorBehavior.cc.

void WMMonitorBehavior::report ( const std::string & var_type,

const std::string & var_name,

const char * value,

int value_length

)

Writes out the passed information to cmdsock.

Definition at line 89 of file WMMonitorBehavior.cc.

void WMMonitorBehavior::report ( const std::string & var_type,

const std::string & var_name,

const std::string & value

)

Writes out the passed information to cmdsock.

Definition at line 80 of file WMMonitorBehavior.cc.
Referenced by processEvent(), registerData(), and report().

Member Data Documentation

Socket* WMMonitorBehavior::cmdsock [protected]

The input command stream socket.

Definition at line 28 of file WMMonitorBehavior.h.
Referenced by DoStart(), DoStop(), report(), and WMMonitorBehavior().

const unsigned int WMMonitorBehavior::packet_wmclass = 12 [static, protected]

magic id number
Definition at line 109 of file WMMonitorBehavior.h.
Referenced by report().

The documentation for this class was generated from the following files:

Tekkotsu v2.1

Generated Tue Mar 16 23:22:33 2004 by Doxygen 1.3.5