geomtools::regular_linear_placement Class Reference

Regular linear placement. More...

#include <bayeux/geomtools/regular_linear_placement.h>

Inheritance diagram for geomtools::regular_linear_placement:

Public Types
enum	axis_t { REPLICANT_AXIS_NONE = -1, REPLICANT_AXIS_X = 0, REPLICANT_AXIS_Y = 1, REPLICANT_AXIS_Z = 2 }
	Type of the replication axis. 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
virtual size_t	get_dimension () const
virtual bool	is_replica () const
	Check if the placement is a replica (GDML/Geant4 concept for multiple placement objects) More...
virtual bool	has_only_one_rotation () const
	Check if the placement is based on one unique rotation. More...
void	set_replicant_axis (int)
int	get_replicant_axis () const
bool	is_replicant_x_axis () const
bool	is_replicant_y_axis () const
bool	is_replicant_z_axis () const
bool	is_valid () const
void	invalidate ()
void	set_replicant_step_x (double x_)
void	set_replicant_step_y (double y_)
void	set_replicant_step_z (double z_)
void	set_step (double x_, double y_, double z_)
void	set_step (const vector_3d &step_)
const vector_3d &	get_step () const
void	set_basic_placement (const placement &bp_)
const placement &	get_basic_placement () const
placement &	get_basic_placement ()
void	set_number_of_items (size_t n_)
virtual size_t	get_number_of_items () const
	Return the number of placement items. More...
virtual void	get_placement (int item_, placement &p_) const
	Compute the placement at given item rank/index. More...
virtual size_t	compute_index_map (std::vector< uint32_t > &map_, int item_) const
	Compute an array of indexes in a multidimensional frame from the item rank/index. More...
	regular_linear_placement ()
	Default constructor. More...
	regular_linear_placement (const placement &basic_placement_, const vector_3d &step_, size_t number_of_items_)
	Constructor. More...
	regular_linear_placement (const placement &basic_placement_, double step_, size_t number_of_items_, int replicant_axis_=REPLICANT_AXIS_NONE)
	Constructor. More...
virtual	~regular_linear_placement ()
	Destructor. More...
void	init (const placement &basic_placement_, const vector_3d &step_, size_t number_of_items_)
	Initialization. More...
void	init (const placement &basic_placement_, double step_, size_t number_of_items_, int replicant_axis_=REPLICANT_AXIS_X)
	Initialization. More...
virtual void	reset ()
	Reset. 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_placement
	i_placement ()
	Default constructor. More...
virtual	~i_placement ()
	Destructor. More...
bool	is_multiple () const
	Check if the placement handles multiple positions. More...
placement	get_placement (int item_) const
	Return the placement at given item rank/index. More...
placement	get_placement_by_index (int item_) const
	Same as get_placement(int) but workaround method overloading for CAMP. More...
void	compute_placement (int item_, placement &p_) const
	Compute the placement at given item rank/index. More...
Public Member Functions inherited from datatools::i_serializable
	i_serializable ()
	Default constructor. More...
virtual	~i_serializable ()
	Destructor. More...
virtual const std::string &	get_serial_tag () const =0
	Return the serialization string identifier of the class. 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

Additional Inherited Members
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_)

Detailed Description

Regular linear placement.

Member Enumeration Documentation

axis_t

enum geomtools::regular_linear_placement::axis_t

Type of the replication axis.

Enumerator
REPLICANT_AXIS_NONE
REPLICANT_AXIS_X
REPLICANT_AXIS_Y
REPLICANT_AXIS_Z

Constructor & Destructor Documentation

regular_linear_placement() [1/3]

geomtools::regular_linear_placement::regular_linear_placement

(

)

Default constructor.

regular_linear_placement() [2/3]

geomtools::regular_linear_placement::regular_linear_placement	(	const placement &	basic_placement_,
		const vector_3d &	step_,
		size_t	number_of_items_
	)

Constructor.

regular_linear_placement() [3/3]

geomtools::regular_linear_placement::regular_linear_placement	(	const placement &	basic_placement_,
		double	step_,
		size_t	number_of_items_,
		int	replicant_axis_ = REPLICANT_AXIS_NONE
	)

