YansCoreNS::YansCore Class Reference

The simulator core. More...

List of all members.

Public Member Functions
std::string	GetBasePath (void) const
	Gets the base path that is applied to the relative paths in the configuration file.
RngSeed	GetSeed (void) const
	Gets the seed used to initialize the random number generator.
void	RunSimulation (void)
	Performs the simulation based on the current setup.
void	SetBasePath (std::string const &basePath)
	Assigns a base path to apply to all relative paths in the configuration file.
void	SetSeed (RngSeed rngSeed)
	Initializes the random number generator based on the provided seed.
void	Setup (boost::shared_ptr< std::istream > configuration)
	Parses a configuration and prepares the simulator for running.
	YansCore (void)
	Constructor.
	~YansCore (void)
	Destructor.
Friends
class	ConfigParser

---

Detailed Description

The simulator core.

Responsible for:

• parsing the configuration file,
• loading the modules,
• providing a random number generator for the modules,
• coordinating the simulation

---

Constructor & Destructor Documentation

YansCoreNS::YansCore::YansCore

(

void

)

[explicit]

Constructor.

YansCoreNS::YansCore::~YansCore

(

void

)

Destructor.

---

Member Function Documentation

std::string YansCoreNS::YansCore::GetBasePath

(

void

)

const

Gets the base path that is applied to the relative paths in the configuration file.

Returns:

The path that is applied to the relative paths in the configuratino file.

RngSeed YansCoreNS::YansCore::GetSeed

(

void

)

const

Gets the seed used to initialize the random number generator.

Returns:

The seed used to initialize the random number generator.

void YansCoreNS::YansCore::RunSimulation

(

void

)

Performs the simulation based on the current setup.

void YansCoreNS::YansCore::SetBasePath

(

std::string const &

basePath

)

Assigns a base path to apply to all relative paths in the configuration file.

Parameters:

basePath

The path to ally to the relative paths in the configuration file.

void YansCoreNS::YansCore::SetSeed

(

RngSeed

rngSeed

)

Initializes the random number generator based on the provided seed.

Parameters:

rngSeed

The seed to the random number generator.

void YansCoreNS::YansCore::Setup

(

boost::shared_ptr< std::istream >

configuration

)

Parses a configuration and prepares the simulator for running.

Parameters:

configuration

An input stream containing the configuration.

---

Friends And Related Function Documentation

friend class ConfigParser [friend]