#include <EDepSimBuilder.hh>

Inheritance diagram for EDepSim::Builder:

Public Member Functions
	Builder (G4String n, EDepSim::UserDetectorConstruction *c)

	Builder (G4String n, EDepSim::Builder *parent)

virtual	~Builder ()

virtual G4LogicalVolume *	GetPiece (void)=0

G4String	GetName (void)
	Return the base name of the object that this builds. More...

G4String	GetLocalName (void)
	Return the base name of the object that this builds. More...

void	SetLocalName (const G4String &name)
	Set the base name of the logical volume that this builds. More...

void	SetOpacity (double v)
	Set the relative opacity of the constructed object. More...

double	GetOpacity (void) const
	Get the relative opacity of the constructed object. More...

void	SetDaughterOpacity (double v)
	Set the relative opacity of the object daughters. More...

EDepSim::UserDetectorConstruction *	GetConstruction (void)
	Return the detector construction that is building this piece. More...

virtual void	SetSensitiveDetector (G4VSensitiveDetector *s)
	Set the sensitive detector for this component. More...

virtual G4VSensitiveDetector *	GetSensitiveDetector (void)
	Get the sensitive detector for this component. More...

virtual void	SetSensitiveDetector (G4String name, G4String type)
	Set the sensitive detector for this component by name. More...

virtual void	SetMaximumHitSagitta (double sagitta)

virtual void	SetMaximumHitLength (double length)
	Set the maximum length of a single hit segment. More...

G4UImessenger *	GetMessenger (void)
	Return the messenger for this constructor. More...

void	SetMessenger (G4UImessenger *m)
	Set the messenger for this constructor. More...

void	AddBuilder (EDepSim::Builder *c)

template<class T >
T &	Get (G4String n)

template<class T >
T *	Find (G4String n)

bool	Check ()

void	SetCheck (bool v)
	Set the check value. More...

Protected Member Functions
G4Material *	FindMaterial (G4String m)

G4VisAttributes	GetColor (G4LogicalVolume *volume, double opacity=0.0)

G4VisAttributes	GetColor (G4Material *volume, double opacity=0.0)

Private Attributes
G4String	fLocalName
	The short local name of the constructor. More...

G4String	fName
	The name of the constructor. More...

EDepSim::UserDetectorConstruction *	fConstruction
	The G4VUserDetectorConstruction class that this is cooperating with. More...

EDepSim::Builder *	fParent
	The parent of this constructor. More...

G4UImessenger *	fMessenger
	The user interface messenger that will provide values for this class. More...

G4VSensitiveDetector *	fSensitiveDetector
	The sensitive detector for this tracking component. More...

double	fOpacity
	The relative opacity of the constructed object. More...

bool	fCheck
	If this is true, then check the constructed object for overlaps. More...

std::map< G4String, EDepSim::Builder * >	fSubBuilders
	The sub constructors that might be used in this class. More...

Detailed Description

Definition at line 46 of file EDepSimBuilder.hh.

Constructor & Destructor Documentation

EDepSim::Builder::Builder	(	G4String	n,
		EDepSim::UserDetectorConstruction *	c
	)

Definition at line 11 of file EDepSimBuilder.cc.

     : fLocalName(n), fName(n), fConstruction(c), fParent(NULL),
       fMessenger(NULL), fSensitiveDetector(NULL), 
       fOpacity(0.0), fCheck(false) {
     fMessenger = fConstruction->GetMessenger();
 }

EDepSim::Builder::Builder	(	G4String	n,
		EDepSim::Builder *	parent
	)

Definition at line 19 of file EDepSimBuilder.cc.

     : fLocalName(n), fName(n), fConstruction(NULL), fParent(p),
       fMessenger(NULL), fSensitiveDetector(NULL), 
       fOpacity(0.0), fCheck(false) {
     fName = fParent->GetName() + "/" + fLocalName;
     fConstruction = fParent->GetConstruction();
     // Provide a reasonable default.  This will (hopefully) be overridden in
     // Init().
     fMessenger = fParent->GetMessenger();
 }

EDepSim::Builder::~Builder ( )

virtual

Definition at line 30 of file EDepSimBuilder.cc.

30 {;}

Member Function Documentation

void EDepSim::Builder::AddBuilder ( EDepSim::Builder * c )

inline

