Data structure resulting of the logical_volume::locate method. More...

#include <bayeux/geomtools/logical_volume.h>

Public Member Functions
	locate_result ()
	Constructor. More...

void	reset ()
	Reset. More...

void	dump (std::ostream &out_=std::clog, const std::string &indent_="") const
	Basic print. More...

void	set_shape_domain_flags (uint32_t)
	Set the shape domain flags. More...

void	set_daughter_name (const std::string &)
	Set the daughter name. More...

void	set_daughter (const physical_volume &)
	Set the daughter physical volume. More...

void	set_daughter_placement_index (int)
	Set the daughter physical volume's placement index. More...

void	set_position_in_daughter (const vector_3d &)
	Set the position in the reference frame of the daughter volume. More...

uint32_t	get_shape_domain_flags () const
	Return the shape domain flags. More...

bool	has_daughter () const
	Check if a daughter is available. More...

const std::string &	get_daughter_name () const
	Set the daughter name. More...

const physical_volume &	get_daughter () const
	Return a const reference to the daughter. More...

bool	has_daughter_placement_index () const
	Check if the daughter placement index is set. More...

int	get_daughter_placement_index () const
	Return the daughter physical volume's placement index. More...

bool	has_position_in_daughter () const
	Check if the position in the reference frame of the daughter volume is available. More...

const vector_3d &	get_position_in_daughter () const
	Return the position in the reference frame of the daughter volume. More...

Detailed Description

Data structure resulting of the logical_volume::locate method.

Constructor & Destructor Documentation

◆ locate_result()

geomtools::logical_volume::locate_result::locate_result ( )

Constructor.

Member Function Documentation

◆ dump()

void geomtools::logical_volume::locate_result::dump	(	std::ostream &	out_ = `std::clog`,
		const std::string &	indent_ = `""`
	)		const

Basic print.

◆ get_daughter()

const physical_volume& geomtools::logical_volume::locate_result::get_daughter ( ) const

Return a const reference to the daughter.

◆ get_daughter_name()

const std::string& geomtools::logical_volume::locate_result::get_daughter_name ( ) const

Set the daughter name.

◆ get_daughter_placement_index()

int geomtools::logical_volume::locate_result::get_daughter_placement_index ( ) const

Return the daughter physical volume's placement index.

◆ get_position_in_daughter()

const vector_3d& geomtools::logical_volume::locate_result::get_position_in_daughter ( ) const

Return the position in the reference frame of the daughter volume.

◆ get_shape_domain_flags()

uint32_t geomtools::logical_volume::locate_result::get_shape_domain_flags ( ) const

Return the shape domain flags.

◆ has_daughter()

bool geomtools::logical_volume::locate_result::has_daughter ( ) const

Check if a daughter is available.

◆ has_daughter_placement_index()

bool geomtools::logical_volume::locate_result::has_daughter_placement_index ( ) const

Check if the daughter placement index is set.

◆ has_position_in_daughter()

bool geomtools::logical_volume::locate_result::has_position_in_daughter ( ) const

Check if the position in the reference frame of the daughter volume is available.

◆ reset()

void geomtools::logical_volume::locate_result::reset ( )

Reset.

◆ set_daughter()

void geomtools::logical_volume::locate_result::set_daughter ( const physical_volume & )

Set the daughter physical volume.

◆ set_daughter_name()

void geomtools::logical_volume::locate_result::set_daughter_name ( const std::string & )

Set the daughter name.

◆ set_daughter_placement_index()

void geomtools::logical_volume::locate_result::set_daughter_placement_index ( int )

Set the daughter physical volume's placement index.

◆ set_position_in_daughter()

void geomtools::logical_volume::locate_result::set_position_in_daughter ( const vector_3d & )

Set the position in the reference frame of the daughter volume.

◆ set_shape_domain_flags()

void geomtools::logical_volume::locate_result::set_shape_domain_flags ( uint32_t )

Set the shape domain flags.

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

bayeux/geomtools/logical_volume.h

Public Member Functions