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

oxygen::MonitorServer Class Reference

#include <monitorserver.h>

Inheritance diagram for oxygen::MonitorServer:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MonitorServer ()
virtual ~MonitorServer ()
bool RegisterMonitorSystem (const std::string &monitorSysName)
 This function creates an instance of class 'monitorSysName' and adds it as a child node below this server.
bool RegisterMonitorItem (const std::string &monitorItemName)
 This function creates an instance of class 'monitorItem' and adds it as a child node below this server.
std::string GetMonitorHeaderInfo ()
 This function is called once for every monitor.
std::string GetMonitorInfo ()
 This function will be called periodically to get information about the current state of the world.
void ParseMonitorMessage (const std::string &data)
 If a monitor sends information to the world model, this function is called to process it.

Protected Member Functions

boost::shared_ptr< MonitorSystemGetMonitorSystem ()
 returns a shared_ptr to the first registered MonitorSystem
void CollectItemPredicates (bool initial, PredicateList &pList)
 collects a list of predicates from all registered MonitorItems

Detailed Description

Definition at line 32 of file monitorserver.h.


Constructor & Destructor Documentation

MonitorServer::MonitorServer  ) 
 

Definition at line 31 of file monitorserver.cpp.

MonitorServer::~MonitorServer  )  [virtual]
 

Definition at line 35 of file monitorserver.cpp.


Member Function Documentation

void MonitorServer::CollectItemPredicates bool  initial,
PredicateList pList
[protected]
 

collects a list of predicates from all registered MonitorItems

Definition at line 124 of file monitorserver.cpp.

Referenced by GetMonitorHeaderInfo(), and GetMonitorInfo().

string MonitorServer::GetMonitorHeaderInfo  ) 
 

This function is called once for every monitor.

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

Definition at line 148 of file monitorserver.cpp.

References CollectItemPredicates(), zeitgeist::Object::GetLog(), and GetMonitorSystem().

Here is the call graph for this function:

string MonitorServer::GetMonitorInfo  ) 
 

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

The format is completely determined by what the monitors will expect; no processing is done by the simulation engine

Definition at line 164 of file monitorserver.cpp.

References CollectItemPredicates(), and GetMonitorSystem().

Here is the call graph for this function:

boost::shared_ptr< MonitorSystem > MonitorServer::GetMonitorSystem  )  [protected]
 

returns a shared_ptr to the first registered MonitorSystem

Definition at line 115 of file monitorserver.cpp.

Referenced by GetMonitorHeaderInfo(), and GetMonitorInfo().

void oxygen::MonitorServer::ParseMonitorMessage const std::string &  data  ) 
 

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

bool MonitorServer::RegisterMonitorItem const std::string &  monitorItemName  ) 
 

This function creates an instance of class 'monitorItem' and adds it as a child node below this server.

Definition at line 78 of file monitorserver.cpp.

References zeitgeist::Node::AddChildReference(), zeitgeist::Node::GetChildOfClass(), zeitgeist::Object::GetCore(), and zeitgeist::Object::GetLog().

Here is the call graph for this function:

bool MonitorServer::RegisterMonitorSystem const std::string &  monitorSysName  ) 
 

This function creates an instance of class 'monitorSysName' and adds it as a child node below this server.

Definition at line 40 of file monitorserver.cpp.

References zeitgeist::Node::AddChildReference(), zeitgeist::Node::GetChildOfClass(), zeitgeist::Object::GetCore(), and 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:44:49 2006 for rcssserver3d by  doxygen 1.4.4