GGSParameters Class Reference

Class for storing parameters. More...

#include <GGSParameters.h>

Inheritance diagram for GGSParameters:

Public Member Functions
	GGSParameters ()
	Default constructor.
	GGSParameters (GGSParameters &&params)
	Move constructor.
template<typename T >
void	SetParam (const std::string &name, T value)
	Sets a parameter. More...
template<class T >
T	GetParam (const std::string &name) const
	Gets a parameter. More...
bool	AreSameParamsAs (const GGSParameters &params) const
	Compares two parameter objects. More...
GGSParameters &	operator= (const GGSParameters &rhs)
	Assignment operator. More...
template<>
void	SetParam (const std::string &name, int value)
template<>
void	SetParam (const std::string &name, double value)
template<>
void	SetParam (const std::string &name, bool value)
template<>
int	GetParam (const std::string &name) const
template<>
double	GetParam (const std::string &name) const
template<>
bool	GetParam (const std::string &name) const

Detailed Description

Class for storing parameters.

This class provides key-value storage for parameters of different types. Currently supported type are:

• int
• double
• bool
• string

and std::vector of the above types.

Definition at line 29 of file GGSParameters.h.

Member Function Documentation

bool GGSParameters::AreSameParamsAs

(

const GGSParameters &

params

)

const

Compares two parameter objects.

This method returns true if the parameters of the argument object are identical in number, names and values to those of this object.

(Note: this method is defined for similarity with GGSTSimInfo::IsSameSimAs, instead of defining GGSParameters::operator= )

Parameters

params

The parameters object to be compared with this.

Returns

true if #params carries the same parameters as this.

Definition at line 133 of file GGSParameters.cpp.

                                                                     {
  if (&params == this)
    return true;
  return ((_intParams == params._intParams) && (_doubleParams == params._doubleParams) &&
          (_stringParams == params._stringParams) && (_boolParams == params._boolParams) &&
          (_vectIntParams == params._vectIntParams) && (_vectDoubleParams == params._vectDoubleParams) &&
          (_vectStringParams == params._vectStringParams) && (_vectBoolParams == params._vectBoolParams));
}

template<class T >

T GGSParameters::GetParam

(

const std::string &

name

)

const

Gets a parameter.

Parameters

name	The name of the desired parameter.

Returns

The value of the desired parameter

Exceptions

std::runtime_error

if the requested parameter does not exist.

GGSParameters & GGSParameters::operator=

(

const GGSParameters &

rhs

)

Assignment operator.

Parameters

rhs	The parameters object to assign from.

Returns

The parameters object after assignment

Definition at line 142 of file GGSParameters.cpp.

                                                                {
  _intParams = rhs._intParams;
  _doubleParams = rhs._doubleParams;
  _stringParams = rhs._stringParams;
  _boolParams = rhs._boolParams;
  _vectIntParams = rhs._vectIntParams;
  _vectDoubleParams = rhs._vectDoubleParams;
  _vectStringParams = rhs._vectStringParams;
  _vectBoolParams = rhs._vectBoolParams;
  return *this;
}

template<typename T >

void GGSParameters::SetParam	(	const std::string &	name,
		T	value
	)

Sets a parameter.

Parameters

name	The name of the parameter.
value	The value of the parameter

Exceptions

std::runtime_error

if the parameter cannot be set.

---

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

• GGSParameters.h
• GGSParameters.cpp