A Factory/manager for configuration variants and associated parameters. More...

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

Inheritance diagram for datatools::configuration::variant_registry_manager:

Public Member Functions
	variant_registry_manager ()
	Default constructor. More...

virtual	~variant_registry_manager ()
	Destructor. More...

bool	is_initialized () const
	Check initialization status. More...

void	initialize (const properties &config_)
	Configuration and initialization from properties. More...

void	initialize_simple ()
	Bare initialization. More...

void	reset ()
	Reset. More...

void	set_top_variant_name (const std::string &)
	Set the name of the top variant. More...

const std::string &	get_top_variant_name () const
	Return the name of the top variant. More...

void	add_property_prefix (const std::string &prefix_)
	Add a property prefix to be preserved configuration items. More...

const std::set< std::string > &	get_property_prefixes () const
	Return the array of exported property prefixes. More...

void	load_configuration_items_list (const std::string &item_list_file_)
	Loading a file that contains a list of configuration items definition filenames : More...

void	load (const std::string &items_config_file_)
	Load definitions of configuration items from a file with a stored multi-properties container. More...

const model_item_dict_type &	get_configuration_items () const
	Get a non-mutable collection of configuration items. More...

virtual void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
	Smart print. More...

Public Member Functions inherited from datatools::enriched_base
virtual bool	is_name_valid (const std::string &name_) const
	Check if a name is valid. More...

	enriched_base ()
	Default constructor. More...

	enriched_base (const std::string &name_, const std::string &display_name_="", const std::string &terse_description_="", logger::priority lp_=logger::PRIO_FATAL)
	Constructor. More...

virtual	~enriched_base ()
	Destructor. More...

bool	has_name () const
	Check if the name is not empty. More...

void	set_name (const std::string &name_)
	Set the name. More...

enriched_base &	set_name_c (const std::string &name_)
	Set the name. More...

const std::string &	get_name () const
	Return the name. More...

void	reset_name ()
	Reset the name. More...

bool	has_display_name () const
	Check if the display name is empty. More...

void	set_display_name (const std::string &display_name_)
	Set the display name. More...

enriched_base &	set_display_name_c (const std::string &display_name_)
	Set the display name. More...

const std::string &	get_display_name () const
	Return the display name. More...

bool	has_terse_description () const
	Check if the description is empty. More...

void	set_terse_description (const std::string &terse_description_)
	Set the description. More...

enriched_base &	set_terse_description_c (const std::string &terse_description_)
	Set the description. More...

const std::string &	get_terse_description () const
	Return the description. More...

bool	has_auxiliaries () const
	Check if the container of auxiliary properties is empty. More...

const datatools::properties &	get_auxiliaries () const
	Return a reference to the non mutable container of auxiliary properties. More...

datatools::properties &	grab_auxiliaries ()
	Return a reference to the mutable container of auxiliary properties. More...

void	reset_auxiliaries ()
	Remove all auxiliary properties. More...

bool	is_debug () const
	Check the debug status. More...

void	set_logging_priority (logger::priority lp_)
	Set the logging priority threshold. More...

enriched_base &	set_logging_priority_c (logger::priority lp_)
	Set the logging priority threshold. More...

void	set_logging (const std::string &label_)
	Set the logging priority threshold from a string. More...

logger::priority	get_logging_priority () const
	Return the logging priority threshold. More...

void	clear ()
	Clear. More...

void	reset ()
	Clear. More...

void	print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const override
	Smart print. More...

void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const override
	Smart print. More...

void	initialize (const datatools::properties &config_, bool clear_=false)
	Initialization from a container of properties. More...

void	export_to_config (datatools::properties &config_, uint32_t flags_=EXPORT_CONFIG_DEFAULT, const std::string &prefix_="") const
	Export to a container of properties. More...

Public Member Functions inherited from datatools::i_serializable
	i_serializable ()
	Default constructor. More...

virtual	~i_serializable ()
	Destructor. More...

virtual const std::string &	get_serial_tag () const =0
	Return the serialization string identifier of the class. More...

Public Member Functions inherited from datatools::i_tree_dumpable
	i_tree_dumpable ()
	Constructor. More...

virtual	~i_tree_dumpable ()
	Destructor. More...

void	print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
	Printing with jsonized options. More...

void	print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
	Printing with jsonized options. More...

