Structure describing a variant object of interest which may have (dynamic) dependencies. More...

#include <bayeux/datatools/configuration/variant_object_info.h>

Public Types
enum	object_type { OBJECT_INVALID = 0, OBJECT_REGISTRY = 1, OBJECT_VARIANT = 2, OBJECT_PARAMETER = 3, OBJECT_PARAMETER_VALUE_GROUP = 4, OBJECT_PARAMETER_ENUM_STRING_VALUE = 5 }
	Object type: More...

enum	parse_flags { PARSE_DEBUG = datatools::bit_mask::bit00, PARSE_NO_GLOBAL = datatools::bit_mask::bit01, PARSE_NO_LOCAL = datatools::bit_mask::bit02 }
	Parsing flags. More...

Public Member Functions
void	set_registry_name (const std::string &registry_name_)

void	make_registry (const std::string &registry_name_)

void	make_global (const std::string &registry_name_)

void	make_variant (const std::string &registry_name_, const std::string &variant_local_path_)

void	make_local_variant (const std::string &variant_local_path_)

void	make_parameter (const std::string &registry_name_, const std::string &parameter_local_path_)

void	make_local_parameter (const std::string &parameter_local_path_)

void	make_parameter_value_group (const std::string &registry_name_, const std::string &param_local_path_, const std::string &group_name_)

void	make_local_parameter_value_group (const std::string &param_local_path_, const std::string &group_name_)

void	make_parameter_enum_string_value (const std::string &registry_name_, const std::string &param_local_path_, const std::string &value_)

void	make_local_parameter_enum_string_value (const std::string &param_local_path_, const std::string &value_)

bool	is_valid () const

bool	is_local () const

bool	is_global () const

object_type	get_type () const

bool	is_registry () const

bool	is_variant () const

bool	is_parameter () const

bool	is_parameter_value_group () const

bool	is_parameter_enum_string_value () const

const std::string &	get_registry_name () const

const std::string &	get_local_path () const

const std::string &	get_variant_local_path () const

const std::string &	get_parameter_local_path () const

const std::string &	get_parameter_value_group_name () const

const std::string &	get_parameter_enum_string_value () const

void	reset ()
	Reset. More...

bool	parse_from_string (const std::string &repr_, uint32_t flags_=0)
	Parse from a string. More...

void	to_string (std::string &repr_) const
	Convert to a string. More...

std::string	get_full_path () const
	Return the full path. More...

bool	match_path (const std::string &path_) const
	Check compatibility with a given path. More...

Protected Member Functions
bool	_parse_from_string_global (const std::string &repr_, const datatools::logger::priority logging_)

bool	_parse_from_string_local (const std::string &repr_, const datatools::logger::priority logging_)

Friends
std::ostream &	operator<< (std::ostream &, const variant_object_info &)
	Stream. More...

Detailed Description

Structure describing a variant object of interest which may have (dynamic) dependencies.

Supported variant object types are:

a variant registry hosted by a variant repository
a variant hosted by a variant registry
a variant parameter hosted by a variant registry
a group of values defined associated to a variant parameter in a variant registry
a specific enumerated string value defined within a variant parameter in a variant registry

Some of these objects is likely to be dependent of some dependee variant(s).

See also: variant_dependency

Member Enumeration Documentation

◆ object_type

enum datatools::configuration::variant_object_info::object_type

Object type:

Enumerator
OBJECT_INVALID	Invalid object.
OBJECT_REGISTRY	Variant registry object.
OBJECT_VARIANT	Variant object.
OBJECT_PARAMETER	Variant parameter object.
OBJECT_PARAMETER_VALUE_GROUP	Variant parameter value group object.
OBJECT_PARAMETER_ENUM_STRING_VALUE	Variant parameter enumerated string value object.

◆ parse_flags

enum datatools::configuration::variant_object_info::parse_flags

Parsing flags.

Enumerator
PARSE_DEBUG
PARSE_NO_GLOBAL
PARSE_NO_LOCAL

Member Function Documentation

◆ _parse_from_string_global()

bool datatools::configuration::variant_object_info::_parse_from_string_global	(	const std::string &	repr_,
		const datatools::logger::priority	logging_
	)

protected

◆ _parse_from_string_local()

