#include <BoxEnvelope.h>

Inheritance diagram for BoxEnvelope:

Collaboration diagram for BoxEnvelope:

Public Member Functions
	BoxEnvelope (const std::string &type, const std::string &name, const IInterface *parent)
	Basic constructor and destructor. More...

	~BoxEnvelope ()=default

virtual void	BuildGeometry () override final
	virtual methods being implemented here More...

StatusCode	initialize () override
	Athena method. More...

virtual void	Build () override
	purely virtual methods being implemented here More...

virtual void	PositionInParent () override

virtual void	SetRotationAndOffset ()

virtual void	BuildSubDetectors () override

virtual void	SetEnvelope () override

virtual void	ResetEnvelope () override

virtual void	SetAsWorld () override

std::string	GetDetectorName () const override

void	SetDetectorName (const std::string &) override

void	SetParent (IDetectorGeometryTool *) override

Envelope &	GetEnvelope () override final

G4VPhysicalVolume *	GetWorldVolume () override final

Protected Attributes
ToolHandleArray< IDetectorGeometryTool >	m_subDetTools {this, "SubDetectors", {}, "Tool handle array of all subdetector tools"}

ServiceHandle< IG4GeometryNotifierSvc >	m_notifierSvc {this, "GeometryNotifierSvc", "G4GeometryNotifierSvc", "Detector name (same as the Tool name if not set"}

IDetectorGeometryTool *	m_theParent {}

Envelope	m_envelope

Gaudi::Property< std::string >	m_detectorName {this, "DetectorName", "", "Detector name (same as the Tool name if not set"}

bool	m_isWorld {false}

Gaudi::Property< double >	m_rotateX {this, "RotateX" , 0.0, "Rotation around the X-axis"}

Gaudi::Property< double >	m_rotateY {this, "RotateY" , 0.0, "Rotation around the Y-axis"}

Gaudi::Property< double >	m_rotateZ {this, "RotateZ" , 0.0, "Rotation around the Z-axis"}

Gaudi::Property< double >	m_offsetX {this, "OffsetX" , 0.0, "Offset in the X-direction"}

Gaudi::Property< double >	m_offsetY {this, "OffsetY" , 0.0, "Offset in the Y-direction"}

Gaudi::Property< double >	m_offsetZ {this, "OffsetZ" , 0.0, "Offset in the Z-direction"}

Private Attributes
Gaudi::Property< double >	m_dX {this, "dX", 0., "Envelope dX"}

Gaudi::Property< double >	m_dY {this, "dY", 0., "Envelope dY"}

Gaudi::Property< double >	m_dZ {this, "dZ", 0., "Envelope dZ"}

Gaudi::Property< std::string >	m_materialName {this, "Material", "Air", "Envelope Material"}

Gaudi::Property< unsigned int >	m_numberOfHoles {this, "NumberOfHoles", 0, "Number of hole volumes to subtract from the initial envelope volume."}

Gaudi::Property< std::vector< std::string > >	m_holeNames {this, "HoleNames", {} }

Gaudi::Property< std::vector< double > >	m_hole_dX {this, "Hole_dX", {} }

Gaudi::Property< std::vector< double > >	m_hole_dY {this, "Hole_dY", {} }

Gaudi::Property< std::vector< double > >	m_hole_dZ {this, "Hole_dZ", {} }

Gaudi::Property< std::vector< double > >	m_holePosX {this, "HolePosX", {} }

Gaudi::Property< std::vector< double > >	m_holePosY {this, "HolePosY", {} }

Gaudi::Property< std::vector< double > >	m_holePosZ {this, "HolePosZ", {} }

Detailed Description

Todo:: TODO needs documentation

Definition at line 20 of file BoxEnvelope.h.

Constructor & Destructor Documentation

◆ BoxEnvelope()

BoxEnvelope::BoxEnvelope	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Basic constructor and destructor.

Definition at line 18 of file BoxEnvelope.cxx.

   : DetectorGeometryBase(type,name,parent)
 {
 }

◆ ~BoxEnvelope()

BoxEnvelope::~BoxEnvelope ( )

default

Member Function Documentation

◆ Build()

void DetectorGeometryBase::Build ( )

overridevirtualinherited

purely virtual methods being implemented here

