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

oxygen::MonitorSystem Class Reference

#include <monitorsystem.h>

Inheritance diagram for oxygen::MonitorSystem:

Inheritance graph
[legend]
Collaboration diagram for oxygen::MonitorSystem:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Detailed Description

Definition at line 32 of file monitorsystem.h.


Constructor & Destructor Documentation

MonitorSystem::MonitorSystem  ) 
 

Definition at line 26 of file monitorsystem.cpp.

MonitorSystem::~MonitorSystem  )  [virtual]
 

Definition at line 30 of file monitorsystem.cpp.


Member Function Documentation

virtual std::string oxygen::MonitorSystem::GetMonitorHeaderInfo const PredicateList pList  )  [pure 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.

Implemented in MonitorTest, SexpMonitor, and SparkMonitor.

virtual std::string oxygen::MonitorSystem::GetMonitorInfo const PredicateList pList  )  [pure 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.

Implemented in MonitorTest, SexpMonitor, and SparkMonitor.

virtual void oxygen::MonitorSystem::ParseMonitorMessage const std::string &   )  [pure virtual]
 

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

Implemented in MonitorTest, SexpMonitor, and SparkMonitor.


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