Simulators::Configuration Class Reference

#include <Configuration.h>

Collaboration diagram for Simulators::Configuration:

Public Member Functions
	Configuration ()=default
	The constructor.
	Configuration (Configuration &&)=default
	The move constructor.
	Configuration (const Configuration &)=default
	The copy constructor.
virtual	~Configuration ()=default
	The destructor.
void	ApplyConfigurationFromMap (const std::unordered_map< std::string, std::string > &config)
void	ApplyConfigurationFromSimulator (const std::shared_ptr< Simulators::IState > &simulator)
void	ApplyConfigurationToSimulator (const std::shared_ptr< Simulators::IState > &simulator) const
const std::unordered_map< std::string, std::string > &	GetConfigMap () const
std::string	GetConfiguration (const std::string &key) const
	Get a configuration value.
double	GetConfigurationAsDouble (const std::string &key) const
long long int	GetConfigurationAsInt (const std::string &key) const
unsigned long long int	GetConfigurationAsUnsigned (const std::string &key) const
bool	IsSet (const std::string &key) const
	Check if a configuration value is set.
Configuration &	operator= (Configuration &&)=default
	The move assignment operator.
Configuration &	operator= (const Configuration &)=default
	The copy assignment operator.
void	SetConfiguration (const std::string &key, const std::string &value)
void	SetConfiguration (const std::string &key, double value)
void	SetConfiguration (const std::string &key, long long int value)
bool	WasApplied (const std::string &key, const std::string &value) const

Static Public Member Functions
static bool	CanBeAppliedOnInitializedSimulator (const std::string &key)
static std::string	GpuSvdSettingGroup (const std::string &key)
static bool	IgnoredSetting (const std::string &key)
static int	ParseGpuDevice (const std::string &value)
	Set a configuration value.
static bool	ParseGpuSvdFlag (const std::string &value)

Detailed Description

Definition at line 27 of file Simulators/Configuration.h.

Constructor & Destructor Documentation

Configuration() [1/3]

Simulators::Configuration::Configuration ( )

default

The constructor.

The constructor for the simulator configuration.

Referenced by Configuration(), Configuration(), operator=(), and operator=().

~Configuration()

virtual Simulators::Configuration::~Configuration ( )

virtualdefault

The destructor.

The destructor for the simulator configuration.

Configuration() [2/3]

Simulators::Configuration::Configuration ( const Configuration & )

default

The copy constructor.

The copy constructor for the simulator configuration.

References Configuration().

Configuration() [3/3]

Simulators::Configuration::Configuration ( Configuration && )

default

The move constructor.

The move constructor for the simulator configuration.

References Configuration().

Member Function Documentation

ApplyConfigurationFromMap()

void Simulators::Configuration::ApplyConfigurationFromMap ( const std::unordered_map< std::string, std::string > & config )

inline

Definition at line 231 of file Simulators/Configuration.h.

References SetConfiguration().

Referenced by ApplyConfigurationFromSimulator().

ApplyConfigurationFromSimulator()

void Simulators::Configuration::ApplyConfigurationFromSimulator ( const std::shared_ptr< Simulators::IState > & simulator )

inline

Definition at line 226 of file Simulators/Configuration.h.

References ApplyConfigurationFromMap().

ApplyConfigurationToSimulator()

void Simulators::Configuration::ApplyConfigurationToSimulator ( const std::shared_ptr< Simulators::IState > & simulator ) const

inline

Definition at line 221 of file Simulators/Configuration.h.

CanBeAppliedOnInitializedSimulator()

bool Simulators::Configuration::CanBeAppliedOnInitializedSimulator ( const std::string & key )

inlinestatic

Definition at line 204 of file Simulators/Configuration.h.

GetConfigMap()

const std::unordered_map< std::string, std::string > & Simulators::Configuration::GetConfigMap ( ) const

inline

Definition at line 235 of file Simulators/Configuration.h.

GetConfiguration()

std::string Simulators::Configuration::GetConfiguration ( const std::string & key ) const

