datatools::configuration_property_description Class Reference

An object that describes the way an objet of a given class can be configured from properties. More...

#include <bayeux/datatools/object_configuration_description.h>

Classes
struct	dependency_entry
	Description of a dependency. More...

Public Types
enum	dependency_type { DEP_UNDEFINED = 0, DEP_DYNAMIC = 1, DEP_BY_FLAG = 2, DEP_BY_LABEL = 3 }
	Dependency type. More...

Public Member Functions
	configuration_property_description ()
	Default constructor. More...
configuration_property_description &	set_name_pattern (const std::string &np_)
configuration_property_description &	set_from (const std::string &from_)
configuration_property_description &	set_group (const std::string &group_)
configuration_property_description &	set_terse_description (const std::string &desc_)
configuration_property_description &	set_long_description (const std::string &desc_)
configuration_property_description &	set_mandatory (bool m_=true)
configuration_property_description &	set_traits (int type_, bool array_=false, int fixed_size_=-1)
configuration_property_description &	set_triggered_by_flag (const std::string &prop_name_, bool triggering_status_=true)
configuration_property_description &	set_triggered_by_label (const std::string &prop_name_, const std::string &labels_)
configuration_property_description &	set_complex_triggering_conditions (bool=true)
configuration_property_description &	set_complex_dependencies (bool=true)
configuration_property_description &	set_explicit_unit (bool=true)
configuration_property_description &	set_unit_symbol (const std::string &)
configuration_property_description &	set_unit_label (const std::string &)
configuration_property_description &	set_const (bool=true)
configuration_property_description &	set_path (bool=true)
configuration_property_description &	set_section (const std::string &section_name_)
configuration_property_description &	set_default_value_boolean (bool)
configuration_property_description &	set_default_value_integer (int)
configuration_property_description &	set_default_value_real (double, const std::string &unit_symbol_="")
configuration_property_description &	set_default_value_string (const std::string &)
configuration_property_description &	set_default_array_size (int)
configuration_property_description &	add_example (const std::string &example_)
configuration_property_description &	set_deprecated (bool, const std::string &info_="")
bool	is_deprecated () const
const std::string &	get_deprecated_info () const
bool	is_valid () const
bool	has_type () const
bool	has_section () const
const std::string &	get_section () const
bool	is_const () const
bool	is_mutable () const
bool	has_single_type () const
bool	is_boolean () const
bool	is_integer () const
bool	is_real () const
bool	is_string () const
bool	is_path () const
bool	is_static () const
bool	is_dynamic () const
bool	is_trigger () const
bool	is_triggered_by_flag () const
bool	is_triggered_by_label () const
const std::string &	get_name_pattern () const
const std::string &	get_from () const
const std::string &	get_group () const
bool	has_terse_description () const
const std::string &	get_terse_description () const
bool	has_long_description () const
const std::string &	get_long_description () const
unsigned int	get_number_of_examples () const
const std::string &	get_example (int) const
bool	has_default_value () const
bool	get_default_value_boolean () const
int	get_default_value_integer () const
double	get_default_value_real () const
const std::string &	get_default_value_real_unit () const
const std::string &	get_default_value_string () const
bool	has_default_array_size () const
int	get_default_array_size () const
bool	is_mandatory () const
int	get_type () const
bool	is_scalar () const
bool	is_array () const
bool	has_explicit_unit () const
bool	has_unit_label () const
const std::string &	get_unit_label () const
bool	has_unit_symbol () const
const std::string &	get_unit_symbol () const
bool	is_fixed_sized_array () const
int	get_array_fixed_size () const
void	print (std::ostream &out_, const std::string &indent_="") const
bool	has_complex_triggering_conditions () const
bool	has_complex_dependencies () const
const dependency_entry &	get_triggered_by_label () const
const dependency_entry &	get_triggered_by_flag () const
const dependency_entry &	get_dynamic_dependee () const
bool	has_dynamic_dependers () const
unsigned int	get_number_of_dynamic_dependers () const
const dependency_entry &	get_dynamic_depender (int i_) const
unsigned int	get_number_of_triggered_dependers () const
const dependency_entry &	get_triggered_depender (int i_) const
void	dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="") const
	Raw print. More...

Static Public Attributes
static const bool	SCALAR = false
static const bool	ARRAY = true
static const bool	IMPLICIT_UNIT = false
static const bool	EXPLICIT_UNIT = true
static const bool	MUTABLE = false
static const bool	CONST = true

Friends
class	object_configuration_description

Detailed Description

An object that describes the way an objet of a given class can be configured from properties.

Member Enumeration Documentation

dependency_type

enum datatools::configuration_property_description::dependency_type

Dependency type.

Enumerator
DEP_UNDEFINED	undefined dependency
DEP_DYNAMIC	Dynamic dependency from another property of which the name is used to build the property's name.
DEP_BY_FLAG	Dependency from a boolean property (flag) with a specific value (true or false)
DEP_BY_LABEL	Dependency from a string property (label) with a specific value.

