A base class with useful attributes usable in many contexts. More...

#include <bayeux/datatools/enriched_base.h>

Inheritance diagram for datatools::enriched_base:

Public Types
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...

Public Member Functions
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 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_)

Detailed Description

A base class with useful attributes usable in many contexts.

Member Enumeration Documentation

◆ export_config_flags

enum datatools::enriched_base::export_config_flags

Flags for export to a container of properties.

Enumerator
EXPORT_CONFIG_CLEAR
EXPORT_CONFIG_NAME
EXPORT_CONFIG_DISPLAY_NAME
EXPORT_CONFIG_TERSE_DESCRIPTION
EXPORT_CONFIG_LOGGING_PRIORITY
EXPORT_CONFIG_AUXILIARIES
EXPORT_CONFIG_DEFAULT
EXPORT_CONFIG_LAST

Constructor & Destructor Documentation

◆ enriched_base() [1/2]

datatools::enriched_base::enriched_base ( )

Default constructor.

◆ enriched_base() [2/2]

datatools::enriched_base::enriched_base	(	const std::string &	name_,
		const std::string &	display_name_ = `""`,
		const std::string &	terse_description_ = `""`,
		logger::priority	lp_ = `logger::PRIO_FATAL`
	)

Constructor.

◆ ~enriched_base()

virtual datatools::enriched_base::~enriched_base ( )

virtual

Destructor.

Member Function Documentation

◆ clear()

void datatools::enriched_base::clear ( )

Clear.

◆ default_logging_priority()

static logger::priority datatools::enriched_base::default_logging_priority ( )

static

Return the default logging priority threshold.

◆ export_to_config()

void datatools::enriched_base::export_to_config	(	datatools::properties &	config_,
		uint32_t	flags_ = `EXPORT_CONFIG_DEFAULT`,
		const std::string &	prefix_ = `""`
	)		const

Export to a container of properties.

◆ get_auxiliaries()

const datatools::properties& datatools::enriched_base::get_auxiliaries ( ) const

Return a reference to the non mutable container of auxiliary properties.

◆ get_display_name()

const std::string& datatools::enriched_base::get_display_name ( ) const

Return the display name.

◆ get_logging_priority()

logger::priority datatools::enriched_base::get_logging_priority ( ) const

Return the logging priority threshold.

◆ get_name()

const std::string& datatools::enriched_base::get_name ( ) const

Return the name.

◆ get_terse_description()

const std::string& datatools::enriched_base::get_terse_description ( ) const

Return the description.

◆ grab_auxiliaries()

datatools::properties& datatools::enriched_base::grab_auxiliaries ( )

Return a reference to the mutable container of auxiliary properties.

◆ has_auxiliaries()

bool datatools::enriched_base::has_auxiliaries ( ) const

Check if the container of auxiliary properties is empty.

◆ has_display_name()

bool datatools::enriched_base::has_display_name ( ) const

Check if the display name is empty.

◆ has_name()

bool datatools::enriched_base::has_name ( ) const

Check if the name is not empty.

◆ has_terse_description()

bool datatools::enriched_base::has_terse_description ( ) const

Check if the description is empty.

◆ init_ocd()

static void datatools::enriched_base::init_ocd ( datatools::object_configuration_description & )

static

OCD support.

◆ initialize()

void datatools::enriched_base::initialize	(	const datatools::properties &	config_,
		bool	clear_ = `false`
	)

Initialization from a container of properties.

◆ is_debug()

bool datatools::enriched_base::is_debug ( ) const

Check the debug status.

◆ is_name_valid()

virtual bool datatools::enriched_base::is_name_valid ( const std::string & name_ ) const

virtual

Check if a name is valid.

Reimplemented in datatools::configuration::variant_repository, datatools::configuration::parameter_model, datatools::configuration::variant_model, datatools::configuration::variant_registry, datatools::ui::base_command, datatools::configuration::parameter_physical, and datatools::configuration::variant_physical.

◆ print_tree()

void datatools::enriched_base::print_tree	(	std::ostream &	out_ = `std::clog`,
		const boost::property_tree::ptree &	options_ = `empty_options()`
	)		const

overridevirtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.

◆ reset()

void datatools::enriched_base::reset ( )

Clear.

◆ reset_auxiliaries()

void datatools::enriched_base::reset_auxiliaries ( )

Remove all auxiliary properties.

◆ reset_name()

void datatools::enriched_base::reset_name ( )

Reset the name.

◆ set_display_name()

void datatools::enriched_base::set_display_name ( const std::string & display_name_ )

Set the display name.

◆ set_display_name_c()

enriched_base& datatools::enriched_base::set_display_name_c ( const std::string & display_name_ )

Set the display name.

◆ set_logging()

void datatools::enriched_base::set_logging ( const std::string & label_ )

Set the logging priority threshold from a string.

◆ set_logging_priority()

void datatools::enriched_base::set_logging_priority ( logger::priority lp_ )

Set the logging priority threshold.

◆ set_logging_priority_c()

enriched_base& datatools::enriched_base::set_logging_priority_c ( logger::priority lp_ )

Set the logging priority threshold.

◆ set_name()

void datatools::enriched_base::set_name ( const std::string & name_ )

Set the name.

◆ set_name_c()

enriched_base& datatools::enriched_base::set_name_c ( const std::string & name_ )

Set the name.

◆ set_terse_description()

void datatools::enriched_base::set_terse_description ( const std::string & terse_description_ )

Set the description.

◆ set_terse_description_c()

enriched_base& datatools::enriched_base::set_terse_description_c ( const std::string & terse_description_ )

Set the description.

◆ tree_dump()

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

overridevirtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.

Reimplemented in datatools::ui::ihs, datatools::urn_db_service, datatools::ui::const_target_command_interface< Type >, datatools::ui::const_target_command< Type >, datatools::ui::const_target_command< basic_shell >, datatools::ui::base_command, datatools::introspection::method, datatools::ui::base_command_interface, datatools::urn_to_path_resolver_service, datatools::ui::target_command_interface< Type >, datatools::ui::target_command_interface< basic_shell >, datatools::ui::target_command< Type >, datatools::ui::target_command< basic_shell >, dpp::histogram_service, dpp::context_service, datatools::urn_query_service, geomtools::geometry_service, and datatools::library_query_service.

◆ validate_name()

static bool datatools::enriched_base::validate_name ( const std::string & candidate_name_ )

static

Validate a name.

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

bayeux/datatools/enriched_base.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ export_config_flags

Constructor & Destructor Documentation

◆ enriched_base() [1/2]

◆ enriched_base() [2/2]

◆ ~enriched_base()

Member Function Documentation

◆ clear()

◆ default_logging_priority()

◆ export_to_config()

◆ get_auxiliaries()

◆ get_display_name()

◆ get_logging_priority()

◆ get_name()

◆ get_terse_description()

◆ grab_auxiliaries()

◆ has_auxiliaries()

◆ has_display_name()

◆ has_name()

◆ has_terse_description()

◆ init_ocd()

◆ initialize()

◆ is_debug()

◆ is_name_valid()

◆ print_tree()

◆ reset()

◆ reset_auxiliaries()

◆ reset_name()

◆ set_display_name()

◆ set_display_name_c()

◆ set_logging()

◆ set_logging_priority()

◆ set_logging_priority_c()

◆ set_name()

◆ set_name_c()

◆ set_terse_description()

◆ set_terse_description_c()

◆ tree_dump()

◆ validate_name()