The geometry ID mapping. More...

#include <bayeux/geomtools/mapping.h>

Inheritance diagram for geomtools::mapping:

Classes
struct	constants

Public Types
enum	build_mode_type { BUILD_MODE_STRICT_MOTHERSHIP = 0, BUILD_MODE_LAZY_MOTHERSHIP = 1, BUILD_MODE_DEFAULT = BUILD_MODE_STRICT_MOTHERSHIP }

enum	mode_type { MODE_NONE = 0, MODE_ONLY = 1, MODE_EXCLUDED = 2 }

enum	smart_print_flags_type { PRINT_TITLE = datatools::bit_mask::bit00, PRINT_PAGER = datatools::bit_mask::bit01 }
	Print flags. More...

Public Types inherited from geomtools::geom_map
typedef std::vector< const geom_info * >	ginfo_ptr_collection_type

typedef std::map< uint32_t, ginfo_ptr_collection_type >	ginfo_collections_with_type_dict_type

Public Member Functions
bool	is_initialized () const
	Check initialization flag. More...

bool	is_mode_none () const
	Check that no inclusion/exclusion of geometry categories mode is set. More...

bool	is_mode_only () const
	Check that the inclusion mode is set. More...

bool	is_mode_excluded () const
	Check that the exclusion mode is set. More...

void	add_only (const std::string &)
	Add a geometry category in the list of processed geometry categories. More...

void	add_excluded (const std::string &)
	Add a geometry category in the list of excluded geometry categories. More...

int	get_build_mode () const
	Return the build mode. More...

void	set_build_mode (int bm_)
	Set the build mode. More...

bool	is_build_mode_strict_mothership () const
	Check the 'strict mothership' build mode. More...

bool	is_build_mode_lazy_mothership () const
	Check the 'lazy mothership' build mode. More...

void	set_max_depth (size_t max_depth_)
	Set the max mapping depth. More...

size_t	get_max_depth () const
	Return the max mapping depth. More...

	mapping ()
	Default constructor. More...

virtual	~mapping ()
	Destructor. More...

void	initialize (const datatools::properties &config_)
	Configure the mapping. More...

virtual void	build_from (const model_factory &factory_, const std::string &mother_="world")
	Build the mapping information. More...

void	dump_dictionnary (std::ostream &out_=std::clog) const
	Basic print of the embedded mapping dictionary. More...

void	smart_print (std::ostream &out_=std::clog, const std::string &indent_="", uint32_t flags_=0) const
	Smart print. More...

Public Member Functions inherited from geomtools::geom_map
datatools::logger::priority	get_logging_priority () const

void	set_logging_priority (datatools::logger::priority)

bool	is_debug () const

void	set_debug (bool)

const id_mgr &	get_id_manager () const

const geom_info_dict_type &	get_geom_infos () const

	geom_map ()

virtual	~geom_map ()

bool	has_id_manager () const

void	set_id_manager (const id_mgr &mgr_)

const geom_id &	get_invalid_geom_id () const

virtual bool	validate_id (const geom_id &id_) const
	Given a geometry ID, check if it is valid (known within some internal table). More...

virtual const geom_info &	get_geom_info (const geom_id &) const
	Given a geometry ID, returns the associated geom_info instance (from some internal table). More...

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

virtual bool	has_geom_info (const geom_id &) const

void	compute_matching_geom_id (const geom_id &gid_pattern_, std::vector< geom_id > &gids_, bool append_=false) const
	Compute the list of GIDs matching a given GID pattern (including 'ANY' addresses) More...

const geom_info *	get_geom_info_ptr (const geom_id &) const

void	get_geom_id (const vector_3d &world_position_, int type_, geom_id &gid_, double tolerance_=GEOMTOOLS_PROPER_TOLERANCE) const

void	get_geom_id (const vector_3d &world_position_, const std::string &category_, geom_id &gid_, double tolerance_=GEOMTOOLS_PROPER_TOLERANCE) const

virtual const geom_id &	get_geom_id (const vector_3d &world_position_, const std::string &category_, double tolerance_=GEOMTOOLS_PROPER_TOLERANCE) const

bool	has_ginfo_collection_with_type (uint32_t type_) const

const ginfo_ptr_collection_type &	get_ginfo_collection_with_type (uint32_t type_) const

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

Static Public Member Functions
static std::string	make_key (const std::string &flag_)

static void	extract (const datatools::properties &source_, datatools::properties &target_)

static bool	has_flag (const datatools::properties &config_, const std::string &flag_)

static bool	has_key (const datatools::properties &config_, const std::string &key_)

Static Public Member Functions inherited from geomtools::geom_map
static bool	check_inside (const geom_info &ginfo_, const vector_3d &world_position_, double tolerance_, bool reverse_=false)

Static Public Attributes
static const size_t	NO_MAX_DEPTH = 0
	Constant representing unlimited mapping depth. More...

Additional Inherited Members
Protected Member Functions inherited from geomtools::geom_map
const id_mgr &	_get_id_manager () const

