VGM::IPlacement Class Reference

The VGM interface to positions of volumes. More...

#include <IPlacement.h>

Inheritance diagram for VGM::IPlacement:

Public Member Functions
virtual	~IPlacement ()
virtual PlacementType	Type () const =0
	Return the type of this placement.
virtual std::string	Name () const =0
	Return the name of this placement.
virtual IVolume *	Volume () const =0
	Return the associated volume.
virtual IVolume *	Mother () const =0
	Return the associated mother volume.
virtual int	CopyNo () const =0
	Return the copy number of this placement.
virtual Transform	Transformation () const =0
	Return the 3D transformation (if simple placement)
virtual bool	MultiplePlacementData (VGM::Axis &axis, int &nofItems, 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 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.
virtual std::ostream &	Put (std::ostream &out) const =0
	Put the printing of the placement parameters in the out stream.

Detailed Description

The VGM interface to positions of volumes.

Author

Ivana Hrivnacova; IPN Orsay

Definition at line 43 of file IPlacement.h.

Constructor & Destructor Documentation

~IPlacement()

virtual VGM::IPlacement::~IPlacement ( )

inlinevirtual

Definition at line 46 of file IPlacement.h.

Member Function Documentation

Type()

virtual PlacementType VGM::IPlacement::Type ( ) const

pure virtual

Return the type of this placement.

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

Name()

virtual std::string VGM::IPlacement::Name ( ) const

pure virtual

Return the name of this placement.

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

Volume()

virtual IVolume * VGM::IPlacement::Volume ( ) const

pure virtual

Return the associated volume.

Implemented in BaseVGM::VPlacement.

Mother()

virtual IVolume * VGM::IPlacement::Mother ( ) const

pure virtual

Return the associated mother volume.

Implemented in BaseVGM::VPlacement.

CopyNo()

virtual int VGM::IPlacement::CopyNo ( ) const

pure virtual

Return the copy number of this placement.

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

Transformation()

virtual Transform VGM::IPlacement::Transformation ( ) const

pure virtual

Return the 3D transformation (if simple placement)

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

MultiplePlacementData()

virtual bool VGM::IPlacement::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.

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

ParameterisedPlacementData()

virtual bool VGM::IPlacement::ParameterisedPlacementData ( std::vector< VGM::Transform > & transforms, std::vector< VGM::IVolume * > & volumes ) const

pure virtual

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

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

Put()

virtual std::ostream & VGM::IPlacement::Put ( std::ostream & out ) const

pure virtual

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

Implemented in BaseVGM::VPlacement.

---

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

• packages/VGM/include/VGM/volumes/IPlacement.h