Internal record plugin handling. More...

#include <bayeux/geomtools/manager.h>

Inheritance diagram for geomtools::manager::plugin_entry:

Public Types
enum	status_type { STATUS_BLANK = 0x0, STATUS_CREATED = 0x1, STATUS_INITIALIZED = 0x2 }
	Status of a plugin entry. 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
void	set_name (const std::string &)
	Set the name of the plugin. More...

const std::string &	get_name () const
	Get the name of the plugin. More...

const std::string &	get_id () const
	Get the ID of the plugin. More...

void	set_description (const std::string &)
	Set the description of the plugin. More...

bool	has_description () const
	Check is the description is not empty. More...

const std::string &	get_description () const
	Get the description of the plugin. More...

const datatools::properties &	get_config () const
	Set the configuration. More...

void	set_config (const datatools::properties &)
	Get the configuration. More...

datatools::properties &	grab_config ()
	Grab the configuration. More...

bool	is_created () const
	Check if plugin is created. More...

bool	is_initialized () const
	Check if plugin is initialized. More...

bool	can_be_dropped () const
	Check if plugin can be dropped by the manager. More...

	plugin_entry ()
	Default constructor. More...

	~plugin_entry ()
	Destructor. More...

base_plugin &	grab ()
	Return a reference to the mutable plugin. More...

const base_plugin &	get () const
	Return a reference to the non mutable plugin. 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::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

Public Attributes
std::string	_name_
	Name of the plugin. More...

std::string	_id_
	The ID (type) of the plugin. More...

std::string	_description_
	Description of the plugin. More...

datatools::properties	_config_
	The configuration of the plugin. More...

uint32_t	_status_
	Status of the plugin. More...

plugin_handle_type	_handle_
	Handle to the plugin. More...

Protected Member Functions
void	_set_status (uint32_t)
	Modify the status of the plugin entry. More...

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

Internal record plugin handling.

Member Enumeration Documentation

◆ status_type

enum geomtools::manager::plugin_entry::status_type

Status of a plugin entry.

Enumerator
STATUS_BLANK	Not created not initialized.
STATUS_CREATED	Created.
STATUS_INITIALIZED	Initialized.

Constructor & Destructor Documentation

◆ plugin_entry()

geomtools::manager::plugin_entry::plugin_entry ( )

Default constructor.

◆ ~plugin_entry()

geomtools::manager::plugin_entry::~plugin_entry ( )

Destructor.

Member Function Documentation

◆ _set_status()

void geomtools::manager::plugin_entry::_set_status ( uint32_t )

protected

Modify the status of the plugin entry.

◆ can_be_dropped()

bool geomtools::manager::plugin_entry::can_be_dropped ( ) const

Check if plugin can be dropped by the manager.

◆ get()

const base_plugin& geomtools::manager::plugin_entry::get ( ) const

Return a reference to the non mutable plugin.

◆ get_config()

const datatools::properties& geomtools::manager::plugin_entry::get_config ( ) const

Set the configuration.

◆ get_description()

const std::string& geomtools::manager::plugin_entry::get_description ( ) const

Get the description of the plugin.

◆ get_id()

const std::string& geomtools::manager::plugin_entry::get_id ( ) const

Get the ID of the plugin.

◆ get_name()

const std::string& geomtools::manager::plugin_entry::get_name ( ) const

Get the name of the plugin.

◆ grab()

base_plugin& geomtools::manager::plugin_entry::grab ( )

Return a reference to the mutable plugin.

◆ grab_config()

datatools::properties& geomtools::manager::plugin_entry::grab_config ( )

Grab the configuration.

◆ has_description()

bool geomtools::manager::plugin_entry::has_description ( ) const

Check is the description is not empty.

◆ is_created()

bool geomtools::manager::plugin_entry::is_created ( ) const

Check if plugin is created.

◆ is_initialized()

bool geomtools::manager::plugin_entry::is_initialized ( ) const

Check if plugin is initialized.

◆ set_config()

void geomtools::manager::plugin_entry::set_config ( const datatools::properties & )

Get the configuration.

◆ set_description()

void geomtools::manager::plugin_entry::set_description ( const std::string & )

Set the description of the plugin.

◆ set_name()

void geomtools::manager::plugin_entry::set_name ( const std::string & )

Set the name of the plugin.

◆ tree_dump()

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

virtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.

Member Data Documentation

◆ _config_

datatools::properties geomtools::manager::plugin_entry::_config_

The configuration of the plugin.

◆ _description_

std::string geomtools::manager::plugin_entry::_description_

Description of the plugin.

◆ _handle_

plugin_handle_type geomtools::manager::plugin_entry::_handle_

Handle to the plugin.

◆ _id_

std::string geomtools::manager::plugin_entry::_id_

The ID (type) of the plugin.

◆ _name_

std::string geomtools::manager::plugin_entry::_name_

Name of the plugin.

◆ _status_

uint32_t geomtools::manager::plugin_entry::_status_

Status of the plugin.

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

bayeux/geomtools/manager.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members