A geometry model implementing an unique simple 3D shape, possibly with internal/daughter volumes. More...

#include <bayeux/geomtools/simple_shaped_model.h>

Inheritance diagram for geomtools::simple_shaped_model:

Public Types
enum	shape_build_mode_type { SBM_INVALID = 0, SBM_LEGACY = 1, SBM_FACTORY = 2, SBM_DEFAULT = SBM_LEGACY }
	Shape build mode. More...

Public Types inherited from geomtools::i_model
typedef geomtools::models_col_type	models_col_type
	The collection of geometry models: 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
MWIM &	grab_internals ()

const MWIM &	get_internals () const

const std::string &	get_material_name () const

const std::string &	get_filled_material_name () const

shape_build_mode_type	get_shape_build_mode () const

const std::string &	get_shape_type_id () const

const geomtools::box &	get_box () const

const geomtools::cylinder &	get_cylinder () const

const geomtools::tube &	get_tube () const

const geomtools::sphere &	get_sphere () const

const geomtools::polycone &	get_polycone () const

const geomtools::polyhedra &	get_polyhedra () const

const geomtools::i_shape_3d &	get_solid () const

bool	is_filled () const

bool	is_filled_by_envelope () const

bool	is_filled_by_extrusion () const

	simple_shaped_model ()

virtual	~simple_shaped_model ()

virtual std::string	get_model_id () const
	Get the model ID. 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 geomtools::i_model
model_with_internal_mesh_data &	grab_meshes ()

const model_with_internal_mesh_data &	get_meshes () const

bool	is_constructed () const
	Check if the construction of the geometry model is completed. More...

bool	is_phantom_solid () const
	Check if the geometry model is "phantom". More...

bool	has_name () const
	Check if the name of the geometry model exists. More...

void	set_name (const std::string &name_)
	Set the name of the geometry model. More...

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

const datatools::properties &	parameters () const
	Configuration parameters (should be get_) More...

datatools::properties &	parameters ()
	Configuration parameters (should be grab_) More...

	i_model (const std::string &dummy_="")
	Constructor. More...

virtual	~i_model ()
	Destructor. More...

const geomtools::logical_volume &	get_logical () const
	Get a non mutable reference to the embedded logical volume. More...

geomtools::logical_volume &	grab_logical ()
	Get a mutable reference to the embedded logical volume. More...

virtual void	construct (const std::string &name_, const datatools::properties &setup_, models_col_type *models_=0)
	Method that constructs the geometry model. More...

virtual void	construct (const std::string &name_, const datatools::properties &setup_, const std::vector< std::string > &properties_prefixes_, models_col_type *models_)
	Main method that constructs the geometry model. 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...

bool	is_debug () const
	Check for debug logging priority threshold. More...

void	set_debug (bool)
	Force the debug logging priority threshold. More...

bool	has_shape_factory () const
	Check if an external shape factory is referenced. More...

void	set_shape_factory (shape_factory &)
	Set a reference to an external shape factory. More...

shape_factory &	grab_shape_factory ()
	Return a reference to an external shape factory. More...

const shape_factory &	get_shape_factory () const
	Return a reference to an external shape factory. 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

Protected Member Functions
virtual void	_pre_construct (datatools::properties &setup_, models_col_type *models_)
	Pre-construction hook. More...

virtual void	_post_construct (datatools::properties &setup_, models_col_type *models_)
	Post-construction hook. More...

virtual void	_at_construct (const std::string &name_, const datatools::properties &config_, models_col_type *models_=0)
	The main construction hook. More...

virtual void	_construct_box (const std::string &name_, const datatools::properties &config_, models_col_type *models_)

virtual void	_construct_cylinder (const std::string &name_, const datatools::properties &config_, models_col_type *models_)

virtual void	_construct_sphere (const std::string &name_, const datatools::properties &config_, models_col_type *models_)

