Module record entry class. More...

#include <bayeux/dpp/module_tools.h>

Inheritance diagram for dpp::module_entry_type:

Public Types
enum	status_type { STATUS_BLANK = 0, STATUS_CREATED = datatools::bit_mask::bit00, STATUS_INITIALIZED = datatools::bit_mask::bit01 }

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
const datatools::properties &	get_module_config () const

datatools::properties &	grab_module_config ()

void	set_module_config (const datatools::properties &)

const std::string &	get_module_name () const

void	set_module_name (const std::string &)

const std::string &	get_module_id () const

void	set_ptr (base_module *)

void	set_module_id (const std::string &)

bool	has_manager () const

void	set_manager (module_manager &)

void	set_blank ()

void	set_created ()

void	set_initialized ()

void	set_uninitialized ()

bool	is_created () const

bool	is_initialized () const

	module_entry_type ()
	Constructor. More...

virtual	~module_entry_type ()
	Destructor. More...

bool	has_module () const
	Check is the module is referenced in the embedded handle. More...

const base_module &	get_module () const

base_module &	grab_module ()

const module_handle_type &	get_module_handle () const

module_handle_type &	grab_module_handle ()

module_handle_type &	grab_initialized_module_handle ()

virtual void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
	Main old interface method for printing. More...

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

virtual	~i_tree_dumpable ()
	Destructor. More...

virtual void	print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
	Main new interface method for printing. 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

Friends
class	module_manager

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

Module record entry class.

Member Enumeration Documentation

◆ status_type

enum dpp::module_entry_type::status_type

Enumerator
STATUS_BLANK
STATUS_CREATED
STATUS_INITIALIZED

Constructor & Destructor Documentation

◆ module_entry_type()

dpp::module_entry_type::module_entry_type ( )

Constructor.

◆ ~module_entry_type()

virtual dpp::module_entry_type::~module_entry_type ( )

virtual

Destructor.

Member Function Documentation

◆ get_module()

const base_module& dpp::module_entry_type::get_module ( ) const

◆ get_module_config()

const datatools::properties& dpp::module_entry_type::get_module_config ( ) const

◆ get_module_handle()

const module_handle_type& dpp::module_entry_type::get_module_handle ( ) const

◆ get_module_id()

const std::string& dpp::module_entry_type::get_module_id ( ) const

◆ get_module_name()

const std::string& dpp::module_entry_type::get_module_name ( ) const

◆ grab_initialized_module_handle()

module_handle_type& dpp::module_entry_type::grab_initialized_module_handle ( )

◆ grab_module()

base_module& dpp::module_entry_type::grab_module ( )

◆ grab_module_config()

datatools::properties& dpp::module_entry_type::grab_module_config ( )

◆ grab_module_handle()

module_handle_type& dpp::module_entry_type::grab_module_handle ( )

◆ has_manager()

bool dpp::module_entry_type::has_manager ( ) const

◆ has_module()

bool dpp::module_entry_type::has_module ( ) const

Check is the module is referenced in the embedded handle.

◆ is_created()

bool dpp::module_entry_type::is_created ( ) const

◆ is_initialized()

bool dpp::module_entry_type::is_initialized ( ) const

◆ set_blank()

void dpp::module_entry_type::set_blank ( )

◆ set_created()

void dpp::module_entry_type::set_created ( )

◆ set_initialized()

void dpp::module_entry_type::set_initialized ( )

◆ set_manager()

void dpp::module_entry_type::set_manager ( module_manager & )

◆ set_module_config()

void dpp::module_entry_type::set_module_config ( const datatools::properties & )

◆ set_module_id()

void dpp::module_entry_type::set_module_id ( const std::string & )

◆ set_module_name()

void dpp::module_entry_type::set_module_name ( const std::string & )

◆ set_ptr()

void dpp::module_entry_type::set_ptr ( base_module * )

◆ set_uninitialized()

void dpp::module_entry_type::set_uninitialized ( )

◆ tree_dump()

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