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

SparkMonitorClient Class Reference

#include <sparkmonitorclient.h>

Inheritance diagram for SparkMonitorClient:

Inheritance graph
[legend]
Collaboration diagram for SparkMonitorClient:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SparkMonitorClient ()
virtual ~SparkMonitorClient ()
virtual void InitSimulation ()
 called once when the simulation is started
virtual void DoneSimulation ()
 called once before the simulation is shut down
virtual void StartCycle ()
 called when a new simulation cycle starts, before the simulation is stepped

Protected Member Functions

void ParseMessage (const std::string &msg)
 parses a received message
void ParseCustomPredicates (sexp_t *sexp, oxygen::PredicateList &pList)
void ParseCustomPredicates (sexp_t *sexp)
 parses the given s-expression into a ParameterList and transfers it to a registered user monitor
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.

Protected Attributes

boost::shared_ptr< oxygen::SceneServermSceneServer
 cached reference to the SceneServer
boost::shared_ptr< oxygen::ScenemActiveScene
 cached reference to the current active scene
boost::shared_ptr< oxygen::SceneImportermSceneImporter
 chached reference to the scene importer
boost::shared_ptr< oxygen::BaseNodemManagedScene
 the root node of the managed scene

Detailed Description

Definition at line 33 of file sparkmonitorclient.h.


Constructor & Destructor Documentation

SparkMonitorClient::SparkMonitorClient  ) 
 

Definition at line 36 of file sparkmonitorclient.cpp.

SparkMonitorClient::~SparkMonitorClient  )  [virtual]
 

Definition at line 40 of file sparkmonitorclient.cpp.


Member Function Documentation

void SparkMonitorClient::DoneSimulation  )  [virtual]
 

called once before the simulation is shut down

Reimplemented from oxygen::SimControlNode.

Definition at line 89 of file sparkmonitorclient.cpp.

References oxygen::NetClient::CloseConnection(), mActiveScene, and mSceneImporter.

Here is the call graph for this function:

void SparkMonitorClient::InitSimulation  )  [virtual]
 

called once when the simulation is started

Reimplemented from oxygen::SimControlNode.

Definition at line 67 of file sparkmonitorclient.cpp.

References oxygen::NetClient::Connect(), zeitgeist::Object::GetCore(), zeitgeist::Object::GetLog(), mSceneImporter, and oxygen::NetClient::SendMessage().

Here is the call graph for this function:

void SparkMonitorClient::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 44 of file sparkmonitorclient.cpp.

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

Here is the call graph for this function:

void SparkMonitorClient::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 57 of file sparkmonitorclient.cpp.

References mManagedScene, and mSceneServer.

void SparkMonitorClient::ParseCustomPredicates sexp_t *  sexp  )  [protected]
 

parses the given s-expression into a ParameterList and transfers it to a registered user monitor

Definition at line 132 of file sparkmonitorclient.cpp.

References ParseCustomPredicates().

Here is the call graph for this function:

void SparkMonitorClient::ParseCustomPredicates sexp_t *  sexp,
oxygen::PredicateList pList
[protected]
 

Definition at line 107 of file sparkmonitorclient.cpp.

References oxygen::PredicateList::AddPredicate(), zeitgeist::ParameterList::AddValue(), oxygen::Predicate::name, and oxygen::Predicate::parameter.

Referenced by ParseCustomPredicates().

Here is the call graph for this function:

void SparkMonitorClient::ParseMessage const std::string &  msg  )  [protected]
 

parses a received message

Reimplemented from oxygen::NetClient.

Referenced by StartCycle().

void SparkMonitorClient::StartCycle  )  [virtual]
 

called when a new simulation cycle starts, before the simulation is stepped

Reimplemented from oxygen::SimControlNode.

Definition at line 96 of file sparkmonitorclient.cpp.

References oxygen::NetClient::mNetBuffer, oxygen::NetClient::mNetMessage, ParseMessage(), and oxygen::NetClient::ReadFragments().

Here is the call graph for this function:


Member Data Documentation

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

cached reference to the current active scene

Definition at line 68 of file sparkmonitorclient.h.

Referenced by DoneSimulation().

boost::shared_ptr<oxygen::BaseNode> SparkMonitorClient::mManagedScene [protected]
 

the root node of the managed scene

Definition at line 74 of file sparkmonitorclient.h.

Referenced by OnUnlink().

boost::shared_ptr<oxygen::SceneImporter> SparkMonitorClient::mSceneImporter [protected]
 

chached reference to the scene importer

Definition at line 71 of file sparkmonitorclient.h.

Referenced by DoneSimulation(), and InitSimulation().

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

cached reference to the SceneServer

Definition at line 65 of file sparkmonitorclient.h.

Referenced by OnLink(), and OnUnlink().


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