Constructor & Destructor Documentation

configuration_property_description()

datatools::configuration_property_description::configuration_property_description

(

)

Default constructor.

Member Function Documentation

add_example()

configuration_property_description& datatools::configuration_property_description::add_example

(

const std::string &

example_

)

dump()

void datatools::configuration_property_description::dump	(	std::ostream &	out_ = std::clog,
		const std::string &	title_ = "",
		const std::string &	indent_ = ""
	)		const

Raw print.

get_array_fixed_size()

int datatools::configuration_property_description::get_array_fixed_size

(

)

const

get_default_array_size()

int datatools::configuration_property_description::get_default_array_size

(

)

const

get_default_value_boolean()

bool datatools::configuration_property_description::get_default_value_boolean

(

)

const

get_default_value_integer()

int datatools::configuration_property_description::get_default_value_integer

(

)

const

get_default_value_real()

double datatools::configuration_property_description::get_default_value_real

(

)

const

get_default_value_real_unit()

const std::string& datatools::configuration_property_description::get_default_value_real_unit

(

)

const

get_default_value_string()

const std::string& datatools::configuration_property_description::get_default_value_string

(

)

const

get_deprecated_info()

const std::string& datatools::configuration_property_description::get_deprecated_info

(

)

const

get_dynamic_dependee()

const dependency_entry& datatools::configuration_property_description::get_dynamic_dependee

(

)

const

get_dynamic_depender()

const dependency_entry& datatools::configuration_property_description::get_dynamic_depender

(

int

i_

)

const

get_example()

const std::string& datatools::configuration_property_description::get_example

(

int

)

const

get_from()

const std::string& datatools::configuration_property_description::get_from

(

)

const

get_group()

const std::string& datatools::configuration_property_description::get_group

(

)

const

get_long_description()

const std::string& datatools::configuration_property_description::get_long_description

(

)

const

get_name_pattern()

const std::string& datatools::configuration_property_description::get_name_pattern

(

)

const

get_number_of_dynamic_dependers()

unsigned int datatools::configuration_property_description::get_number_of_dynamic_dependers

(

)

const

get_number_of_examples()

unsigned int datatools::configuration_property_description::get_number_of_examples

(

)

const

get_number_of_triggered_dependers()

unsigned int datatools::configuration_property_description::get_number_of_triggered_dependers

(

)

const

get_section()

const std::string& datatools::configuration_property_description::get_section

(

)

const

get_terse_description()

const std::string& datatools::configuration_property_description::get_terse_description

(

)

const

get_triggered_by_flag()

const dependency_entry& datatools::configuration_property_description::get_triggered_by_flag

(

)

const

get_triggered_by_label()

const dependency_entry& datatools::configuration_property_description::get_triggered_by_label

(

)

const

get_triggered_depender()

const dependency_entry& datatools::configuration_property_description::get_triggered_depender

(

int

i_

)

const

get_type()

int datatools::configuration_property_description::get_type

(

)

const

get_unit_label()

const std::string& datatools::configuration_property_description::get_unit_label

(

)

const

get_unit_symbol()

const std::string& datatools::configuration_property_description::get_unit_symbol

(

)

const

has_complex_dependencies()

bool datatools::configuration_property_description::has_complex_dependencies

(

)

const

has_complex_triggering_conditions()

bool datatools::configuration_property_description::has_complex_triggering_conditions

(

)

const

has_default_array_size()

bool datatools::configuration_property_description::has_default_array_size

(

)

const

has_default_value()

bool datatools::configuration_property_description::has_default_value

(

)

const

has_dynamic_dependers()

bool datatools::configuration_property_description::has_dynamic_dependers

(

)

const

has_explicit_unit()

bool datatools::configuration_property_description::has_explicit_unit

(

)

const

has_long_description()

bool datatools::configuration_property_description::has_long_description

(

)

const

has_section()

bool datatools::configuration_property_description::has_section

(

)

const

has_single_type()

bool datatools::configuration_property_description::has_single_type

(

)

const

has_terse_description()

bool datatools::configuration_property_description::has_terse_description

(

)

const

has_type()

bool datatools::configuration_property_description::has_type

(

)

const

has_unit_label()

bool datatools::configuration_property_description::has_unit_label

(

)

const

has_unit_symbol()

bool datatools::configuration_property_description::has_unit_symbol

(

)

const

is_array()

bool datatools::configuration_property_description::is_array

(

)

const

is_boolean()

bool datatools::configuration_property_description::is_boolean

(

)

const

is_const()

bool datatools::configuration_property_description::is_const

(

)

const

is_deprecated()

bool datatools::configuration_property_description::is_deprecated

(

)

const

is_dynamic()

bool datatools::configuration_property_description::is_dynamic

(

)

const