void	tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const

void	tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const

void	smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const

Static Public Member Functions
static void	init_ocd (datatools::object_configuration_description &)
	OCD support. More...

Static Public Member Functions inherited from datatools::enriched_base
static bool	validate_name (const std::string &candidate_name_)
	Validate a name. More...

static logger::priority	default_logging_priority ()
	Return the default logging priority threshold. More...

static void	init_ocd (datatools::object_configuration_description &)
	OCD support. More...

Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree &	empty_options ()

static boost::property_tree::ptree	make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)

static std::ostream &	last_skip_tag (std::ostream &out_)

static std::ostream &	skip_tag (std::ostream &out_)

static std::ostream &	last_tag (std::ostream &out_)

static std::ostream &	tag (std::ostream &out_)

Protected Member Functions
void	_set_default ()
	Set default values. More...

Additional Inherited Members
Public Types inherited from datatools::enriched_base
enum	export_config_flags { EXPORT_CONFIG_CLEAR = bit_mask::bit00, EXPORT_CONFIG_NAME = bit_mask::bit01, EXPORT_CONFIG_DISPLAY_NAME = bit_mask::bit02, EXPORT_CONFIG_TERSE_DESCRIPTION = bit_mask::bit03, EXPORT_CONFIG_LOGGING_PRIORITY = bit_mask::bit04, EXPORT_CONFIG_AUXILIARIES = bit_mask::bit05, EXPORT_CONFIG_DEFAULT, EXPORT_CONFIG_LAST = EXPORT_CONFIG_AUXILIARIES }
	Flags for export to a container of properties. More...

Public Types inherited from datatools::i_tree_dumpable
enum	ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
	Enumeration for standard output streams. More...

Detailed Description

A Factory/manager for configuration variants and associated parameters.

Constructor & Destructor Documentation

◆ variant_registry_manager()

datatools::configuration::variant_registry_manager::variant_registry_manager ( )

Default constructor.

◆ ~variant_registry_manager()

virtual datatools::configuration::variant_registry_manager::~variant_registry_manager ( )

virtual

Destructor.

Member Function Documentation

◆ _set_default()

void datatools::configuration::variant_registry_manager::_set_default ( )

protected

Set default values.

◆ add_property_prefix()

void datatools::configuration::variant_registry_manager::add_property_prefix ( const std::string & prefix_ )

Add a property prefix to be preserved configuration items.

◆ get_configuration_items()

const model_item_dict_type& datatools::configuration::variant_registry_manager::get_configuration_items ( ) const

Get a non-mutable collection of configuration items.

◆ get_property_prefixes()

const std::set<std::string>& datatools::configuration::variant_registry_manager::get_property_prefixes ( ) const

Return the array of exported property prefixes.

◆ get_top_variant_name()

const std::string& datatools::configuration::variant_registry_manager::get_top_variant_name ( ) const

Return the name of the top variant.

◆ init_ocd()

static void datatools::configuration::variant_registry_manager::init_ocd ( datatools::object_configuration_description & )

static

OCD support.

◆ initialize()

void datatools::configuration::variant_registry_manager::initialize ( const properties & config_ )

Configuration and initialization from properties.

◆ initialize_simple()

void datatools::configuration::variant_registry_manager::initialize_simple ( )

Bare initialization.

◆ is_initialized()

bool datatools::configuration::variant_registry_manager::is_initialized ( ) const

Check initialization status.

◆ load()

void datatools::configuration::variant_registry_manager::load ( const std::string & items_config_file_ )

Load definitions of configuration items from a file with a stored multi-properties container.

◆ load_configuration_items_list()

void datatools::configuration::variant_registry_manager::load_configuration_items_list ( const std::string & item_list_file_ )

Loading a file that contains a list of configuration items definition filenames :

◆ reset()

void datatools::configuration::variant_registry_manager::reset ( )

Reset.

◆ set_top_variant_name()

void datatools::configuration::variant_registry_manager::set_top_variant_name ( const std::string & )

Set the name of the top variant.

◆ tree_dump()

virtual void datatools::configuration::variant_registry_manager::tree_dump	(	std::ostream &	out_ = `std::clog`,
		const std::string &	title_ = `""`,
		const std::string &	indent_ = `""`,
		bool	inherit_ = `false`
	)		const