inline

Get a configuration value.

Get a configuration value for the simulator.

Parameters

key	The key of the configuration value.

Returns

The configuration value as a string.

Definition at line 169 of file Simulators/Configuration.h.

GetConfigurationAsDouble()

double Simulators::Configuration::GetConfigurationAsDouble ( const std::string & key ) const

inline

Definition at line 196 of file Simulators/Configuration.h.

GetConfigurationAsInt()

long long int Simulators::Configuration::GetConfigurationAsInt ( const std::string & key ) const

inline

Definition at line 177 of file Simulators/Configuration.h.

GetConfigurationAsUnsigned()

unsigned long long int Simulators::Configuration::GetConfigurationAsUnsigned ( const std::string & key ) const

inline

Definition at line 187 of file Simulators/Configuration.h.

GpuSvdSettingGroup()

std::string Simulators::Configuration::GpuSvdSettingGroup ( const std::string & key )

inlinestatic

Definition at line 89 of file Simulators/Configuration.h.

Referenced by Network::SimpleDisconnectedNetwork< Time, Controller >::Configure(), and SetConfiguration().

IgnoredSetting()

bool Simulators::Configuration::IgnoredSetting ( const std::string & key )

inlinestatic

Definition at line 214 of file Simulators/Configuration.h.

Referenced by SetConfiguration(), SetConfiguration(), and SetConfiguration().

IsSet()

bool Simulators::Configuration::IsSet ( const std::string & key ) const

inline

Check if a configuration value is set.

Check if a configuration value is set for the simulator.

Parameters

key	The key of the configuration value.

Returns

True if the configuration value is set, false otherwise.

Definition at line 157 of file Simulators/Configuration.h.

operator=() [1/2]

Configuration & Simulators::Configuration::operator= ( Configuration && )

default

The move assignment operator.

The move assignment operator for the simulator configuration.

References Configuration().

operator=() [2/2]

Configuration & Simulators::Configuration::operator= ( const Configuration & )

default

The copy assignment operator.

The copy assignment operator for the simulator configuration.

References Configuration().

ParseGpuDevice()

int Simulators::Configuration::ParseGpuDevice ( const std::string & value )

inlinestatic

Set a configuration value.

Set a configuration value for the simulator.

Parameters

key	The key of the configuration value.
value	The value of the configuration.

Definition at line 79 of file Simulators/Configuration.h.

Referenced by Network::SimpleDisconnectedNetwork< Time, Controller >::ChooseBestSimulator(), Network::SimpleDisconnectedNetwork< Time, Controller >::Configure(), SetConfiguration(), SimpleEstimate(), and SimpleExecute().

ParseGpuSvdFlag()

bool Simulators::Configuration::ParseGpuSvdFlag ( const std::string & value )

inlinestatic

Definition at line 102 of file Simulators/Configuration.h.

Referenced by SetConfiguration().

SetConfiguration() [1/3]

void Simulators::Configuration::SetConfiguration ( const std::string & key, const std::string & value )

inline

Definition at line 108 of file Simulators/Configuration.h.

References GpuSvdSettingGroup(), IgnoredSetting(), ParseGpuDevice(), and ParseGpuSvdFlag().

Referenced by ApplyConfigurationFromMap(), SetConfiguration(), and SetConfiguration().

SetConfiguration() [2/3]

void Simulators::Configuration::SetConfiguration ( const std::string & key, double value )

inline

Definition at line 143 of file Simulators/Configuration.h.

References IgnoredSetting(), and SetConfiguration().

SetConfiguration() [3/3]

void Simulators::Configuration::SetConfiguration ( const std::string & key, long long int value )

inline

Definition at line 137 of file Simulators/Configuration.h.

References IgnoredSetting(), and SetConfiguration().

WasApplied()

bool Simulators::Configuration::WasApplied ( const std::string & key, const std::string & value ) const

inline

Definition at line 239 of file Simulators/Configuration.h.

---

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

• Simulators/Configuration.h