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

oxygen::SimControlNode Class Reference

interface for classes that are registered to the SimulationServer. More...

#include <simcontrolnode.h>

Inheritance diagram for oxygen::SimControlNode:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SimControlNode ()
virtual ~SimControlNode ()
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
virtual void SenseAgent ()
 called each simulation cycle to send agent sensor information
virtual void ActAgent ()
 called each simulation cycle to carry out agent actions
virtual void EndCycle ()
 called when the current simulation cycle ends

Protected Member Functions

boost::shared_ptr< SimulationServerGetSimulationServer ()
 returns a reference to the SimulationServer

Detailed Description

interface for classes that are registered to the SimulationServer.

The interface defines callbacks for the initial startup of the simulation, it's final shutdown and for different phases of each simulation cycle. SimControlNodes are used extend and customize the simulation runloop and to delegate tasks, like network management, reading of mouse and keyboard input, writing a simulation log, rendering etc.

Definition at line 40 of file simcontrolnode.h.


Constructor & Destructor Documentation

SimControlNode::SimControlNode  ) 
 

Definition at line 31 of file simcontrolnode.cpp.

SimControlNode::~SimControlNode  )  [virtual]
 

Definition at line 35 of file simcontrolnode.cpp.


Member Function Documentation

virtual void oxygen::SimControlNode::ActAgent  )  [inline, virtual]
 

called each simulation cycle to carry out agent actions

Definition at line 61 of file simcontrolnode.h.

virtual void oxygen::SimControlNode::DoneSimulation  )  [inline, virtual]
 

called once before the simulation is shut down

Reimplemented in oxygen::NetControl, and SparkMonitorClient.

Definition at line 50 of file simcontrolnode.h.

virtual void oxygen::SimControlNode::EndCycle  )  [inline, virtual]
 

called when the current simulation cycle ends

Reimplemented in kerosin::RenderControl, oxygen::AgentControl, oxygen::MonitorControl, and oxygen::NetControl.

Definition at line 64 of file simcontrolnode.h.

shared_ptr< SimulationServer > SimControlNode::GetSimulationServer  )  [protected]
 

returns a reference to the SimulationServer

Definition at line 39 of file simcontrolnode.cpp.

References zeitgeist::Leaf::GetParent().

Referenced by oxygen::MonitorControl::EndCycle(), kerosin::InputControl::InitSimulation(), oxygen::MonitorControl::OnLink(), oxygen::AgentControl::OnLink(), and kerosin::InputControl::StartCycle().

Here is the call graph for this function:

virtual void oxygen::SimControlNode::InitSimulation  )  [inline, virtual]
 

called once when the simulation is started

Reimplemented in kerosin::InputControl, oxygen::NetControl, and SparkMonitorClient.

Definition at line 47 of file simcontrolnode.h.

virtual void oxygen::SimControlNode::SenseAgent  )  [inline, virtual]
 

called each simulation cycle to send agent sensor information

Definition at line 58 of file simcontrolnode.h.

virtual void oxygen::SimControlNode::StartCycle  )  [inline, virtual]
 

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

Reimplemented in kerosin::InputControl, oxygen::AgentControl, oxygen::MonitorControl, oxygen::NetControl, and SparkMonitorClient.

Definition at line 54 of file simcontrolnode.h.


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