is_fixed_sized_array()

bool datatools::configuration_property_description::is_fixed_sized_array

(

)

const

is_integer()

bool datatools::configuration_property_description::is_integer

(

)

const

is_mandatory()

bool datatools::configuration_property_description::is_mandatory

(

)

const

is_mutable()

bool datatools::configuration_property_description::is_mutable

(

)

const

is_path()

bool datatools::configuration_property_description::is_path

(

)

const

is_real()

bool datatools::configuration_property_description::is_real

(

)

const

is_scalar()

bool datatools::configuration_property_description::is_scalar

(

)

const

is_static()

bool datatools::configuration_property_description::is_static

(

)

const

is_string()

bool datatools::configuration_property_description::is_string

(

)

const

is_trigger()

bool datatools::configuration_property_description::is_trigger

(

)

const

is_triggered_by_flag()

bool datatools::configuration_property_description::is_triggered_by_flag

(

)

const

is_triggered_by_label()

bool datatools::configuration_property_description::is_triggered_by_label

(

)

const

is_valid()

bool datatools::configuration_property_description::is_valid

(

)

const

print()

void datatools::configuration_property_description::print	(	std::ostream &	out_,
		const std::string &	indent_ = ""
	)		const

set_complex_dependencies()

configuration_property_description& datatools::configuration_property_description::set_complex_dependencies

(

bool

= true

)

set_complex_triggering_conditions()

configuration_property_description& datatools::configuration_property_description::set_complex_triggering_conditions

(

bool

= true

)

set_const()

configuration_property_description& datatools::configuration_property_description::set_const

(

bool

= true

)

set_default_array_size()

configuration_property_description& datatools::configuration_property_description::set_default_array_size

(

int

)

set_default_value_boolean()

configuration_property_description& datatools::configuration_property_description::set_default_value_boolean

(

bool

)

set_default_value_integer()

configuration_property_description& datatools::configuration_property_description::set_default_value_integer

(

int

)

set_default_value_real()

configuration_property_description& datatools::configuration_property_description::set_default_value_real	(	double	,
		const std::string &	unit_symbol_ = ""
	)

set_default_value_string()

configuration_property_description& datatools::configuration_property_description::set_default_value_string

(

const std::string &

)

set_deprecated()

configuration_property_description& datatools::configuration_property_description::set_deprecated	(	bool	,
		const std::string &	info_ = ""
	)

set_explicit_unit()

configuration_property_description& datatools::configuration_property_description::set_explicit_unit

(

bool

= true

)

set_from()

configuration_property_description& datatools::configuration_property_description::set_from

(

const std::string &

from_

)

set_group()

configuration_property_description& datatools::configuration_property_description::set_group

(

const std::string &

group_

)

set_long_description()

configuration_property_description& datatools::configuration_property_description::set_long_description

(

const std::string &

desc_

)

set_mandatory()

configuration_property_description& datatools::configuration_property_description::set_mandatory

(

bool

m_ = true

)

set_name_pattern()

configuration_property_description& datatools::configuration_property_description::set_name_pattern

(

const std::string &

np_

)

set_path()

configuration_property_description& datatools::configuration_property_description::set_path

(

bool

= true

)

set_section()

configuration_property_description& datatools::configuration_property_description::set_section

(

const std::string &

section_name_

)

set_terse_description()

configuration_property_description& datatools::configuration_property_description::set_terse_description

(

const std::string &

desc_

)

set_traits()

configuration_property_description& datatools::configuration_property_description::set_traits	(	int	type_,
		bool	array_ = false,
		int	fixed_size_ = -1
	)

set_triggered_by_flag()

configuration_property_description& datatools::configuration_property_description::set_triggered_by_flag	(	const std::string &	prop_name_,
		bool	triggering_status_ = true
	)

set_triggered_by_label()

configuration_property_description& datatools::configuration_property_description::set_triggered_by_label	(	const std::string &	prop_name_,
		const std::string &	labels_
	)

set_unit_label()

configuration_property_description& datatools::configuration_property_description::set_unit_label

(

const std::string &

)

set_unit_symbol()

configuration_property_description& datatools::configuration_property_description::set_unit_symbol

(

const std::string &

)

Friends And Related Function Documentation

object_configuration_description

friend class object_configuration_description

friend

Member Data Documentation

ARRAY

const bool datatools::configuration_property_description::ARRAY = true

static

CONST

const bool datatools::configuration_property_description::CONST = true

static

EXPLICIT_UNIT

const bool datatools::configuration_property_description::EXPLICIT_UNIT = true

static

IMPLICIT_UNIT

const bool datatools::configuration_property_description::IMPLICIT_UNIT = false

static

MUTABLE

const bool datatools::configuration_property_description::MUTABLE = false

static

SCALAR

const bool datatools::configuration_property_description::SCALAR = false

static

---

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

• bayeux/datatools/object_configuration_description.h