BaseVGM::VPlacement Class Reference

The abstract base class to positions of volumes. More...

#include <VPlacement.h>

Inheritance diagram for BaseVGM::VPlacement:

Public Member Functions
	VPlacement (VGM::IVolume *volume, VGM::IVolume *motherVolume)
virtual	~VPlacement ()
virtual std::string	Name () const =0
	Return the name of this placement.
virtual VGM::IVolume *	Volume () const
	Return the associated volume.
virtual VGM::IVolume *	Mother () const
	Return the associated mother volume.
virtual int	CopyNo () const =0
	Return the copy number of this placement.
virtual VGM::Transform	Transformation () const =0
	Return the 3D transformation (if simple placement)
virtual bool	MultiplePlacementData (VGM::Axis &axis, int &nofDivisions, double &width, double &offset, double &halfGap) const =0
	Fill the multiple placement data if relevant and return true; return false if not multiple placement.
virtual std::ostream &	Put (std::ostream &out) const
	Put the printing of the placement parameters in the out stream.
void	SetVolume (VGM::IVolume *volume)
Public Member Functions inherited from VGM::IPlacement
virtual	~IPlacement ()
virtual PlacementType	Type () const =0
	Return the type of this placement.
virtual bool	ParameterisedPlacementData (std::vector< VGM::Transform > &transforms, std::vector< VGM::IVolume * > &volumes) const =0
	Fill the parameterised placement data if relevant and return true; return false if not parameterised placement.

Protected Member Functions
	VPlacement ()
	VPlacement (const VPlacement &rhs)

Detailed Description

The abstract base class to positions of volumes.

Author

Ivana Hrivnacova; IPN Orsay

Definition at line 31 of file VPlacement.h.

Constructor & Destructor Documentation

VPlacement() [1/3]

BaseVGM::VPlacement::VPlacement	(	VGM::IVolume *	volume,
		VGM::IVolume *	motherVolume )

Standard constructor

Definition at line 27 of file VPlacement.cxx.

~VPlacement()

BaseVGM::VPlacement::~VPlacement ( )

virtual

Definition at line 55 of file VPlacement.cxx.

VPlacement() [2/3]

BaseVGM::VPlacement::VPlacement ( )

protected

Protected default constructor

Definition at line 43 of file VPlacement.cxx.

VPlacement() [3/3]

BaseVGM::VPlacement::VPlacement ( const VPlacement & rhs )

protected

Protected copy constructor

Definition at line 49 of file VPlacement.cxx.

Member Function Documentation

Name()

virtual std::string BaseVGM::VPlacement::Name ( ) const

pure virtual

Return the name of this placement.

Implements VGM::IPlacement.

Implemented in Geant4GM::Placement, and RootGM::Placement.

Volume()

VGM::IVolume * BaseVGM::VPlacement::Volume ( ) const

virtual

Return the associated volume.

Implements VGM::IPlacement.

Definition at line 61 of file VPlacement.cxx.

Mother()

VGM::IVolume * BaseVGM::VPlacement::Mother ( ) const

virtual

Return the associated mother volume.

Implements VGM::IPlacement.

Definition at line 68 of file VPlacement.cxx.

CopyNo()

virtual int BaseVGM::VPlacement::CopyNo ( ) const

pure virtual

Return the copy number of this placement.

Implements VGM::IPlacement.

Implemented in Geant4GM::Placement, and RootGM::Placement.

Transformation()

virtual VGM::Transform BaseVGM::VPlacement::Transformation ( ) const

pure virtual

Return the 3D transformation (if simple placement)

Implements VGM::IPlacement.

Implemented in Geant4GM::Placement, and RootGM::Placement.

MultiplePlacementData()

virtual bool BaseVGM::VPlacement::MultiplePlacementData ( VGM::Axis & axis, int & nofItems, double & width, double & offset, double & halfGap ) const

pure virtual

Fill the multiple placement data if relevant and return true; return false if not multiple placement.

Implements VGM::IPlacement.

Implemented in Geant4GM::Placement, and RootGM::Placement.

Put()

std::ostream & BaseVGM::VPlacement::Put ( std::ostream & out ) const

virtual

Put the printing of the placement parameters in the out stream.

Implements VGM::IPlacement.

Definition at line 75 of file VPlacement.cxx.

SetVolume()

void BaseVGM::VPlacement::SetVolume

(

VGM::IVolume *

volume

)

Set the associated volume (Needed in a special case when a volume is created only when it is being placed)

Definition at line 112 of file VPlacement.cxx.

---

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

• packages/BaseVGM/include/BaseVGM/volumes/VPlacement.h
• packages/BaseVGM/source/volumes/VPlacement.cxx