Definition at line 53 of file DetectorGeometryBase.cxx.

 {
   ATH_MSG_VERBOSE( name() << "::Build() (Base class method): Starting. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
   
   SetEnvelope();
   ATH_MSG_VERBOSE( name() << "::Build() - Envelope set. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
  
   m_notifierSvc->SetCurrentDetectorName(m_detectorName.value());
   BuildGeometry();
   ATH_MSG_VERBOSE( name() << "::Build() - Geometry built. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
  
   SetRotationAndOffset();
   ATH_MSG_VERBOSE( name() << "::Build() - Volume moved around. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
  
   PositionInParent();
   ATH_MSG_VERBOSE( name() << "::Build() - Connected with parent. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
  
   BuildSubDetectors();
   ATH_MSG_VERBOSE( name() << "::Build() (Base class method): Finished. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
   return;
 }

◆ BuildGeometry()

void BoxEnvelope::BuildGeometry ( )

finaloverridevirtual

virtual methods being implemented here

Reimplemented from DetectorGeometryBase.

Definition at line 23 of file BoxEnvelope.cxx.

 {
   ATH_MSG_VERBOSE( "BoxEnvelope::BuildGeometry: Name " << this->name() );
   ATH_MSG_VERBOSE( "BoxEnvelope::BuildGeometry: "<<m_dX<<" "<<m_dY<<" "<<m_dZ );
  
   // Get nist material manager
   G4NistManager *nist = G4NistManager::Instance();
  
   G4Material *mat = nist->FindOrBuildMaterial(m_materialName.value());
  
   G4VSolid *solid = new G4Box(m_detectorName.value(),m_dX,m_dY,m_dZ);
   if (m_numberOfHoles)
     {
       if(m_holeNames.size() != m_numberOfHoles)
         {
           ATH_MSG_ERROR("Size of m_holeNames("<<m_holeNames.size()<<") differs from no. of holes "<<m_numberOfHoles<<"!!!");
         }
       if(m_hole_dX.size() != m_numberOfHoles)
         {
           ATH_MSG_ERROR("Size of m_hole_dX("<<m_hole_dX.size()<<") differs from no. of holes "<<m_numberOfHoles<<"!!!");
         }
       if(m_hole_dY.size() != m_numberOfHoles)
         {
           ATH_MSG_ERROR("Size of m_hole_dY("<<m_hole_dY.size()<<") differs from no. of holes "<<m_numberOfHoles<<"!!!");
         }
       if(m_hole_dZ.size() != m_numberOfHoles)
         {
           ATH_MSG_ERROR("Size of m_hole_dZ("<<m_hole_dZ.size()<<") differs from no. of holes "<<m_numberOfHoles<<"!!!");
         }
       if(m_holePosX.size() != m_numberOfHoles)
         {
           ATH_MSG_ERROR("Size of m_holePosX("<<m_holePosX.size()<<") differs from no. of holes "<<m_numberOfHoles<<"!!!");
         }
       if(m_holePosY.size() != m_numberOfHoles)
         {
           ATH_MSG_ERROR("Size of m_holePosY("<<m_holePosY.size()<<") differs from no. of holes "<<m_numberOfHoles<<"!!!");
         }
       if(m_holePosZ.size() != m_numberOfHoles)
         {
           ATH_MSG_ERROR("Size of m_holePosZ("<<m_holePosZ.size()<<") differs from no. of holes "<<m_numberOfHoles<<"!!!");
         }
       for(unsigned int nSub(0); nSub<m_numberOfHoles; ++nSub)
         {
           G4ThreeVector size=G4ThreeVector();
           std::string n=m_holeNames.value().at(nSub);
           G4VSolid *temp=new G4Box("",m_hole_dX.value().at(nSub), m_hole_dY.value().at(nSub), m_hole_dZ.value().at(nSub));
           G4ThreeVector tPos=G4ThreeVector(m_holePosX.value().at(nSub), m_holePosY.value().at(nSub), m_holePosZ.value().at(nSub));
           solid=new G4SubtractionSolid(m_detectorName.value(),solid,temp,0,tPos);
         }
     }
  
   G4LogicalVolume* logicWorld = new G4LogicalVolume(solid,mat,m_detectorName.value());
  
   m_envelope.theEnvelope=logicWorld;
 }

◆ BuildSubDetectors()

void DetectorGeometryBase::BuildSubDetectors ( )

overridevirtualinherited

Definition at line 155 of file DetectorGeometryBase.cxx.

 {
   ATH_MSG_VERBOSE( name() << "::BuildSubDetectors() (Base class method): Starting");
   for (auto& subDetTool: m_subDetTools)
     {
       ATH_MSG_VERBOSE(name() << "::BuildSubDetectors() (Base class method):  Positioning "<<subDetTool->GetDetectorName()<<" within "<<m_detectorName.value());
       subDetTool->SetParent(this);
       subDetTool->Build();
     }
   ATH_MSG_VERBOSE( name() << "::BuildSubDetectors() (Base class method): Finished");
 }

◆ GetDetectorName()

std::string DetectorGeometryBase::GetDetectorName ( ) const

overrideinherited

Definition at line 180 of file DetectorGeometryBase.cxx.

 {
   return m_detectorName.value();
 }

◆ GetEnvelope()

Envelope & DetectorGeometryBase::GetEnvelope ( )

finaloverrideinherited

Definition at line 195 of file DetectorGeometryBase.cxx.

 {
   return m_envelope;
 }

◆ GetWorldVolume()

G4VPhysicalVolume * DetectorGeometryBase::GetWorldVolume ( )

finaloverrideinherited

Definition at line 200 of file DetectorGeometryBase.cxx.

 {
   if (m_isWorld)
     return m_envelope.thePositionedVolume;
   else
     {
       ATH_MSG_ERROR("trying to get World from a DetectorTool which World is not!");
       return 0;
     }
 }

◆ initialize()

StatusCode DetectorGeometryBase::initialize ( )

overrideinherited

Athena method.

called at initialization time, being customized here

Definition at line 19 of file DetectorGeometryBase.cxx.

 {
   ATH_MSG_VERBOSE( name() << "::initialize(): starting." );
   if(m_detectorName.empty())
     {
       m_detectorName = this->name();
       // re-initialize m_detectorName in order to take the real detector name rather than the path to it
       size_t ipos=m_detectorName.value().find_last_of('.');
       size_t length=m_detectorName.value().size();
       if (ipos<length)
         {
           ATH_MSG_VERBOSE( "m_detectorName: " << m_detectorName.value() << " needs to be reset.");
           m_detectorName=m_detectorName.value().substr(ipos+1,length-ipos-1);
           ATH_MSG_VERBOSE( "m_detectorName default value reset to " << m_detectorName.value());
         }
     }
   ATH_MSG_DEBUG( name() << "::initialize() (Base class method): Detector name = " << m_detectorName.value() );
   CHECK(m_notifierSvc.retrieve());
  
   //  This fires initialize() for each of those tools
   if (m_subDetTools.size())
     {
       ATH_MSG_DEBUG( name() << "::initialize(): Initializing list of " << m_subDetTools.size() << " detectors." );
       CHECK( m_subDetTools.retrieve() );
     }
   else
     {
       ATH_MSG_DEBUG( name() << "::initialize(): no sub-detectors to initialize." );
     }
  
   ATH_MSG_VERBOSE( name() << "::initialize(): finished." );
   return StatusCode::SUCCESS;
 }

◆ PositionInParent()

void DetectorGeometryBase::PositionInParent ( )

overridevirtualinherited

Reimplemented in GeoDetectorTool.

Definition at line 120 of file DetectorGeometryBase.cxx.

 {
   ATH_MSG_VERBOSE( name() << "::PositionInParent() (Base class method)");
   if (m_isWorld)
     {
       // check that the detector is built
       if (m_envelope.IsBuilt())
         {
           G4VPhysicalVolume* physWorld= new G4PVPlacement(0,G4ThreeVector(),
                                                           m_envelope.theEnvelope,m_envelope.theEnvelope->GetName(),0,false,0,false);
           m_envelope.thePositionedVolume=physWorld;
         }
     }
   else
     {
       // check that there is a parent
       if (!m_theParent)
         {
           ATH_MSG_ERROR("Parent not set for "<<m_detectorName.value()<<"!!!!!!!!!!");
         }
       else
         {
           if (m_theParent->GetEnvelope().IsBuilt())
             {
               // G4VPhysicalVolume *physVol = new G4PVPlacement(0,G4ThreeVector(),
               //                                                m_envelope.theEnvelope,m_envelope.theEnvelope->GetName(),m_theParent->GetEnvelope().theEnvelope,false,0,false);
               // TODO: implement a possible rotation/displacement - something like this based on the old code?
               G4VPhysicalVolume *physVol = new G4PVPlacement(m_envelope.theRotation,m_envelope.thePosition,
                                                              m_envelope.theEnvelope,m_envelope.theEnvelope->GetName(),m_theParent->GetEnvelope().theEnvelope,false,0);
               m_envelope.thePositionedVolume=physVol;
             }
         }
     }
 }

◆ ResetEnvelope()

void DetectorGeometryBase::ResetEnvelope ( )

overridevirtualinherited

Definition at line 171 of file DetectorGeometryBase.cxx.

172 {

173 }

◆ SetAsWorld()

void DetectorGeometryBase::SetAsWorld ( )

overridevirtualinherited

Definition at line 185 of file DetectorGeometryBase.cxx.

 {
   m_isWorld=true;
 }

◆ SetDetectorName()

void DetectorGeometryBase::SetDetectorName ( const std::string & s )

overrideinherited

Definition at line 175 of file DetectorGeometryBase.cxx.

 {
   m_detectorName=s;
 }

◆ SetEnvelope()

void DetectorGeometryBase::SetEnvelope ( )

overridevirtualinherited

Definition at line 167 of file DetectorGeometryBase.cxx.

168 {

169 }

◆ SetParent()

void DetectorGeometryBase::SetParent ( IDetectorGeometryTool * p )

overrideinherited

Definition at line 190 of file DetectorGeometryBase.cxx.

 {
   m_theParent=p;
 }

◆ SetRotationAndOffset()

void DetectorGeometryBase::SetRotationAndOffset ( )

virtualinherited

Definition at line 80 of file DetectorGeometryBase.cxx.

 {
   ATH_MSG_VERBOSE( name() << "::SetRotationAndOffset() (Base class method)");
   // Firstly do the rotation
   if (!m_envelope.theRotation)
     {
       // m_envelope.theRotation is null, so create an identity
       // rotation first.
       // FIXME probably a neater way to do this part.
       m_envelope.theRotation=new G4RotationMatrix;
       // add the extra rotations.
       m_envelope.theRotation->rotateX(m_rotateX);
       m_envelope.theRotation->rotateY(m_rotateY);
       m_envelope.theRotation->rotateZ(m_rotateZ);
       if (m_envelope.thePositionedVolume)
         {
           // Override the rotation for m_envelope.thePositionedVolume.
           m_envelope.thePositionedVolume->SetRotation(m_envelope.theRotation);
         }
     }
   else
     {
       // m_envelope.theRotation already exists, so just add the
       // extra rotations.
       m_envelope.theRotation->rotateX(m_rotateX);
       m_envelope.theRotation->rotateY(m_rotateY);
       m_envelope.theRotation->rotateZ(m_rotateZ);
     }
   // Secondly add the additional position offset to the existing
   // m_envelope.thePosition vector.
   m_envelope.thePosition+=G4ThreeVector(m_offsetX,m_offsetY,m_offsetZ);
   if (m_envelope.thePositionedVolume)
     {
       // Override the translation for m_envelope.thePositionedVolume.
       m_envelope.thePositionedVolume->SetTranslation(m_envelope.thePosition);
     }
  
   ATH_MSG_VERBOSE( name() << "::SetRotationAndOffset() (Base class method): Finished" );
   return;
 }

Member Data Documentation

◆ m_detectorName

Gaudi::Property<std::string> DetectorGeometryBase::m_detectorName {this, "DetectorName", "", "Detector name (same as the Tool name if not set"}

protectedinherited

Definition at line 71 of file DetectorGeometryBase.h.

◆ m_dX

Gaudi::Property<double> BoxEnvelope::m_dX {this, "dX", 0., "Envelope dX"}

private

Definition at line 32 of file BoxEnvelope.h.

◆ m_dY

Gaudi::Property<double> BoxEnvelope::m_dY {this, "dY", 0., "Envelope dY"}

private

Definition at line 33 of file BoxEnvelope.h.

◆ m_dZ

Gaudi::Property<double> BoxEnvelope::m_dZ {this, "dZ", 0., "Envelope dZ"}

private

Definition at line 34 of file BoxEnvelope.h.

◆ m_envelope

Envelope DetectorGeometryBase::m_envelope

protectedinherited

Definition at line 70 of file DetectorGeometryBase.h.

◆ m_hole_dX

Gaudi::Property<std::vector<double> > BoxEnvelope::m_hole_dX {this, "Hole_dX", {} }

private

Definition at line 38 of file BoxEnvelope.h.

◆ m_hole_dY

Gaudi::Property<std::vector<double> > BoxEnvelope::m_hole_dY {this, "Hole_dY", {} }

private

Definition at line 39 of file BoxEnvelope.h.

◆ m_hole_dZ

Gaudi::Property<std::vector<double> > BoxEnvelope::m_hole_dZ {this, "Hole_dZ", {} }

private

Definition at line 40 of file BoxEnvelope.h.

◆ m_holeNames

Gaudi::Property<std::vector<std::string> > BoxEnvelope::m_holeNames {this, "HoleNames", {} }

private

Definition at line 37 of file BoxEnvelope.h.

◆ m_holePosX

Gaudi::Property<std::vector<double> > BoxEnvelope::m_holePosX {this, "HolePosX", {} }

private

Definition at line 41 of file BoxEnvelope.h.

◆ m_holePosY

Gaudi::Property<std::vector<double> > BoxEnvelope::m_holePosY {this, "HolePosY", {} }

private

Definition at line 42 of file BoxEnvelope.h.

◆ m_holePosZ

Gaudi::Property<std::vector<double> > BoxEnvelope::m_holePosZ {this, "HolePosZ", {} }

private

Definition at line 43 of file BoxEnvelope.h.

◆ m_isWorld

bool DetectorGeometryBase::m_isWorld {false}

protectedinherited

Definition at line 72 of file DetectorGeometryBase.h.

◆ m_materialName

Gaudi::Property<std::string> BoxEnvelope::m_materialName {this, "Material", "Air", "Envelope Material"}

private

Definition at line 35 of file BoxEnvelope.h.

◆ m_notifierSvc

ServiceHandle<IG4GeometryNotifierSvc> DetectorGeometryBase::m_notifierSvc {this, "GeometryNotifierSvc", "G4GeometryNotifierSvc", "Detector name (same as the Tool name if not set"}

protectedinherited

Definition at line 66 of file DetectorGeometryBase.h.

◆ m_numberOfHoles

Gaudi::Property<unsigned int> BoxEnvelope::m_numberOfHoles {this, "NumberOfHoles", 0, "Number of hole volumes to subtract from the initial envelope volume."}

private

Definition at line 36 of file BoxEnvelope.h.

◆ m_offsetX

Gaudi::Property<double> DetectorGeometryBase::m_offsetX {this, "OffsetX" , 0.0, "Offset in the X-direction"}

protectedinherited

Definition at line 76 of file DetectorGeometryBase.h.

◆ m_offsetY

Gaudi::Property<double> DetectorGeometryBase::m_offsetY {this, "OffsetY" , 0.0, "Offset in the Y-direction"}

protectedinherited

Definition at line 77 of file DetectorGeometryBase.h.

◆ m_offsetZ

Gaudi::Property<double> DetectorGeometryBase::m_offsetZ {this, "OffsetZ" , 0.0, "Offset in the Z-direction"}

protectedinherited

Definition at line 78 of file DetectorGeometryBase.h.

◆ m_rotateX

Gaudi::Property<double> DetectorGeometryBase::m_rotateX {this, "RotateX" , 0.0, "Rotation around the X-axis"}

protectedinherited

Definition at line 73 of file DetectorGeometryBase.h.

◆ m_rotateY

Gaudi::Property<double> DetectorGeometryBase::m_rotateY {this, "RotateY" , 0.0, "Rotation around the Y-axis"}

protectedinherited

Definition at line 74 of file DetectorGeometryBase.h.

◆ m_rotateZ

Gaudi::Property<double> DetectorGeometryBase::m_rotateZ {this, "RotateZ" , 0.0, "Rotation around the Z-axis"}

protectedinherited

Definition at line 75 of file DetectorGeometryBase.h.

◆ m_subDetTools

ToolHandleArray<IDetectorGeometryTool> DetectorGeometryBase::m_subDetTools {this, "SubDetectors", {}, "Tool handle array of all subdetector tools"}

protectedinherited

Definition at line 64 of file DetectorGeometryBase.h.

◆ m_theParent

IDetectorGeometryTool* DetectorGeometryBase::m_theParent {}

protectedinherited

Definition at line 68 of file DetectorGeometryBase.h.

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

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BoxEnvelope()

◆ ~BoxEnvelope()

Member Function Documentation

◆ Build()

◆ BuildGeometry()

◆ BuildSubDetectors()

◆ GetDetectorName()

◆ GetEnvelope()

◆ GetWorldVolume()

◆ initialize()

◆ PositionInParent()

◆ ResetEnvelope()

◆ SetAsWorld()

◆ SetDetectorName()

◆ SetEnvelope()

◆ SetParent()

◆ SetRotationAndOffset()

Member Data Documentation

◆ m_detectorName

◆ m_dX

◆ m_dY

◆ m_dZ

◆ m_envelope

◆ m_hole_dX

◆ m_hole_dY

◆ m_hole_dZ

◆ m_holeNames

◆ m_holePosX

◆ m_holePosY

◆ m_holePosZ

◆ m_isWorld

◆ m_materialName

◆ m_notifierSvc

◆ m_numberOfHoles

◆ m_offsetX

◆ m_offsetY

◆ m_offsetZ

◆ m_rotateX

◆ m_rotateY

◆ m_rotateZ

◆ m_subDetTools

◆ m_theParent