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

oxygen::MonitorControl Class Reference

#include <monitorcontrol.h>

Inheritance diagram for oxygen::MonitorControl:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MonitorControl ()
virtual ~MonitorControl ()
virtual void StartCycle ()
 forwards all pending messages from all connected monitors to the MonitorServer
virtual void EndCycle ()
 updates all connected monitors at the end of each simulation cycle
virtual void ClientConnect (boost::shared_ptr< Client > client)
 called when a new client connects
int GetMonitorInterval ()
 returns the monitor update interval in cycles
void SetMonitorInterval (int i)
 sets the monitor update interval in cycles

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.

Protected Attributes

boost::shared_ptr< MonitorServermMonitorServer
 cached reference to the MonitorServer
int mMonitorInterval
 the update interval for the connected monitors in cycles

Detailed Description

Definition at line 33 of file monitorcontrol.h.


Constructor & Destructor Documentation

MonitorControl::MonitorControl  ) 
 

Definition at line 33 of file monitorcontrol.cpp.

References oxygen::NetControl::mLocalAddr, and mMonitorInterval.

MonitorControl::~MonitorControl  )  [virtual]
 

Definition at line 39 of file monitorcontrol.cpp.


Member Function Documentation

virtual void oxygen::MonitorControl::ClientConnect boost::shared_ptr< Client >  client  )  [virtual]
 

called when a new client connects

void MonitorControl::EndCycle  )  [virtual]
 

updates all connected monitors at the end of each simulation cycle

Reimplemented from oxygen::NetControl.

Definition at line 78 of file monitorcontrol.cpp.

References oxygen::NetControl::EndCycle(), oxygen::SimControlNode::GetSimulationServer(), oxygen::NetControl::mClients, mMonitorInterval, mMonitorServer, oxygen::NetControl::mNetMessage, and oxygen::NetControl::SendMessage().

Here is the call graph for this function:

int MonitorControl::GetMonitorInterval  ) 
 

returns the monitor update interval in cycles

Definition at line 160 of file monitorcontrol.cpp.

References mMonitorInterval.

void MonitorControl::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 43 of file monitorcontrol.cpp.

References zeitgeist::Object::GetLog(), oxygen::SimControlNode::GetSimulationServer(), mMonitorServer, and zeitgeist::Leaf::OnLink().

Here is the call graph for this function:

void MonitorControl::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 monitorcontrol.cpp.

References mMonitorServer, and zeitgeist::Leaf::OnUnlink().

Here is the call graph for this function:

void MonitorControl::SetMonitorInterval int  i  ) 
 

sets the monitor update interval in cycles

Definition at line 165 of file monitorcontrol.cpp.

References mMonitorInterval.

void MonitorControl::StartCycle  )  [virtual]
 

forwards all pending messages from all connected monitors to the MonitorServer

Reimplemented from oxygen::NetControl.

Definition at line 124 of file monitorcontrol.cpp.

References oxygen::NetControl::mBuffers, mMonitorServer, oxygen::NetControl::mNetMessage, and oxygen::NetControl::StartCycle().

Here is the call graph for this function:


Member Data Documentation

int oxygen::MonitorControl::mMonitorInterval [protected]
 

the update interval for the connected monitors in cycles

Definition at line 65 of file monitorcontrol.h.

Referenced by EndCycle(), GetMonitorInterval(), MonitorControl(), and SetMonitorInterval().

boost::shared_ptr<MonitorServer> oxygen::MonitorControl::mMonitorServer [protected]
 

cached reference to the MonitorServer

Definition at line 62 of file monitorcontrol.h.

Referenced by EndCycle(), OnLink(), OnUnlink(), and StartCycle().


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