Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

MonitorTest Class Reference

MonitorTest - A simple monitor plugin to use with app/spadestest. More...

#include <monitortest.h>

Inheritance diagram for MonitorTest:

Inheritance graph
[legend]
Collaboration diagram for MonitorTest:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MonitorTest ()
virtual ~MonitorTest ()
virtual void ParseMonitorMessage (const std::string &data)
 If a monitor sends information to the world model, this function is called to process it.
virtual std::string GetMonitorInfo (const oxygen::PredicateList &pList)
 This function will be called periodically to get information about the current state of the world.
virtual std::string GetMonitorHeaderInfo (const oxygen::PredicateList &pList)
 This function is called once for every MonitorSystem each time a new client connects.

Protected Member Functions

virtual bool ConstructInternal ()
 called after the object has been created and attached to a core to allow for object dependent internal construction

Detailed Description

MonitorTest - A simple monitor plugin to use with app/spadestest.

Definition at line 34 of file monitortest.h.


Constructor & Destructor Documentation

MonitorTest::MonitorTest  ) 
 

Definition at line 35 of file monitortest.cpp.

MonitorTest::~MonitorTest  )  [virtual]
 

Definition at line 39 of file monitortest.cpp.


Member Function Documentation

bool MonitorTest::ConstructInternal  )  [protected, virtual]
 

called after the object has been created and attached to a core to allow for object dependent internal construction

Reimplemented from zeitgeist::Object.

Definition at line 43 of file monitortest.cpp.

References zeitgeist::Object::GetLog().

Here is the call graph for this function:

string MonitorTest::GetMonitorHeaderInfo const oxygen::PredicateList pList  )  [virtual]
 

This function is called once for every MonitorSystem each time a new client connects.

It should return any header/setup information that is needed.

Parameters:
items holds a list of additional name value pairs. These predicates are collected from MonitorItem objects registered to the MonitorServer. The monitor should transfer them to the client if possible.

Implements oxygen::MonitorSystem.

Definition at line 90 of file monitortest.cpp.

string MonitorTest::GetMonitorInfo const oxygen::PredicateList pList  )  [virtual]
 

This function will be called periodically to get information about the current state of the world.

Parameters:
items holds a list of additional name value pairs. These predicates are collected from MonitorItem objects registered to the MonitorServer. The monitor should transfer them to the client if possible.

Implements oxygen::MonitorSystem.

Definition at line 56 of file monitortest.cpp.

References zeitgeist::Object::GetCore(), and zeitgeist::Object::GetLog().

Here is the call graph for this function:

void MonitorTest::ParseMonitorMessage const std::string &  data  )  [virtual]
 

If a monitor sends information to the world model, this function is called to process it.

Parameters:
data data sent from monitor to monitorsystem via SPADES.

Implements oxygen::MonitorSystem.

Definition at line 50 of file monitortest.cpp.

References zeitgeist::Object::GetLog().

Here is the call graph for this function:


The documentation for this class was generated from the following files:
Generated on Thu Apr 6 15:39:28 2006 for rcssserver3d by  doxygen 1.4.4