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

SparkMonitor Class Reference

#include <sparkmonitor.h>

Inheritance diagram for SparkMonitor:

Inheritance graph
[legend]
Collaboration diagram for SparkMonitor:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SparkMonitor ()
virtual ~SparkMonitor ()
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 void OnLink ()
 This method is called, when the hierarchy object has been linked to a parent.
virtual void OnUnlink ()
 This rountine is called, before the hierarchy object is removed from the parent.
void DescribeCustomPredicates (std::stringstream &ss, const oxygen::PredicateList &pList)
void DescribeActiveScene (std::stringstream &ss)
void DescribeScene (std::stringstream &ss, boost::shared_ptr< oxygen::BaseNode > node)
void DescribeNode (std::stringstream &ss, boost::shared_ptr< oxygen::BaseNode > node)
void DescribeTransform (std::stringstream &ss, boost::shared_ptr< oxygen::Transform > transform)
void DescribeMesh (std::stringstream &ss, boost::shared_ptr< kerosin::StaticMesh > mesh)
void DescribeLight (std::stringstream &ss, boost::shared_ptr< kerosin::Light > light)

Protected Attributes

boost::shared_ptr< oxygen::SceneServermSceneServer
 cached reference to the SceneServer
boost::shared_ptr< oxygen::ScenemActiveScene
 cached reference to the current active scene
bool mFullState
 true, if the full state is generated

Detailed Description

Definition at line 33 of file sparkmonitor.h.


Constructor & Destructor Documentation

SparkMonitor::SparkMonitor  ) 
 

Definition at line 37 of file sparkmonitor.cpp.

References mFullState.

SparkMonitor::~SparkMonitor  )  [virtual]
 

Definition at line 42 of file sparkmonitor.cpp.


Member Function Documentation

void SparkMonitor::DescribeActiveScene std::stringstream &  ss  )  [protected]
 

Referenced by GetMonitorHeaderInfo(), and GetMonitorInfo().

void SparkMonitor::DescribeCustomPredicates std::stringstream &  ss,
const oxygen::PredicateList pList
[protected]
 

Referenced by GetMonitorHeaderInfo(), and GetMonitorInfo().

void SparkMonitor::DescribeLight std::stringstream &  ss,
boost::shared_ptr< kerosin::Light light
[protected]
 

void SparkMonitor::DescribeMesh std::stringstream &  ss,
boost::shared_ptr< kerosin::StaticMesh mesh
[protected]
 

void SparkMonitor::DescribeNode std::stringstream &  ss,
boost::shared_ptr< oxygen::BaseNode node
[protected]
 

void SparkMonitor::DescribeScene std::stringstream &  ss,
boost::shared_ptr< oxygen::BaseNode node
[protected]
 

void SparkMonitor::DescribeTransform std::stringstream &  ss,
boost::shared_ptr< oxygen::Transform transform
[protected]
 

string SparkMonitor::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 91 of file sparkmonitor.cpp.

References DescribeActiveScene(), DescribeCustomPredicates(), and mFullState.

Here is the call graph for this function:

string SparkMonitor::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 82 of file sparkmonitor.cpp.

References DescribeActiveScene(), DescribeCustomPredicates(), and mFullState.

Here is the call graph for this function:

void SparkMonitor::OnLink  )  [protected, virtual]
 

This method is called, when the hierarchy object has been linked to a parent.

At that point, traversal can commence. It can be overridden to support custom 'link' behavior.

Reimplemented from zeitgeist::Leaf.

Definition at line 46 of file sparkmonitor.cpp.

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

Here is the call graph for this function:

void SparkMonitor::OnUnlink  )  [protected, virtual]
 

This rountine is called, before the hierarchy object is removed from the parent.

It can be overridden to support custom 'unlink' behavior.

Reimplemented from zeitgeist::Leaf.

Definition at line 59 of file sparkmonitor.cpp.

References mActiveScene, and mSceneServer.

void SparkMonitor::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 65 of file sparkmonitor.cpp.


Member Data Documentation

boost::shared_ptr<oxygen::Scene> SparkMonitor::mActiveScene [protected]
 

cached reference to the current active scene

Definition at line 87 of file sparkmonitor.h.

Referenced by OnUnlink().

bool SparkMonitor::mFullState [protected]
 

true, if the full state is generated

Definition at line 90 of file sparkmonitor.h.

Referenced by GetMonitorHeaderInfo(), GetMonitorInfo(), and SparkMonitor().

boost::shared_ptr<oxygen::SceneServer> SparkMonitor::mSceneServer [protected]
 

cached reference to the SceneServer

Definition at line 84 of file sparkmonitor.h.

Referenced by OnLink(), and OnUnlink().


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