Add a new sub constructor to the current geometry constructor. This should be done in the derived class ctor. All geometry constructors that will be used by the derived class should be added using this method.

Definition at line 113 of file EDepSimBuilder.hh.

                                        {
         if (fSubBuilders.find(c->GetLocalName()) 
             != fSubBuilders.end()) {
             std::cout << "Multiply defined constructor name " 
                       << c->GetName()
                       << std::endl;
             EDepSimThrow("EDepSim::Builder::AddBuilder(): Multiple defines");
         }
         fSubBuilders[c->GetLocalName()] = c;
     }

bool EDepSim::Builder::Check ( )

inline

This returns true if the interior objects should be checked for overlaps.

Definition at line 166 of file EDepSimBuilder.hh.

166 {return fCheck;}

EDepSim::Builder::fCheck

bool fCheck

If this is true, then check the constructed object for overlaps.

Definition: EDepSimBuilder.hh:216

template<class T >

T* EDepSim::Builder::Find ( G4String n )

inline

Find a sub constructor by name and do the dynamic cast. This returns a pointer that will be NULL if you request an undefined name.

Definition at line 156 of file EDepSimBuilder.hh.

                                            {
         std::map<G4String,EDepSim::Builder*>::iterator p 
             = fSubBuilders.find(n);
         if (p==fSubBuilders.end()) return NULL;
         T* c = dynamic_cast<T*>((*p).second);
         return c;
     }

G4Material * EDepSim::Builder::FindMaterial ( G4String m )

protected

Definition at line 37 of file EDepSimBuilder.cc.

                                                       {
     G4Material* material = G4Material::GetMaterial(name,true);
     return material;
 }

template<class T >

T& EDepSim::Builder::Get ( G4String n )

inline

Get a sub constructor by name and do the dynamic cast. This will abort with an error message if you request an undefined name.

Definition at line 126 of file EDepSimBuilder.hh.

                                           {
         std::map<G4String,EDepSim::Builder*>::iterator p 
             = fSubBuilders.find(n);
         if (p==fSubBuilders.end()) {
             std::cout << "Error in " << GetName() << std::endl;
             std::cout << "   Undefined constructor requested "
                       << n << std::endl;
             std::cout << "   The choices are: " << std::endl;
             for (p = fSubBuilders.begin();
                  p != fSubBuilders.end();
                  ++p) {
                 std::cout << "        \"" << (*p).first << "\""
                           << " for constructor: " << (*p).second->GetName()
                           << std::endl;
             }
             EDepSimThrow(" Undefined constructor");
         }
         T* c = dynamic_cast<T*>((*p).second);
         if (!c) {
             std::cout << "Error in " << GetName() << std::endl;
             std::cout << "  Cannot type cast " << n 
                       << " to requested class" << std::endl;
             EDepSimThrow("EDepSim::Builder::Get<>:"
                         " Bad typecast");
         }
         return *c;
     }

G4VisAttributes EDepSim::Builder::GetColor	(	G4LogicalVolume *	volume,
		double	opacity = `0.0`
	)

protected

Takes logical volume and returns the visual attributes. The optional argument specifies the log of the relative opacity used for this specific set of attributes. If the relative opacity is 0, then the default alpha is used. If the relative opacity is positive, then the alpha is increased, and if it's negative, the alpha is decreased. If the relative opacity is 10, then the object will have an alpha of 1.0. If it's -10, then the object will have an alpha of zero (i.e. invisible).

Definition at line 184 of file EDepSimBuilder.cc.

                                                                              {
     G4Material* mat = vol->GetMaterial();
     return GetColor(mat,opacity);
 }

G4VisAttributes EDepSim::Builder::GetColor	(	G4Material *	volume,
		double	opacity = `0.0`
	)

protected

Takes a material and returns the attributes. The optional argument specifies the log of the relative opacity used for this specific set of attributes. If the relative opacity is 0, then the default alpha is used. If the relative opacity is positive, then the alpha is increased, and if it's negative, the alpha is decreased. If the relative opacity is 10, then the object will have an alpha of 1.0. If it's -10, then the object will have an alpha of zero (i.e. invisible).