bool datatools::configuration::variant_object_info::_parse_from_string_local	(	const std::string &	repr_,
		const datatools::logger::priority	logging_
	)

protected

◆ get_full_path()

std::string datatools::configuration::variant_object_info::get_full_path ( ) const

Return the full path.

◆ get_local_path()

const std::string& datatools::configuration::variant_object_info::get_local_path ( ) const

◆ get_parameter_enum_string_value()

const std::string& datatools::configuration::variant_object_info::get_parameter_enum_string_value ( ) const

◆ get_parameter_local_path()

const std::string& datatools::configuration::variant_object_info::get_parameter_local_path ( ) const

◆ get_parameter_value_group_name()

const std::string& datatools::configuration::variant_object_info::get_parameter_value_group_name ( ) const

◆ get_registry_name()

const std::string& datatools::configuration::variant_object_info::get_registry_name ( ) const

◆ get_type()

object_type datatools::configuration::variant_object_info::get_type ( ) const

◆ get_variant_local_path()

const std::string& datatools::configuration::variant_object_info::get_variant_local_path ( ) const

◆ is_global()

bool datatools::configuration::variant_object_info::is_global ( ) const

◆ is_local()

bool datatools::configuration::variant_object_info::is_local ( ) const

◆ is_parameter()

bool datatools::configuration::variant_object_info::is_parameter ( ) const

◆ is_parameter_enum_string_value()

bool datatools::configuration::variant_object_info::is_parameter_enum_string_value ( ) const

◆ is_parameter_value_group()

bool datatools::configuration::variant_object_info::is_parameter_value_group ( ) const

◆ is_registry()

bool datatools::configuration::variant_object_info::is_registry ( ) const

◆ is_valid()

bool datatools::configuration::variant_object_info::is_valid ( ) const

◆ is_variant()

bool datatools::configuration::variant_object_info::is_variant ( ) const

◆ make_global()

void datatools::configuration::variant_object_info::make_global ( const std::string & registry_name_ )

◆ make_local_parameter()

void datatools::configuration::variant_object_info::make_local_parameter ( const std::string & parameter_local_path_ )

◆ make_local_parameter_enum_string_value()

void datatools::configuration::variant_object_info::make_local_parameter_enum_string_value	(	const std::string &	param_local_path_,
		const std::string &	value_
	)

◆ make_local_parameter_value_group()

void datatools::configuration::variant_object_info::make_local_parameter_value_group	(	const std::string &	param_local_path_,
		const std::string &	group_name_
	)

◆ make_local_variant()

void datatools::configuration::variant_object_info::make_local_variant ( const std::string & variant_local_path_ )

◆ make_parameter()

void datatools::configuration::variant_object_info::make_parameter	(	const std::string &	registry_name_,
		const std::string &	parameter_local_path_
	)

◆ make_parameter_enum_string_value()

void datatools::configuration::variant_object_info::make_parameter_enum_string_value	(	const std::string &	registry_name_,
		const std::string &	param_local_path_,
		const std::string &	value_
	)

◆ make_parameter_value_group()

void datatools::configuration::variant_object_info::make_parameter_value_group	(	const std::string &	registry_name_,
		const std::string &	param_local_path_,
		const std::string &	group_name_
	)

◆ make_registry()

void datatools::configuration::variant_object_info::make_registry ( const std::string & registry_name_ )

◆ make_variant()

void datatools::configuration::variant_object_info::make_variant	(	const std::string &	registry_name_,
		const std::string &	variant_local_path_
	)

◆ match_path()

bool datatools::configuration::variant_object_info::match_path ( const std::string & path_ ) const

Check compatibility with a given path.

◆ parse_from_string()

bool datatools::configuration::variant_object_info::parse_from_string	(	const std::string &	repr_,
		uint32_t	flags_ = `0`
	)

Parse from a string.

◆ reset()

void datatools::configuration::variant_object_info::reset ( )

Reset.

◆ set_registry_name()

void datatools::configuration::variant_object_info::set_registry_name ( const std::string & registry_name_ )

◆ to_string()

void datatools::configuration::variant_object_info::to_string ( std::string & repr_ ) const

Convert to a string.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	,
		const variant_object_info &
	)

friend

Stream.

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

bayeux/datatools/configuration/variant_object_info.h

Public Types

Public Member Functions

Protected Member Functions

Friends