virtual void	_construct_tube (const std::string &name_, const datatools::properties &config_, models_col_type *models_)

virtual void	_construct_polycone (const std::string &name_, const datatools::properties &config_, models_col_type *models_)

virtual void	_construct_polyhedra (const std::string &name_, const datatools::properties &config_, models_col_type *models_)

Protected Member Functions inherited from geomtools::i_model
void	_set_phantom_solid (bool)
	Set the phantom solid flag. More...

void	_mandatory_pre_construct (datatools::properties &setup_, models_col_type *models_)
	Mandatory pre construction. More...

void	_mandatory_post_construct (datatools::properties &setup_, models_col_type *models_)
	Mandatory post construction. More...

Additional Inherited Members
Static Public Member Functions inherited from geomtools::i_model
static const std::string &	solid_suffix ()

static const std::string &	logical_suffix ()

static const std::string &	physical_suffix ()

static const std::string &	phantom_solid_flag ()

static const std::string &	exported_properties_prefixes_key ()

static void	init_ocd (datatools::object_configuration_description &ocd_)
	OCD support. More...

static std::string	make_solid_name (const std::string &basename_)

static std::string	make_logical_volume_name (const std::string &basename_)

static std::string	make_physical_volume_name (const std::string &basename_)

static std::string	make_physical_volume_name_per_item (const std::string &basename_, int i_)

static std::string	make_physical_volume_name_per_item (const std::string &basename_, int i_, int j_)

static std::string	make_physical_volume_name (const std::string &basename_, int nitems_)

static std::string	make_physical_volume_name (const std::string &basename_, int ncols_, int nrows_)

static std::string	extract_label_from_physical_volume_name (const std::string &physical_volume_name_)

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_)

Protected Attributes inherited from geomtools::i_model
datatools::logger::priority	_logging_priority
	Logging priority threshold. More...

bool	_phantom_solid
	Special flag (not used yet) More...

geomtools::logical_volume	_logical
	Top logical volume attached to the model. More...

Detailed Description

A geometry model implementing an unique simple 3D shape, possibly with internal/daughter volumes.

Member Enumeration Documentation

◆ shape_build_mode_type

enum geomtools::simple_shaped_model::shape_build_mode_type

Shape build mode.

Enumerator
SBM_INVALID	Invalid.
SBM_LEGACY	Build shape from hardcoded (legacy)
SBM_FACTORY	Build shape from a factory (needs a reference shape factory)
SBM_DEFAULT

Constructor & Destructor Documentation

◆ simple_shaped_model()

geomtools::simple_shaped_model::simple_shaped_model ( )

◆ ~simple_shaped_model()

virtual geomtools::simple_shaped_model::~simple_shaped_model ( )

virtual

Member Function Documentation

◆ _at_construct()

virtual void geomtools::simple_shaped_model::_at_construct	(	const std::string &	name_,
		const datatools::properties &	setup_,
		models_col_type *	models_ = `0`
	)

protectedvirtual

The main construction hook.

Implements geomtools::i_model.

◆ _construct_box()

virtual void geomtools::simple_shaped_model::_construct_box	(	const std::string &	name_,
		const datatools::properties &	config_,
		models_col_type *	models_
	)

protectedvirtual

◆ _construct_cylinder()

virtual void geomtools::simple_shaped_model::_construct_cylinder	(	const std::string &	name_,
		const datatools::properties &	config_,
		models_col_type *	models_
	)

protectedvirtual

◆ _construct_polycone()

virtual void geomtools::simple_shaped_model::_construct_polycone	(	const std::string &	name_,
		const datatools::properties &	config_,
		models_col_type *	models_
	)

protectedvirtual

◆ _construct_polyhedra()

virtual void geomtools::simple_shaped_model::_construct_polyhedra	(	const std::string &	name_,
		const datatools::properties &	config_,
		models_col_type *	models_
	)

protectedvirtual

◆ _construct_sphere()