Constructor.

~regular_linear_placement()

virtual geomtools::regular_linear_placement::~regular_linear_placement ( )

virtual

Destructor.

Member Function Documentation

compute_index_map()

virtual size_t geomtools::regular_linear_placement::compute_index_map ( std::vector< uint32_t > &  map_, int  item_  ) const

virtual

Compute an array of indexes in a multidimensional frame from the item rank/index.

Implements geomtools::i_placement.

get_basic_placement() [1/2]

const placement& geomtools::regular_linear_placement::get_basic_placement

(

)

const

get_basic_placement() [2/2]

placement& geomtools::regular_linear_placement::get_basic_placement

(

)

get_dimension()

virtual size_t geomtools::regular_linear_placement::get_dimension ( ) const

virtual

Return the dimension of the placement object

A single unique placement is of dimension 0 A multiple placement replicated along a given axis is of dimension 0 A multiple placement replicated along a 2D mesh addresses by X-Y grid coordinates is of dimension 2

Implements geomtools::i_placement.

get_number_of_items()

virtual size_t geomtools::regular_linear_placement::get_number_of_items ( ) const

virtual

Return the number of placement items.

Implements geomtools::i_placement.

get_placement()

virtual void geomtools::regular_linear_placement::get_placement ( int  item_, placement &  p_  ) const

virtual

Compute the placement at given item rank/index.

Implements geomtools::i_placement.

get_replicant_axis()

int geomtools::regular_linear_placement::get_replicant_axis

(

)

const

get_step()

const vector_3d& geomtools::regular_linear_placement::get_step

(

)

const

has_only_one_rotation()

virtual bool geomtools::regular_linear_placement::has_only_one_rotation ( ) const

virtual

Check if the placement is based on one unique rotation.

Reimplemented from geomtools::i_placement.

init() [1/2]

void geomtools::regular_linear_placement::init	(	const placement &	basic_placement_,
		const vector_3d &	step_,
		size_t	number_of_items_
	)

Initialization.

init() [2/2]

void geomtools::regular_linear_placement::init	(	const placement &	basic_placement_,
		double	step_,
		size_t	number_of_items_,
		int	replicant_axis_ = REPLICANT_AXIS_X
	)

Initialization.

invalidate()

void geomtools::regular_linear_placement::invalidate

(

)

is_replica()

virtual bool geomtools::regular_linear_placement::is_replica ( ) const

virtual

Check if the placement is a replica (GDML/Geant4 concept for multiple placement objects)

Implements geomtools::i_placement.

is_replicant_x_axis()

bool geomtools::regular_linear_placement::is_replicant_x_axis

(

)

const

is_replicant_y_axis()

bool geomtools::regular_linear_placement::is_replicant_y_axis

(

)

const

is_replicant_z_axis()

bool geomtools::regular_linear_placement::is_replicant_z_axis

(

)

const

is_valid()

bool geomtools::regular_linear_placement::is_valid

(

)

const

reset()

virtual void geomtools::regular_linear_placement::reset ( )

virtual

Reset.

set_basic_placement()

void geomtools::regular_linear_placement::set_basic_placement

(

const placement &

bp_

)

set_number_of_items()

void geomtools::regular_linear_placement::set_number_of_items

(

size_t

n_

)

set_replicant_axis()

void geomtools::regular_linear_placement::set_replicant_axis

(

int

)

set_replicant_step_x()

void geomtools::regular_linear_placement::set_replicant_step_x

(

double

x_

)

set_replicant_step_y()

void geomtools::regular_linear_placement::set_replicant_step_y

(

double

y_

)

set_replicant_step_z()

void geomtools::regular_linear_placement::set_replicant_step_z

(

double

z_

)

set_step() [1/2]

void geomtools::regular_linear_placement::set_step	(	double	x_,
		double	y_,
		double	z_
	)

set_step() [2/2]

void geomtools::regular_linear_placement::set_step

(

const vector_3d &

step_

)

tree_dump()

virtual void geomtools::regular_linear_placement::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_placement.

---

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

• bayeux/geomtools/regular_linear_placement.h