gear::GearMgr Class Reference

Abstract interface for a manager class that returns the Gear classes for the relevant subdetectors. More...

#include <GearMgr.h>

Inheritance diagram for gear::GearMgr:
gear::GearMgrImpl

List of all members.

Public Member Functions

virtual ~GearMgr ()
 Destructor.
virtual const std::string & getDetectorName () const =0
 The unique detector name - typically the model name used in the simulation program.
virtual const GearParametersgetGearParameters (const std::string &key) const =0 throw (UnknownParameterException, std::exception )
 Get named parameters for key.
virtual const BFieldgetBField () const =0 throw (UnknownParameterException, std::exception )
 Get the B field map.
virtual const TPCParametersgetTPCParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the TPCParameters.
virtual const
CalorimeterParameters
getEcalBarrelParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the Ecal barrel parameters.
virtual const
CalorimeterParameters
getEcalEndcapParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the Ecal endcap parameters.
virtual const
CalorimeterParameters
getEcalPlugParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the Ecal plug parameters.
virtual const
CalorimeterParameters
getYokeBarrelParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the Yoke barrel parameters.
virtual const
CalorimeterParameters
getYokeEndcapParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the Yoke endcap parameters.
virtual const
CalorimeterParameters
getYokePlugParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the Yoke plug parameters.
virtual const
CalorimeterParameters
getHcalBarrelParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the Hcal barrel parameters.
virtual const
CalorimeterParameters
getHcalEndcapParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the Hcal endcap parameters.
virtual const
CalorimeterParameters
getHcalRingParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the Hcal ring parameters.
virtual const
CalorimeterParameters
getLcalParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the Lcal parameters.
virtual const
CalorimeterParameters
getLHcalParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the LHcal parameters.
virtual const
CalorimeterParameters
getBeamCalParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the BeamCal parameters.
virtual const ZPlanarParametersgetVXDParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the VXD parameters.
virtual const FTDParametersgetFTDParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the FTD parameters.
virtual const ZPlanarParametersgetSITParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the SIT parameters.
virtual const ZPlanarParametersgetSETParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the SET parameters.
virtual const
TrackerPlanesParameters
getTrackerPlanesParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the TrackerPlanes parameters.
virtual const SiPlanesParametersgetSiPlanesParameters () const =0 throw (UnknownParameterException, std::exception )
 Get the SiPlanes parameters.
virtual const GearPointPropertiesgetPointProperties () const =0 throw (NotImplementedException, std::exception )
 Get the point properties object.
virtual const
GearDistanceProperties
getDistanceProperties () const =0 throw (NotImplementedException, std::exception )
 Get the distance properties object.
virtual const std::vector
< std::string > & 
getGearParameterKeys () const =0
 Keys of all GearParameters.
virtual const SimpleMaterialgetSimpleMaterial (const std::string name) const =0 throw (UnknownParameterException, std::exception )
 Return the SimpleMaterial for the given name throws UnknownParameterException if no material is unknown.
virtual const std::vector
< std::string > & 
getMaterialNames () const =0
 Names of registered materials.
virtual MeasurementSurfaceStoregetMeasurementSurfaceStore () const =0
 Return the MeasurementSurfaceStore.
virtual void setDetectorName (const std::string &name)=0
 Set detector name.
virtual void setGearParameters (const std::string &key, GearParameters *gearParameters)=0
 Set named parameters for key.
virtual void setBField (BField *bField)=0
 Set the BField.
virtual void setTPCParameters (TPCParameters *tpcParameters)=0
 Set the TPCParameters.
virtual void setEcalBarrelParameters (CalorimeterParameters *ecalBarrelParameters)=0
 Set the EcalBarrelParameters.
virtual void setEcalEndcapParameters (CalorimeterParameters *ecalEndcapParameters)=0
 Set the EcalEndcapParameters.
virtual void setEcalPlugParameters (CalorimeterParameters *ecalPlugParameters)=0
 Set the EcalPlugParameters.
virtual void setYokeBarrelParameters (CalorimeterParameters *ecalBarrelParameters)=0
 Set the YokeBarrelParameters.
virtual void setYokeEndcapParameters (CalorimeterParameters *ecalEndcapParameters)=0
 Set the YokeEndcapParameters.
virtual void setYokePlugParameters (CalorimeterParameters *ecalPlugParameters)=0
 Set the YokePlugParameters.
virtual void setHcalBarrelParameters (CalorimeterParameters *hcalBarrelParameters)=0
 Set the HcalBarrelParameters.
virtual void setHcalEndcapParameters (CalorimeterParameters *hcalEndcapParameters)=0
 Set the HcalEndcapParameters.
virtual void setHcalRingParameters (CalorimeterParameters *hcalRingParameters)=0
 Set the HcalRingParameters.
virtual void setVXDParameters (ZPlanarParameters *vxdParameters)=0
 Set the VXDParameters.
virtual void setFTDParameters (FTDParameters *ftdParameters)=0
 Set the FTDParameters.
virtual void setSITParameters (ZPlanarParameters *sitParameters)=0
 Set the SITParameters.
virtual void setSETParameters (ZPlanarParameters *setParameters)=0
 Set the SETParameters.
virtual void setTrackerPlanesParameters (TrackerPlanesParameters *trackerplanesParameters)=0
 Set the TrackerPlanesParameters.
virtual void setSiPlanesParameters (SiPlanesParameters *siplanesParameters)=0
 Set the SiPlanesParameters.
virtual void setLcalParameters (CalorimeterParameters *lcalParameters)=0
 Set the LcalParameters.
virtual void setLHcalParameters (CalorimeterParameters *lhcalParameters)=0
 Set the LHcalParameters.
virtual void setBeamCalParameters (CalorimeterParameters *beamcalParameters)=0
 Set the BeamCalParameters.
virtual void setPointProperties (GearPointProperties *pointProperties)=0
 Set the point properties object.
virtual void setDistanceProperties (GearDistanceProperties *distanceProperties)=0
 Set the distance properties object.
virtual void registerSimpleMaterial (const SimpleMaterial *material)=0 throw ( Exception , std::exception )
 Register the SimpleMaterial with SimpleMaterial::getName() - throws Exception if a material of the given name has already been added.

Detailed Description

Abstract interface for a manager class that returns the Gear classes for the relevant subdetectors.

Author:
F. Gaede, DESY
Version:
$Id$

Definition at line 36 of file GearMgr.h.


Member Function Documentation

virtual const CalorimeterParameters& gear::GearMgr::getBeamCalParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the BeamCal parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const BField& gear::GearMgr::getBField (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the B field map.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const GearDistanceProperties& gear::GearMgr::getDistanceProperties (  )  const throw (NotImplementedException, std::exception ) [pure virtual]

Get the distance properties object.

Exceptions:
NotImplementedException 

Implemented in gear::GearMgrImpl.

Referenced by gear::MaterialMap::MaterialMap().

virtual const CalorimeterParameters& gear::GearMgr::getEcalBarrelParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the Ecal barrel parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const CalorimeterParameters& gear::GearMgr::getEcalEndcapParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the Ecal endcap parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const CalorimeterParameters& gear::GearMgr::getEcalPlugParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the Ecal plug parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const FTDParameters& gear::GearMgr::getFTDParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the FTD parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const GearParameters& gear::GearMgr::getGearParameters ( const std::string &  key  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get named parameters for key.

This can be used to describe a subdetector that is not yet forseen in the Gear API.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const CalorimeterParameters& gear::GearMgr::getHcalBarrelParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the Hcal barrel parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const CalorimeterParameters& gear::GearMgr::getHcalEndcapParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the Hcal endcap parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const CalorimeterParameters& gear::GearMgr::getHcalRingParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the Hcal ring parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const CalorimeterParameters& gear::GearMgr::getLcalParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the Lcal parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const CalorimeterParameters& gear::GearMgr::getLHcalParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the LHcal parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const GearPointProperties& gear::GearMgr::getPointProperties (  )  const throw (NotImplementedException, std::exception ) [pure virtual]

Get the point properties object.

Exceptions:
NotImplementedException 

Implemented in gear::GearMgrImpl.

virtual const ZPlanarParameters& gear::GearMgr::getSETParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the SET parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const SimpleMaterial& gear::GearMgr::getSimpleMaterial ( const std::string  name  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Return the SimpleMaterial for the given name throws UnknownParameterException if no material is unknown.

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const SiPlanesParameters& gear::GearMgr::getSiPlanesParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the SiPlanes parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const ZPlanarParameters& gear::GearMgr::getSITParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the SIT parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const TPCParameters& gear::GearMgr::getTPCParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the TPCParameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const TrackerPlanesParameters& gear::GearMgr::getTrackerPlanesParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the TrackerPlanes parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const ZPlanarParameters& gear::GearMgr::getVXDParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the VXD parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const CalorimeterParameters& gear::GearMgr::getYokeBarrelParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the Yoke barrel parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const CalorimeterParameters& gear::GearMgr::getYokeEndcapParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the Yoke endcap parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual const CalorimeterParameters& gear::GearMgr::getYokePlugParameters (  )  const throw (UnknownParameterException, std::exception ) [pure virtual]

Get the Yoke plug parameters.

Exceptions:
UnknownParameterException 

Implemented in gear::GearMgrImpl.

Referenced by gear::GearXML::createXMLFile().

virtual void gear::GearMgr::registerSimpleMaterial ( const SimpleMaterial material  )  throw ( Exception , std::exception ) [pure virtual]

Register the SimpleMaterial with SimpleMaterial::getName() - throws Exception if a material of the given name has already been added.

This takes ownership of the SimpleMaterial object.

Implemented in gear::GearMgrImpl.

Referenced by gear::SimpleMaterialXML::fromXML().

virtual void gear::GearMgr::setGearParameters ( const std::string &  key,
GearParameters gearParameters 
) [pure virtual]

Set named parameters for key.

This can be used to describe a subdetector that is not yet forseen in the Gear API.

Implemented in gear::GearMgrImpl.

Referenced by gear::GearParametersXML::fromXML().


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Typedefs Enumerations

Generated on 22 Nov 2017 for GEAR by  doxygen 1.6.1