Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
geomtools::manager::base_plugin Class Referenceabstract

The geometry manager's plugin base class. More...

#include <bayeux/geomtools/manager.h>

Inheritance diagram for geomtools::manager::base_plugin:
emfield::emfield_geom_plugin geomtools::mapping_plugin geomtools::materials_plugin

Public Member Functions

 base_plugin ()
 Constructor. More...
 
virtual ~base_plugin ()
 Destructor. More...
 
void set_geo_manager (manager &geo_mgr_)
 Set the reference to the geometry manager. More...
 
const managerget_geo_manager () const
 Get a non-mutable reference to the geometry manager. More...
 
virtual int initialize_standalone (const datatools::properties &config)
 Initialize the plugin using only a list of properties without the needs of other resources. More...
 
virtual int initialize_simple (const datatools::properties &config_, const plugins_dict_type &plugins_)
 Initialize the plugin using a list of properties and a list of other plugins. More...
 
virtual int initialize (const datatools::properties &config_, const plugins_dict_type &plugins_, const datatools::service_dict_type &services_)=0
 Main initialization method from a list of properties, a list of other plugins and a list of services. More...
 
virtual int reset ()=0
 Main reset method. More...
 
virtual bool is_initialized () const =0
 Check if plugin is initialized. More...
 
datatools::logger::priority get_logging_priority () const
 Get the logging priority threshold. More...
 
void set_logging_priority (datatools::logger::priority)
 Set the logging priority threshold. More...
 

Protected Member Functions

void _basic_initialize (const datatools::properties &config_)
 Basic initialization. More...
 
manager_grab_geo_manager ()
 Get a mutable reference to the geometry manager. More...
 
bool _has_geom_setup_requirement () const
 Check presence of geometry requirements. More...
 
void _check_geom_setup_requirement () const
 Check geometry requirement. More...
 

Protected Attributes

datatools::logger::priority _logging
 

Detailed Description

The geometry manager's plugin base class.

Constructor & Destructor Documentation

◆ base_plugin()

geomtools::manager::base_plugin::base_plugin ( )

Constructor.

◆ ~base_plugin()

virtual geomtools::manager::base_plugin::~base_plugin ( )
virtual

Destructor.

Member Function Documentation

◆ _basic_initialize()

void geomtools::manager::base_plugin::_basic_initialize ( const datatools::properties config_)
protected

Basic initialization.

◆ _check_geom_setup_requirement()

void geomtools::manager::base_plugin::_check_geom_setup_requirement ( ) const
protected

Check geometry requirement.

◆ _grab_geo_manager()

manager& geomtools::manager::base_plugin::_grab_geo_manager ( )
protected

Get a mutable reference to the geometry manager.

◆ _has_geom_setup_requirement()

bool geomtools::manager::base_plugin::_has_geom_setup_requirement ( ) const
protected

Check presence of geometry requirements.

◆ get_geo_manager()

const manager& geomtools::manager::base_plugin::get_geo_manager ( ) const

Get a non-mutable reference to the geometry manager.

◆ get_logging_priority()

datatools::logger::priority geomtools::manager::base_plugin::get_logging_priority ( ) const

Get the logging priority threshold.

◆ initialize()

virtual int geomtools::manager::base_plugin::initialize ( const datatools::properties config_,
const plugins_dict_type plugins_,
const datatools::service_dict_type services_ 
)
pure virtual

Main initialization method from a list of properties, a list of other plugins and a list of services.

Implemented in geomtools::materials_plugin, emfield::emfield_geom_plugin, and geomtools::mapping_plugin.

◆ initialize_simple()

virtual int geomtools::manager::base_plugin::initialize_simple ( const datatools::properties config_,
const plugins_dict_type plugins_ 
)
virtual

Initialize the plugin using a list of properties and a list of other plugins.

◆ initialize_standalone()

virtual int geomtools::manager::base_plugin::initialize_standalone ( const datatools::properties config)
virtual

Initialize the plugin using only a list of properties without the needs of other resources.

◆ is_initialized()

virtual bool geomtools::manager::base_plugin::is_initialized ( ) const
pure virtual

Check if plugin is initialized.

Implemented in geomtools::materials_plugin, emfield::emfield_geom_plugin, and geomtools::mapping_plugin.

◆ reset()

virtual int geomtools::manager::base_plugin::reset ( )
pure virtual

◆ set_geo_manager()

void geomtools::manager::base_plugin::set_geo_manager ( manager geo_mgr_)

Set the reference to the geometry manager.

◆ set_logging_priority()

void geomtools::manager::base_plugin::set_logging_priority ( datatools::logger::priority  )

Set the logging priority threshold.

Member Data Documentation

◆ _logging

datatools::logger::priority geomtools::manager::base_plugin::_logging
protected

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