Section entry handle internal data stored within the dictionary of the multi_properties class. More...

#include <bayeux/datatools/multi_properties.h>

Inheritance diagram for datatools::multi_properties::entry:

Public Member Functions
	entry (const std::string &key_="", const std::string &meta_="")
	Constructor. More...

virtual	~entry ()
	Destructor. More...

const properties &	get_properties () const
	Return a const reference to the collection of properties. More...

properties &	grab_properties ()
	Return a mutable reference to the collection of properties. More...

const std::string &	get_key () const
	Return the primary key. More...

void	set_key (const std::string &)
	Set the primary key. More...

const std::string &	get_meta () const
	Return the meta information text. More...

void	set_meta (const std::string &)
	Set the meta information text. More...

bool	has_meta () const
	Check if meta information text is not empty. More...

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

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

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

Additional Inherited Members
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...

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

Section entry handle internal data stored within the dictionary of the multi_properties class.

Constructor & Destructor Documentation

◆ entry()

datatools::multi_properties::entry::entry	(	const std::string &	key_ = `""`,
		const std::string &	meta_ = `""`
	)

Constructor.

◆ ~entry()

virtual datatools::multi_properties::entry::~entry ( )

virtual

Destructor.

Member Function Documentation

◆ get_key()

const std::string& datatools::multi_properties::entry::get_key ( ) const

Return the primary key.

◆ get_meta()

const std::string& datatools::multi_properties::entry::get_meta ( ) const

Return the meta information text.

◆ get_properties()

const properties& datatools::multi_properties::entry::get_properties ( ) const

Return a const reference to the collection of properties.

◆ grab_properties()

properties& datatools::multi_properties::entry::grab_properties ( )

Return a mutable reference to the collection of properties.

◆ has_meta()

bool datatools::multi_properties::entry::has_meta ( ) const

Check if meta information text is not empty.

◆ print_tree()

void datatools::multi_properties::entry::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.

◆ set_key()

void datatools::multi_properties::entry::set_key ( const std::string & )

Set the primary key.

◆ set_meta()

void datatools::multi_properties::entry::set_meta ( const std::string & )

Set the meta information text.

◆ tree_dump()

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