shawn::SimulationController Class Reference

Central repository for all simulation-relevant objects. More...

#include <simulation_controller.h>

Inheritance diagram for shawn::SimulationController:

[legend]

Collaboration diagram for shawn::SimulationController:

[legend]

List of all members.

Public Types
typedef std::map< std::string, HandleKeeperBase * >	NamedKeeperMap
Public Member Functions
construction / destruction
	SimulationController ()
virtual	~SimulationController ()
access to default keepers
const SimulationEnvironment &	environment (void) const throw ()
SimulationEnvironment &	environment_w (void) throw ()
const SimulationTaskKeeper &	simulation_task_keeper (void) const throw ()
SimulationTaskKeeper &	simulation_task_keeper_w (void) throw ()
const ProcessorKeeper &	processor_keeper (void) const throw ()
ProcessorKeeper &	processor_keeper_w (void) throw ()
const RandomVariableKeeper &	random_variable_keeper (void) const throw ()
RandomVariableKeeper &	random_variable_keeper_w (void) throw ()
const EdgeModelKeeper &	edge_model_keeper (void) const throw ()
EdgeModelKeeper &	edge_model_keeper_w (void) throw ()
const TransmissionModelKeeper &	transmission_model_keeper (void) const throw ()
TransmissionModelKeeper &	transmission_model_keeper_w (void) throw ()
const CommunicationModelKeeper &	communication_model_keeper (void) const throw ()
CommunicationModelKeeper &	communication_model_keeper_w (void) throw ()
const DistanceEstimateKeeper &	distance_estimate_keeper (void) const throw ()
DistanceEstimateKeeper &	distance_estimate_keeper_w (void) throw ()
const TagFactoryKeeper &	tag_factory_keeper (void) const throw ()
TagFactoryKeeper &	tag_factory_keeper_w (void) throw ()
access to all keepers
Returns: a keeper with the given name and type. if no keeper of matching name exists, or the matching keeper is no T, NULL is returned.
template<typename T>
const T *	keeper_by_name (const std::string &s) const throw ()
template<typename T>
T *	keeper_by_name_w (const std::string &s) throw ()
access to the world
bool	has_world (void) const throw ()
World &	world_w (void) throw ()
const World &	world (void) const throw ()
void	set_world (World *) throw ()
custom keepers
adds a keeper. afterwards, it can be accessed via keeper_by_name() and keeper_by_name_w()
void	add_keeper (HandleKeeperBase *) throw ()
Protected Member Functions
void	init_keepers (void) throw ()
	creates and initializes all default keepers

---

Detailed Description

Central repository for all simulation-relevant objects.

---

Member Typedef Documentation

typedef std::map<std::string,HandleKeeperBase*> shawn::SimulationController::NamedKeeperMap

---

Constructor & Destructor Documentation

shawn::SimulationController::SimulationController

(

)

virtual shawn::SimulationController::~SimulationController

(

)

[virtual]

---

Member Function Documentation

const SimulationEnvironment& shawn::SimulationController::environment

(

void

)

const throw ()

SimulationEnvironment& shawn::SimulationController::environment_w

(

void

)

throw ()

const SimulationTaskKeeper& shawn::SimulationController::simulation_task_keeper

(

void

)

const throw ()

SimulationTaskKeeper& shawn::SimulationController::simulation_task_keeper_w

(

void

)

throw ()

const ProcessorKeeper& shawn::SimulationController::processor_keeper

(

void

)

const throw ()

ProcessorKeeper& shawn::SimulationController::processor_keeper_w

(

void

)

throw ()

const RandomVariableKeeper& shawn::SimulationController::random_variable_keeper

(

void

)

const throw ()

RandomVariableKeeper& shawn::SimulationController::random_variable_keeper_w

(

void

)

throw ()

const EdgeModelKeeper& shawn::SimulationController::edge_model_keeper

(

void

)

const throw ()

EdgeModelKeeper& shawn::SimulationController::edge_model_keeper_w

(

void

)

throw ()

const TransmissionModelKeeper& shawn::SimulationController::transmission_model_keeper

(

void

)

const throw ()

TransmissionModelKeeper& shawn::SimulationController::transmission_model_keeper_w

(

void

)

throw ()

const CommunicationModelKeeper& shawn::SimulationController::communication_model_keeper

(

void

)

const throw ()

CommunicationModelKeeper& shawn::SimulationController::communication_model_keeper_w

(

void

)

throw ()

const DistanceEstimateKeeper& shawn::SimulationController::distance_estimate_keeper

(

void

)

const throw ()

DistanceEstimateKeeper& shawn::SimulationController::distance_estimate_keeper_w

(

void

)

throw ()

const TagFactoryKeeper& shawn::SimulationController::tag_factory_keeper

(

void

)

const throw ()

TagFactoryKeeper& shawn::SimulationController::tag_factory_keeper_w

(

void

)

throw ()

template<typename T>

const T* shawn::SimulationController::keeper_by_name

(

const std::string &

s

)

const throw () [inline]

template<typename T>

T* shawn::SimulationController::keeper_by_name_w

(

const std::string &

s

)

throw () [inline]

Returns:

a keeper with the given name and type. if no keeper of matching name exists, or the matching keeper is no T, NULL is returned.

bool shawn::SimulationController::has_world

(

void

)

const throw ()

World& shawn::SimulationController::world_w

(

void

)

throw ()

Returns:

the world, if has_world()

const World& shawn::SimulationController::world

(

void

)

const throw ()

Returns:

the world, if has_world()

void shawn::SimulationController::set_world

(

World *

)

throw ()

sets the world of the simulation. if there is already a world, it will be deleted.

void shawn::SimulationController::add_keeper

(

HandleKeeperBase *

)

throw ()

void shawn::SimulationController::init_keepers

(

void

)

throw () [protected]

creates and initializes all default keepers

---

The documentation for this class was generated from the following file:

• src/sys/simulation/simulation_controller.h