mygsl::parameter_store::parameter_record Struct Reference

Parameter record. More...

#include <bayeux/mygsl/parameter_store.h>

Public Member Functions
	parameter_record ()
	Default constructor. More...
	parameter_record (parameter_store &)
	Constructor. More...
void	set_parent (parameter_store &)
	Set parent store. More...
void	set_index (int index_)
	Set the parameter index. More...
int	get_index () const
	Return the parameter index. More...
void	set_name (const std::string &name_)
	Set the parameter name. More...
const std::string &	get_name () const
	Return the parameter name. More...
void	set_type (datatools::basic_type)
	Set the parameter type. More...
datatools::basic_type	get_type () const
	Return the parameter type. More...
bool	is_boolean () const
	Check if the parameter is boolean. More...
bool	is_integer () const
	Check if the parameter is integer. More...
bool	is_real () const
	Check if the parameter is real. More...
bool	is_string () const
	Check if the parameter is string. More...
void	set_description (const std::string &description_)
	Set the parameter description. More...
const std::string &	get_description () const
	Return the parameter description. More...
void	reset ()
	Reset. More...
bool	is_value_set () const
	Value is set. More...
void	set_boolean_value (bool, bool update_=true)
void	set_integer_value (int, bool update_=true)
void	set_real_value (double, bool update_=true)
void	set_string_value (const std::string &, bool update_=true)
void	unset_value (bool update_=true)
bool	to_boolean () const
int	to_integer () const
double	to_real () const
const std::string &	to_string () const

Friends
class	parameter_store

Detailed Description

Parameter record.

Constructor & Destructor Documentation

parameter_record() [1/2]

mygsl::parameter_store::parameter_record::parameter_record

(

)

Default constructor.

parameter_record() [2/2]

mygsl::parameter_store::parameter_record::parameter_record

(

parameter_store &

)

Constructor.

Member Function Documentation

get_description()

const std::string& mygsl::parameter_store::parameter_record::get_description

(

)

const

Return the parameter description.

get_index()

int mygsl::parameter_store::parameter_record::get_index

(

)

const

Return the parameter index.

get_name()

const std::string& mygsl::parameter_store::parameter_record::get_name

(

)

const

Return the parameter name.

get_type()

datatools::basic_type mygsl::parameter_store::parameter_record::get_type

(

)

const

Return the parameter type.

is_boolean()

bool mygsl::parameter_store::parameter_record::is_boolean

(

)

const

Check if the parameter is boolean.

is_integer()

bool mygsl::parameter_store::parameter_record::is_integer

(

)

const

Check if the parameter is integer.

is_real()

bool mygsl::parameter_store::parameter_record::is_real

(

)

const

Check if the parameter is real.

is_string()

bool mygsl::parameter_store::parameter_record::is_string

(

)

const

Check if the parameter is string.

is_value_set()

bool mygsl::parameter_store::parameter_record::is_value_set

(

)

const

Value is set.

reset()

void mygsl::parameter_store::parameter_record::reset

(

)

Reset.

set_boolean_value()

void mygsl::parameter_store::parameter_record::set_boolean_value	(	bool	,
		bool	update_ = true
	)

set_description()

void mygsl::parameter_store::parameter_record::set_description

(

const std::string &

description_

)

Set the parameter description.

set_index()

void mygsl::parameter_store::parameter_record::set_index

(

int

index_

)

Set the parameter index.

set_integer_value()

void mygsl::parameter_store::parameter_record::set_integer_value	(	int	,
		bool	update_ = true
	)

set_name()

void mygsl::parameter_store::parameter_record::set_name

(

const std::string &

name_

)

Set the parameter name.

set_parent()

void mygsl::parameter_store::parameter_record::set_parent

(

parameter_store &

)

Set parent store.

set_real_value()

void mygsl::parameter_store::parameter_record::set_real_value	(	double	,
		bool	update_ = true
	)

set_string_value()

void mygsl::parameter_store::parameter_record::set_string_value	(	const std::string &	,
		bool	update_ = true
	)

set_type()

void mygsl::parameter_store::parameter_record::set_type

(

datatools::basic_type

)

Set the parameter type.

to_boolean()

bool mygsl::parameter_store::parameter_record::to_boolean

(

)

const

to_integer()

int mygsl::parameter_store::parameter_record::to_integer

(

)

const

to_real()

double mygsl::parameter_store::parameter_record::to_real

(

)

const

to_string()

const std::string& mygsl::parameter_store::parameter_record::to_string

(

)

const

unset_value()

void mygsl::parameter_store::parameter_record::unset_value

(

bool

update_ = true

)

Friends And Related Function Documentation

parameter_store

friend class parameter_store

friend

---

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

• bayeux/mygsl/parameter_store.h