Files
geant4/source/geometry/volumes/include/G4PVParameterised.hh
T
2016-06-09 15:37:50 +02:00

115 lines
4.9 KiB
C++

//
// ********************************************************************
// * License and Disclaimer *
// * *
// * The Geant4 software is copyright of the Copyright Holders of *
// * the Geant4 Collaboration. It is provided under the terms and *
// * conditions of the Geant4 Software License, included in the file *
// * LICENSE and available at http://cern.ch/geant4/license . These *
// * include a list of copyright holders. *
// * *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work make any representation or warranty, express or implied, *
// * regarding this software system or assume any liability for its *
// * use. Please see the license in the file LICENSE and URL above *
// * for the full disclaimer and the limitation of liability. *
// * *
// * This code implementation is the result of the scientific and *
// * technical work of the GEANT4 collaboration. *
// * By using, copying, modifying or distributing the software (or *
// * any work based on the software) you agree to acknowledge its *
// * use in resulting scientific publications, and indicate your *
// * acceptance of all terms of the Geant4 Software license. *
// ********************************************************************
//
//
// $Id: G4PVParameterised.hh,v 1.8 2007/04/11 07:56:38 gcosmo Exp $
// GEANT4 tag $Name: geant4-09-01 $
//
//
// class G4PVParameterised
//
// Class description:
//
// Represents many touchable detector elements differing in their
// positioning and dimensions. Both are calculated by means
// of a G4VParameterisation object. The positioning is assumed to
// be dominant along a cartesian axis (specified).
// History:
// 29.07.95 P.Kent First non-stub version
// ----------------------------------------------------------------------
#ifndef G4PVPARAMETERISED_HH
#define G4PVPARAMETERISED_HH
#include "G4PVReplica.hh"
class G4PVParameterised : public G4PVReplica
{
public: // with description
G4PVParameterised(const G4String& pName,
G4LogicalVolume* pLogical,
G4LogicalVolume* pMotherLogical,
const EAxis pAxis,
const G4int nReplicas,
G4VPVParameterisation *pParam,
G4bool pSurfChk=false);
// Replicate the volume nReplicas Times using the paramaterisation pParam,
// within the mother volume pMotherLogical.
// The positioning of the replicas is dominant along the specified axis.
// pSurfChk if true activates check for overlaps with existing volumes.
public: // without description
G4PVParameterised(const G4String& pName,
G4LogicalVolume* pLogical,
G4VPhysicalVolume* pMother,
const EAxis pAxis,
const G4int nReplicas,
G4VPVParameterisation *pParam,
G4bool pSurfChk=false);
// Almost exactly similar to first constructor, changing only mother
// pointer's type to PhysicalVolume.
G4PVParameterised(__void__&);
// Fake default constructor for usage restricted to direct object
// persistency for clients requiring preallocation of memory for
// persistifiable objects.
public: // with description
virtual ~G4PVParameterised();
// Virtual empty destructor.
G4bool IsParameterised() const;
// Returns true to identify it is a parameterised physical volume.
G4VPVParameterisation* GetParameterisation() const;
// Returns the current pointer to the parameterisation.
void GetReplicationData(EAxis& axis,
G4int& nReplicas,
G4double& width,
G4double& offset,
G4bool& consuming) const;
// Fills arguments with the attributes from the base replica.
virtual void SetRegularStructureId( G4int Code );
// Method sets code and can prepare for special type of regular volumes.
G4bool CheckOverlaps(G4int res=1000, G4double tol=0., G4bool verbose=true);
// Verifies if each instance of the parameterised volume is overlapping
// with other instances or with the mother volume. Provides default
// resolution for the number of points to be generated and verified.
// A tolerance for the precision of the overlap check can be specified,
// by default it is set to maximum precision.
// Returns true if an overlap occurs.
private:
G4VPVParameterisation *fparam;
};
#endif