Falaise  4.0.1
SuperNEMO Software Toolkit
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
snemo::geometry::locator_plugin Class Reference

A geometry manager plugin with embedded SuperNEMO locators. More...

#include <falaise/snemo/geometry/locator_plugin.h>

Inheritance diagram for snemo::geometry::locator_plugin:
geomtools::manager::base_plugin

Classes

struct  locator_entry_type
 

Public Types

typedef datatools::handle< geomtools::base_locatorlocator_handle_type
 
typedef std::map< std::string, locator_entry_typelocator_dict_type
 

Public Member Functions

 locator_plugin ()
 Default constructor. More...
 
virtual ~locator_plugin ()
 Destructor. More...
 
virtual int initialize (const datatools::properties &config_, const geomtools::manager::plugins_dict_type &plugins_, const datatools::service_dict_type &services_)
 Main plugin initialization method. More...
 
virtual int reset ()
 Plugin reset method. More...
 
virtual bool is_initialized () const
 Check if plugin is initialized. More...
 
const locator_dict_typeget_locators () const
 Returns a non-mutable reference to the dictionary of locators. More...
 
locator_dict_typegrab_locators ()
 Returns a mutable reference to the dictionary of locators. More...
 
bool has_gg_locator () const
 Check if geiger locator is available. More...
 
bool has_calo_locator () const
 Check if calo locator is available. More...
 
bool has_xcalo_locator () const
 Check if xcalo locator is available. More...
 
bool has_gveto_locator () const
 Check if gveto locator is available. More...
 
const snemo::geometry::gg_locatorget_gg_locator () const
 Returns a non-mutable reference to the geiger locator. More...
 
const snemo::geometry::calo_locatorget_calo_locator () const
 Returns a non-mutable reference to the main wall locator. More...
 
const snemo::geometry::xcalo_locatorget_xcalo_locator () const
 Returns a non-mutable reference to the X wall locator. More...
 
const snemo::geometry::gveto_locatorget_gveto_locator () const
 Returns a non-mutable reference to the gamma veto locator. More...
 
- Public Member Functions inherited from geomtools::manager::base_plugin
 base_plugin ()
 
virtual ~base_plugin ()
 
void set_geo_manager (manager &geo_mgr_)
 
const managerget_geo_manager () const
 
virtual int initialize_standalone (const datatools::properties &config)
 
virtual int initialize_simple (const datatools::properties &config_, const plugins_dict_type &plugins_)
 
virtual int initialize (const datatools::properties &config_, const plugins_dict_type &plugins_, const datatools::service_dict_type &services_)=0
 
datatools::logger::priority get_logging_priority () const
 
void set_logging_priority (datatools::logger::priority)
 

Protected Member Functions

void _build_locators (const datatools::properties &config_)
 Internal mapping build method. More...
 
- Protected Member Functions inherited from geomtools::manager::base_plugin
void _basic_initialize (const datatools::properties &config_)
 
manager_grab_geo_manager ()
 
bool _has_geom_setup_requirement () const
 
void _check_geom_setup_requirement () const
 

Additional Inherited Members

- Protected Attributes inherited from geomtools::manager::base_plugin
datatools::logger::priority _logging
 

Detailed Description

A geometry manager plugin with embedded SuperNEMO locators.

Member Typedef Documentation

◆ locator_dict_type

◆ locator_handle_type

Constructor & Destructor Documentation

◆ locator_plugin()

snemo::geometry::locator_plugin::locator_plugin ( )

Default constructor.

◆ ~locator_plugin()

virtual snemo::geometry::locator_plugin::~locator_plugin ( )
virtual

Destructor.

Member Function Documentation

◆ _build_locators()

void snemo::geometry::locator_plugin::_build_locators ( const datatools::properties config_)
protected

Internal mapping build method.

◆ get_calo_locator()

const snemo::geometry::calo_locator& snemo::geometry::locator_plugin::get_calo_locator ( ) const

Returns a non-mutable reference to the main wall locator.

◆ get_gg_locator()

const snemo::geometry::gg_locator& snemo::geometry::locator_plugin::get_gg_locator ( ) const

Returns a non-mutable reference to the geiger locator.

◆ get_gveto_locator()

const snemo::geometry::gveto_locator& snemo::geometry::locator_plugin::get_gveto_locator ( ) const

Returns a non-mutable reference to the gamma veto locator.

◆ get_locators()

const locator_dict_type& snemo::geometry::locator_plugin::get_locators ( ) const

Returns a non-mutable reference to the dictionary of locators.

◆ get_xcalo_locator()

const snemo::geometry::xcalo_locator& snemo::geometry::locator_plugin::get_xcalo_locator ( ) const

Returns a non-mutable reference to the X wall locator.

◆ grab_locators()

locator_dict_type& snemo::geometry::locator_plugin::grab_locators ( )

Returns a mutable reference to the dictionary of locators.

◆ has_calo_locator()

bool snemo::geometry::locator_plugin::has_calo_locator ( ) const

Check if calo locator is available.

◆ has_gg_locator()

bool snemo::geometry::locator_plugin::has_gg_locator ( ) const

Check if geiger locator is available.

◆ has_gveto_locator()

bool snemo::geometry::locator_plugin::has_gveto_locator ( ) const

Check if gveto locator is available.

◆ has_xcalo_locator()

bool snemo::geometry::locator_plugin::has_xcalo_locator ( ) const

Check if xcalo locator is available.

◆ initialize()

virtual int snemo::geometry::locator_plugin::initialize ( const datatools::properties config_,
const geomtools::manager::plugins_dict_type plugins_,
const datatools::service_dict_type services_ 
)
virtual

Main plugin initialization method.

◆ is_initialized()

virtual bool snemo::geometry::locator_plugin::is_initialized ( ) const
virtual

Check if plugin is initialized.

Implements geomtools::manager::base_plugin.

◆ reset()

virtual int snemo::geometry::locator_plugin::reset ( )
virtual

Plugin reset method.

Implements geomtools::manager::base_plugin.


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