Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Types | Public Member Functions | Protected Member Functions | List of all members
geomtools::smart_id_locator Class Reference

Locator of geometry volumes by thier geometry Id. More...

#include <bayeux/geomtools/smart_id_locator.h>

Inheritance diagram for geomtools::smart_id_locator:
geomtools::i_locator geomtools::i_base_locator

Public Types

enum  mode_type { MODE_INVALID = 0, MODE_LAST = 1, MODE_DEFAULT = MODE_LAST }
 Mode. More...
 

Public Member Functions

datatools::logger::priority get_logging_priority () const
 Get logging priority threshold. More...
 
void set_logging_priority (datatools::logger::priority)
 
bool is_initialized () const
 Check Initialization flag. More...
 
void set_gmap (const geom_map &gmap_)
 Set the reference geometry map. More...
 
 smart_id_locator ()
 Constructor. More...
 
 smart_id_locator (const geom_map &gmap_)
 Constructor. More...
 
 smart_id_locator (const geom_map &gmap_, uint32_t type_, int mode_=MODE_DEFAULT)
 Constructor. More...
 
 smart_id_locator (const geom_map &gmap_, const std::string &rules_, int mode_=MODE_DEFAULT)
 Constructor. More...
 
virtual ~smart_id_locator ()
 Destructor. More...
 
void initialize (uint32_t type_, int mode_=MODE_DEFAULT)
 Initialize the locator from the geometry type. More...
 
void initialize (const std::string &selection_rules_, int mode_=MODE_DEFAULT)
 Initialize the locator from a selection rule. More...
 
void reset ()
 Reset the locator. More...
 
const std::list< const geom_info * > & get_ginfos () const
 Get the list of geometry info object handles. More...
 
virtual bool validate_id (const geom_id &id_) const
 Check if a given geom Id is valid. More...
 
virtual const geom_infoget_geom_info (const geom_id &id_) const
 Retrieve the geometry info object from its geometry Id. More...
 
virtual const geom_idget_geom_id (const vector_3d &world_position_, int type_=geom_id::INVALID_TYPE, double tolerance_=GEOMTOOLS_PROPER_TOLERANCE) const
 Retrieve the geometry Id of the volume from the world position. More...
 
void tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
 Smart print. More...
 
void dump (std::ostream &out_=std::clog) const
 Dump. More...
 
void print_infos (std::ostream &out_) const
 Print. More...
 
- Public Member Functions inherited from geomtools::i_locator
virtual bool find_geom_id (const vector_3d &position_, int type_, geom_id &gid_, double tolerance_=GEOMTOOLS_PROPER_TOLERANCE) const
 

Protected Member Functions

void _construct ()
 Construction. More...
 

Detailed Description

Locator of geometry volumes by thier geometry Id.

Member Enumeration Documentation

◆ mode_type

Mode.

Enumerator
MODE_INVALID 
MODE_LAST 
MODE_DEFAULT 

Constructor & Destructor Documentation

◆ smart_id_locator() [1/4]

geomtools::smart_id_locator::smart_id_locator ( )

Constructor.

◆ smart_id_locator() [2/4]

geomtools::smart_id_locator::smart_id_locator ( const geom_map gmap_)

Constructor.

◆ smart_id_locator() [3/4]

geomtools::smart_id_locator::smart_id_locator ( const geom_map gmap_,
uint32_t  type_,
int  mode_ = MODE_DEFAULT 
)

Constructor.

◆ smart_id_locator() [4/4]

geomtools::smart_id_locator::smart_id_locator ( const geom_map gmap_,
const std::string &  rules_,
int  mode_ = MODE_DEFAULT 
)

Constructor.

◆ ~smart_id_locator()

virtual geomtools::smart_id_locator::~smart_id_locator ( )
virtual

Destructor.

Member Function Documentation

◆ _construct()

void geomtools::smart_id_locator::_construct ( )
protected

Construction.

◆ dump()

void geomtools::smart_id_locator::dump ( std::ostream &  out_ = std::clog) const

Dump.

◆ get_geom_id()

virtual const geom_id& geomtools::smart_id_locator::get_geom_id ( const vector_3d world_position_,
int  type_ = geom_id::INVALID_TYPE,
double  tolerance_ = GEOMTOOLS_PROPER_TOLERANCE 
) const
virtual

Retrieve the geometry Id of the volume from the world position.

Implements geomtools::i_locator.

◆ get_geom_info()

virtual const geom_info& geomtools::smart_id_locator::get_geom_info ( const geom_id id_) const
virtual

Retrieve the geometry info object from its geometry Id.

Implements geomtools::i_locator.

◆ get_ginfos()

const std::list<const geom_info *>& geomtools::smart_id_locator::get_ginfos ( ) const

Get the list of geometry info object handles.

◆ get_logging_priority()

datatools::logger::priority geomtools::smart_id_locator::get_logging_priority ( ) const

Get logging priority threshold.

◆ initialize() [1/2]

void geomtools::smart_id_locator::initialize ( uint32_t  type_,
int  mode_ = MODE_DEFAULT 
)

Initialize the locator from the geometry type.

◆ initialize() [2/2]

void geomtools::smart_id_locator::initialize ( const std::string &  selection_rules_,
int  mode_ = MODE_DEFAULT 
)

Initialize the locator from a selection rule.

◆ is_initialized()

bool geomtools::smart_id_locator::is_initialized ( ) const

Check Initialization flag.

◆ print_infos()

void geomtools::smart_id_locator::print_infos ( std::ostream &  out_) const

Print.

◆ reset()

void geomtools::smart_id_locator::reset ( )

Reset the locator.

◆ set_gmap()

void geomtools::smart_id_locator::set_gmap ( const geom_map gmap_)

Set the reference geometry map.

◆ set_logging_priority()

void geomtools::smart_id_locator::set_logging_priority ( datatools::logger::priority  )

◆ tree_dump()

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

Smart print.

◆ validate_id()

virtual bool geomtools::smart_id_locator::validate_id ( const geom_id id_) const
virtual

Check if a given geom Id is valid.

Implements geomtools::i_locator.


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