virtual void geomtools::simple_shaped_model::_construct_sphere	(	const std::string &	name_,
		const datatools::properties &	config_,
		models_col_type *	models_
	)

protectedvirtual

◆ _construct_tube()

virtual void geomtools::simple_shaped_model::_construct_tube	(	const std::string &	name_,
		const datatools::properties &	config_,
		models_col_type *	models_
	)

protectedvirtual

◆ _post_construct()

virtual void geomtools::simple_shaped_model::_post_construct	(	datatools::properties &	setup_,
		models_col_type *	models_
	)

protectedvirtual

Post-construction hook.

Reimplemented from geomtools::i_model.

◆ _pre_construct()

virtual void geomtools::simple_shaped_model::_pre_construct	(	datatools::properties &	setup_,
		models_col_type *	models_
	)

protectedvirtual

Pre-construction hook.

Reimplemented from geomtools::i_model.

◆ get_box()

const geomtools::box& geomtools::simple_shaped_model::get_box ( ) const

◆ get_cylinder()

const geomtools::cylinder& geomtools::simple_shaped_model::get_cylinder ( ) const

◆ get_filled_material_name()

const std::string& geomtools::simple_shaped_model::get_filled_material_name ( ) const

◆ get_internals()

const MWIM& geomtools::simple_shaped_model::get_internals ( ) const

◆ get_material_name()

const std::string& geomtools::simple_shaped_model::get_material_name ( ) const

◆ get_model_id()

virtual std::string geomtools::simple_shaped_model::get_model_id ( ) const

virtual

Get the model ID.

Implements geomtools::i_model.

◆ get_polycone()

const geomtools::polycone& geomtools::simple_shaped_model::get_polycone ( ) const

◆ get_polyhedra()

const geomtools::polyhedra& geomtools::simple_shaped_model::get_polyhedra ( ) const

◆ get_shape_build_mode()

shape_build_mode_type geomtools::simple_shaped_model::get_shape_build_mode ( ) const

◆ get_shape_type_id()

const std::string& geomtools::simple_shaped_model::get_shape_type_id ( ) const

◆ get_solid()

const geomtools::i_shape_3d& geomtools::simple_shaped_model::get_solid ( ) const

◆ get_sphere()

const geomtools::sphere& geomtools::simple_shaped_model::get_sphere ( ) const

◆ get_tube()

const geomtools::tube& geomtools::simple_shaped_model::get_tube ( ) const

◆ grab_internals()

MWIM& geomtools::simple_shaped_model::grab_internals ( )

◆ is_filled()

bool geomtools::simple_shaped_model::is_filled ( ) const

◆ is_filled_by_envelope()

bool geomtools::simple_shaped_model::is_filled_by_envelope ( ) const

◆ is_filled_by_extrusion()

bool geomtools::simple_shaped_model::is_filled_by_extrusion ( ) const

◆ tree_dump()

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

virtual

Smart print.

Reimplemented from geomtools::i_model.

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

bayeux/geomtools/simple_shaped_model.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ shape_build_mode_type

Constructor & Destructor Documentation

◆ simple_shaped_model()

◆ ~simple_shaped_model()

Member Function Documentation

◆ _at_construct()

◆ _construct_box()

◆ _construct_cylinder()

◆ _construct_polycone()

◆ _construct_polyhedra()

◆ _construct_sphere()

◆ _construct_tube()

◆ _post_construct()

◆ _pre_construct()

◆ get_box()

◆ get_cylinder()

◆ get_filled_material_name()

◆ get_internals()

◆ get_material_name()

◆ get_model_id()

◆ get_polycone()

◆ get_polyhedra()

◆ get_shape_build_mode()

◆ get_shape_type_id()

◆ get_solid()

◆ get_sphere()

◆ get_tube()

◆ grab_internals()

◆ is_filled()

◆ is_filled_by_envelope()

◆ is_filled_by_extrusion()

◆ tree_dump()