Definition at line 167 of file EDepSimBuilder.cc.

                                                                         {
     EDepSim::RootGeometryManager* geoMan = EDepSim::RootGeometryManager::Get();
     // Check if the opacity has been over-ruled by the macro...
     if (fOpacity < -9.9) return G4VisAttributes::Invisible;
     opacity += fOpacity;
     if (opacity < -9.9) return G4VisAttributes::Invisible;
     G4Color color = geoMan->GetG4Color(mat);
     double red = color.GetRed();
     double green = color.GetGreen();
     double blue = color.GetBlue();
     double alpha = std::max(0.0,color.GetAlpha());
     if (opacity > 9.9) alpha = 1.0;
     else if (fOpacity > 9.9) alpha = 1.0;
     else alpha = std::min(1.0, alpha*std::exp(opacity));
     return G4VisAttributes(G4Color(red,green,blue,alpha));
 }

EDepSim::UserDetectorConstruction* EDepSim::Builder::GetConstruction ( void )

inline

Return the detector construction that is building this piece.

Definition at line 77 of file EDepSimBuilder.hh.

                                                            {
         return fConstruction;
     };

G4String EDepSim::Builder::GetLocalName ( void )

inline

Return the base name of the object that this builds.

Definition at line 62 of file EDepSimBuilder.hh.

62 {return fLocalName;};

EDepSim::Builder::fLocalName

G4String fLocalName

The short local name of the constructor.

Definition: EDepSimBuilder.hh:195

G4UImessenger* EDepSim::Builder::GetMessenger ( void )

inline

Return the messenger for this constructor.

Definition at line 102 of file EDepSimBuilder.hh.

102 {return fMessenger;};

EDepSim::Builder::fMessenger

G4UImessenger * fMessenger

The user interface messenger that will provide values for this class.

Definition: EDepSimBuilder.hh:207

G4String EDepSim::Builder::GetName ( void )

Return the base name of the object that this builds.

Definition at line 42 of file EDepSimBuilder.cc.

                                      {
     return fName;
 }

double EDepSim::Builder::GetOpacity ( void ) const

inline

Get the relative opacity of the constructed object.

Definition at line 71 of file EDepSimBuilder.hh.

71 {return fOpacity;}

EDepSim::Builder::fOpacity

double fOpacity

The relative opacity of the constructed object.

Definition: EDepSimBuilder.hh:213

G4LogicalVolume * EDepSim::Builder::GetPiece ( void )

pure virtual

Construct and return a G4 volume for the object. This is a pure virtual function, which means it must be implemented by the inheriting classes. This returns an unplaced logical volume which faces along the Z axis.

Implemented in EDepSim::ModuleBuilder, CaptCryostatBuilder, CaptWirePlaneBuilder, CaptDriftRegionBuilder, CaptExposedBuilder, CaptImmersedBuilder, MiniCaptExposedBuilder, MiniCaptImmersedBuilder, CaptPMTBuilder, and CaptWorldBuilder.

Definition at line 32 of file EDepSimBuilder.cc.

                                               {
     EDepSimThrow("EDepSim::Builder::GetPiece(): Not implemented");
     return NULL;
 }

virtual G4VSensitiveDetector* EDepSim::Builder::GetSensitiveDetector ( void )

inlinevirtual

Get the sensitive detector for this component.

Definition at line 87 of file EDepSimBuilder.hh.

                                                              {
         return fSensitiveDetector;
     }

void EDepSim::Builder::SetCheck ( bool v )

inline

Set the check value.

Definition at line 169 of file EDepSimBuilder.hh.

169 {fCheck = v;}

EDepSim::Builder::fCheck

bool fCheck

If this is true, then check the constructed object for overlaps.

Definition: EDepSimBuilder.hh:216

void EDepSim::Builder::SetDaughterOpacity ( double v )

Set the relative opacity of the object daughters.

Set the visibility of the constructed object.

Definition at line 65 of file EDepSimBuilder.cc.

                                                 {
     for (std::map<G4String,EDepSim::Builder*>::iterator p 
              = fSubBuilders.begin();
          p!=fSubBuilders.end();
          ++p) {
         (*p).second->SetOpacity(v);
         (*p).second->SetDaughterOpacity(v);
     }
 }

void EDepSim::Builder::SetLocalName ( const G4String & name )

Set the base name of the logical volume that this builds.

Set the local name of the object to be built. The local name of the logical volume being set, and also sets the full name of the volume.

Definition at line 48 of file EDepSimBuilder.cc.

                                                       {
     fLocalName = name;
     fName = name;
     if (fParent) fName = fParent->GetName() + "/" + fName;
 }