const geom_info_dict_type &	_get_geom_infos () const

geom_info_dict_type &	_get_geom_infos ()

const ginfo_collections_with_type_dict_type &	get_geom_infos_with_type_map () const

Protected Attributes inherited from geomtools::geom_map
datatools::logger::priority	_logging

Detailed Description

The geometry ID mapping.

Member Enumeration Documentation

◆ build_mode_type

enum geomtools::mapping::build_mode_type

Enumerator
BUILD_MODE_STRICT_MOTHERSHIP
BUILD_MODE_LAZY_MOTHERSHIP
BUILD_MODE_DEFAULT

◆ mode_type

enum geomtools::mapping::mode_type

Enumerator
MODE_NONE
MODE_ONLY
MODE_EXCLUDED

◆ smart_print_flags_type

enum geomtools::mapping::smart_print_flags_type

Print flags.

Enumerator
PRINT_TITLE
PRINT_PAGER

Constructor & Destructor Documentation

◆ mapping()

geomtools::mapping::mapping ( )

Default constructor.

◆ ~mapping()

virtual geomtools::mapping::~mapping ( )

virtual

Destructor.

Member Function Documentation

◆ add_excluded()

void geomtools::mapping::add_excluded ( const std::string & )

Add a geometry category in the list of excluded geometry categories.

◆ add_only()

void geomtools::mapping::add_only ( const std::string & )

Add a geometry category in the list of processed geometry categories.

◆ build_from()

virtual void geomtools::mapping::build_from	(	const model_factory &	factory_,
		const std::string &	mother_ = `"world"`
	)

virtual

Build the mapping information.

Reimplemented from geomtools::geom_map.

◆ dump_dictionnary()

void geomtools::mapping::dump_dictionnary ( std::ostream & out_ = std::clog ) const

Basic print of the embedded mapping dictionary.

◆ extract()

static void geomtools::mapping::extract	(	const datatools::properties &	source_,
		datatools::properties &	target_
	)

static

◆ get_build_mode()

int geomtools::mapping::get_build_mode ( ) const

Return the build mode.

◆ get_max_depth()

size_t geomtools::mapping::get_max_depth ( ) const

Return the max mapping depth.

◆ has_flag()

static bool geomtools::mapping::has_flag	(	const datatools::properties &	config_,
		const std::string &	flag_
	)

static

◆ has_key()

static bool geomtools::mapping::has_key	(	const datatools::properties &	config_,
		const std::string &	key_
	)

static

◆ initialize()

void geomtools::mapping::initialize ( const datatools::properties & config_ )

Configure the mapping.

◆ is_build_mode_lazy_mothership()

bool geomtools::mapping::is_build_mode_lazy_mothership ( ) const

Check the 'lazy mothership' build mode.

◆ is_build_mode_strict_mothership()

bool geomtools::mapping::is_build_mode_strict_mothership ( ) const

Check the 'strict mothership' build mode.

◆ is_initialized()

bool geomtools::mapping::is_initialized ( ) const

Check initialization flag.

◆ is_mode_excluded()

bool geomtools::mapping::is_mode_excluded ( ) const

Check that the exclusion mode is set.

◆ is_mode_none()

bool geomtools::mapping::is_mode_none ( ) const

Check that no inclusion/exclusion of geometry categories mode is set.

◆ is_mode_only()

bool geomtools::mapping::is_mode_only ( ) const

Check that the inclusion mode is set.

◆ make_key()

static std::string geomtools::mapping::make_key ( const std::string & flag_ )

static

◆ set_build_mode()

void geomtools::mapping::set_build_mode ( int bm_ )

Set the build mode.

◆ set_max_depth()

void geomtools::mapping::set_max_depth ( size_t max_depth_ )

Set the max mapping depth.

◆ smart_print()

void geomtools::mapping::smart_print	(	std::ostream &	out_ = `std::clog`,
		const std::string &	indent_ = `""`,
		uint32_t	flags_ = `0`
	)		const

Smart print.

Member Data Documentation

◆ NO_MAX_DEPTH

const size_t geomtools::mapping::NO_MAX_DEPTH = 0

static

Constant representing unlimited mapping depth.

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

bayeux/geomtools/mapping.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ build_mode_type

◆ mode_type

◆ smart_print_flags_type

Constructor & Destructor Documentation

◆ mapping()

◆ ~mapping()

Member Function Documentation

◆ add_excluded()

◆ add_only()

◆ build_from()

◆ dump_dictionnary()

◆ extract()

◆ get_build_mode()

◆ get_max_depth()

◆ has_flag()

◆ has_key()

◆ initialize()

◆ is_build_mode_lazy_mothership()

◆ is_build_mode_strict_mothership()

◆ is_initialized()

◆ is_mode_excluded()

◆ is_mode_none()

◆ is_mode_only()

◆ make_key()

◆ set_build_mode()

◆ set_max_depth()

◆ smart_print()

Member Data Documentation

◆ NO_MAX_DEPTH