void EDepSim::Builder::SetMaximumHitLength ( double length )

virtual

Set the maximum length of a single hit segment.

Definition at line 210 of file EDepSimBuilder.cc.

                                                       {
     if (!fSensitiveDetector) {
         EDepSimError("Maximum hit length must be set after the sensitive"
                   " detector is defined.");
         EDepSimThrow("Builder does not have sensitive detector defined");
         return;
     }
     EDepSim::SegmentSD *segSD = dynamic_cast<EDepSim::SegmentSD*>(fSensitiveDetector);
     if (!segSD) {
         EDepSimThrow("Sensitive detector not derived from EDepSim::SegmentSD");
         return;
     }
     segSD->SetMaximumHitLength(length);
 }

void EDepSim::Builder::SetMaximumHitSagitta ( double sagitta )

virtual

Set the maximum sagitta for a track being added to a single hit segment.

Definition at line 195 of file EDepSimBuilder.cc.

                                                         {
     if (!fSensitiveDetector) {
         EDepSimError("Maximum hit sagitta must be set after the sensitive"
                   " detector is defined.");
         EDepSimThrow("Builder does not have sensitive detector defined");
         return;
     }
     EDepSim::SegmentSD *segSD = dynamic_cast<EDepSim::SegmentSD*>(fSensitiveDetector);
     if (!segSD) {
         EDepSimThrow("Sensitive detector not derived from EDepSim::SegmentSD");
         return;
     }
     segSD->SetMaximumHitSagitta(sagitta);
 }

void EDepSim::Builder::SetMessenger ( G4UImessenger * m )

inline

Set the messenger for this constructor.

Definition at line 105 of file EDepSimBuilder.hh.

                                         {
         fMessenger = m;
     };

void EDepSim::Builder::SetOpacity ( double v )

Set the relative opacity of the constructed object.

Set the visibility of the constructed object.

Definition at line 56 of file EDepSimBuilder.cc.

                                         {
     if (fOpacity != v) {
         EDepSimLog("Set relative opacity for " << GetName()
                     << " from " << fOpacity << " to " << v);
     }
     fOpacity = v;
 }

virtual void EDepSim::Builder::SetSensitiveDetector ( G4VSensitiveDetector * s )

inlinevirtual

Set the sensitive detector for this component.

Definition at line 82 of file EDepSimBuilder.hh.

                                                                {
         fSensitiveDetector = s;
     }

void EDepSim::Builder::SetSensitiveDetector	(	G4String	name,
		G4String	type
	)

virtual

Set the sensitive detector for this component by name.

Definition at line 190 of file EDepSimBuilder.cc.

                                                                       {
     EDepSim::SDFactory factory(type);
     SetSensitiveDetector(factory.MakeSD(name));
 }

Member Data Documentation

bool EDepSim::Builder::fCheck

private

If this is true, then check the constructed object for overlaps.

Definition at line 216 of file EDepSimBuilder.hh.

EDepSim::UserDetectorConstruction* EDepSim::Builder::fConstruction

private

The G4VUserDetectorConstruction class that this is cooperating with.

Definition at line 201 of file EDepSimBuilder.hh.

G4String EDepSim::Builder::fLocalName

private

The short local name of the constructor.

Definition at line 195 of file EDepSimBuilder.hh.

G4UImessenger* EDepSim::Builder::fMessenger

private

The user interface messenger that will provide values for this class.

Definition at line 207 of file EDepSimBuilder.hh.

G4String EDepSim::Builder::fName

private

The name of the constructor.

Definition at line 198 of file EDepSimBuilder.hh.

double EDepSim::Builder::fOpacity

private

The relative opacity of the constructed object.

Definition at line 213 of file EDepSimBuilder.hh.

EDepSim::Builder* EDepSim::Builder::fParent

private

The parent of this constructor.

Definition at line 204 of file EDepSimBuilder.hh.

G4VSensitiveDetector* EDepSim::Builder::fSensitiveDetector

private

The sensitive detector for this tracking component.

Definition at line 210 of file EDepSimBuilder.hh.

std::map<G4String,EDepSim::Builder*> EDepSim::Builder::fSubBuilders

private

The sub constructors that might be used in this class.

Definition at line 219 of file EDepSimBuilder.hh.

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

edep-sim/src/EDepSimBuilder.hh
edep-sim/src/EDepSimBuilder.cc

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation