EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
PHG4ForwardHcalSubsystem Class Reference

#include <fun4all_eicdetectors/blob/master/simulation/g4simulation/g4eiccalos/PHG4ForwardHcalSubsystem.h>

+ Inheritance diagram for PHG4ForwardHcalSubsystem:
+ Collaboration diagram for PHG4ForwardHcalSubsystem:

Public Member Functions

 PHG4ForwardHcalSubsystem (const std::string &name="FORWARD_HCAL_DEFAULT", const int layer=0)
 
virtual ~PHG4ForwardHcalSubsystem ()
 
int InitRunSubsystem (PHCompositeNode *) override
 
int process_event (PHCompositeNode *) override
 
void Print (const std::string &what="ALL") const override
 Print info (from SubsysReco)
 
PHG4Detector * GetDetector () const override
 
PHG4SteppingAction * GetSteppingAction () const override
 return pointer to this subsystem stepping action
 
PHG4DisplayAction * GetDisplayAction () const override
 return pointer to this subsystem display setting
 
void SetTowerMappingFile (const std::string &filename)
 
void SetUseFeTungstenAbsorber (int useTungsten)
 
void SetDetailed (bool b)
 
- Public Member Functions inherited from PHG4DetectorSubsystem
 ~PHG4DetectorSubsystem () override
 
int Init (PHCompositeNode *) final
 
int InitRun (PHCompositeNode *) final
 
virtual int InitSubsystem (PHCompositeNode *)
 
void OverlapCheck (const bool chk=true)
 
bool CheckOverlap () const
 
PHParameters * GetParams () const
 
void set_double_param (const std::string &name, const double dval)
 
double get_double_param (const std::string &name) const
 
void set_int_param (const std::string &name, const int ival)
 
int get_int_param (const std::string &name) const
 
void set_string_param (const std::string &name, const std::string &sval)
 
std::string get_string_param (const std::string &name) const
 
void UseDB (const int i=1)
 
int ReadDB () const
 
FILE_TYPE get_filetype () const
 
void UseCalibFiles (const FILE_TYPE ftyp)
 
int SaveParamsToDB ()
 
int ReadParamsFromDB (const std::string &name, const int issuper)
 
int SaveParamsToFile (const FILE_TYPE ftyp)
 
int ReadParamsFromFile (const std::string &name, const FILE_TYPE ftyp, const int issuper)
 
void SetCalibrationFileDir (const std::string &calibdir)
 
void UpdateParametersWithMacro ()
 
void SetActive (const int i=1)
 
void SetAbsorberActive (const int i=1)
 
void SetAbsorberTruth (const int i=1)
 
void BlackHole (const int i=1)
 
void SetSupportActive (const int i=1)
 
void SuperDetector (const std::string &name)
 
const std::string SuperDetector () const
 
int GetLayer () const
 
- Public Member Functions inherited from PHG4Subsystem
 PHG4Subsystem (const std::string &name="Generic Subsystem")
 constructor
 
 ~PHG4Subsystem (void) override
 destructor
 
virtual int process_after_geant (PHCompositeNode *)
 event processing
 
virtual PHG4EventAction * GetEventAction (void) const
 return pointer to this subsystem event action
 
virtual PHG4TrackingAction * GetTrackingAction (void) const
 return pointer to this subsystem stepping action
 
virtual PHG4StackingAction * GetStackingAction () const
 
void OverlapCheck (const bool chk=true)
 
bool CheckOverlap () const
 
void SetMotherSubsystem (PHG4Subsystem *subsys)
 
PHG4Subsystem * GetMotherSubsystem () const
 
void SetLogicalVolume (G4LogicalVolume *vol)
 
G4LogicalVolume * GetLogicalVolume () const
 
virtual bool CanBeMotherSubsystem () const
 
virtual void AddProcesses (G4ParticleDefinition *)
 
virtual void DefineMaterials ()
 
- Public Member Functions inherited from SubsysReco
 ~SubsysReco () override
 
virtual int End (PHCompositeNode *)
 Called at the end of all processing.
 
virtual int EndRun (const int)
 Called at the end of each run.
 
virtual int Reset (PHCompositeNode *)
 Reset.
 
virtual int ResetEvent (PHCompositeNode *)
 Clean up after each event.
 
- Public Member Functions inherited from Fun4AllBase
virtual ~Fun4AllBase ()
 
virtual const std::string Name () const
 Returns the name of this module.
 
virtual void Name (const std::string &name)
 Sets the name of this module.
 
virtual void Verbosity (const int ival)
 Sets the verbosity of this module (0 by default=quiet).
 
virtual void Verbosity (enu_Verbosity ival)
 Sets the verbosity of this module (0 by default=quiet).
 
virtual int Verbosity () const
 Gets the verbosity of this module.
 

Private Member Functions

void SetDefaultParameters () override
 

Private Attributes

PHG4ForwardHcalDetector * m_Detector = nullptr
 
PHG4SteppingAction * m_SteppingAction = nullptr
 
PHG4DisplayAction * m_DisplayAction = nullptr
 display attribute setting
 
bool showdetailed = false
 
std::string m_HitNodeName
 
std::string m_AbsorberNodeName
 
std::string m_SupportNodeName
 

Additional Inherited Members

- Public Types inherited from PHG4DetectorSubsystem
enum  FILE_TYPE { none = 0, xml = 1, root = 2 }
 
- Protected Member Functions inherited from PHG4DetectorSubsystem
 PHG4DetectorSubsystem (const std::string &name="GenericSubsystem", const int lyr=0)
 
void InitializeParameters ()
 
void set_default_double_param (const std::string &name, const double dval)
 
void set_default_int_param (const std::string &name, const int ival)
 
void set_default_string_param (const std::string &name, const std::string &sval)
 
int BeginRunExecuted () const
 

Detailed Description

Definition at line 16 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 16 of file PHG4ForwardHcalSubsystem.h

Constructor & Destructor Documentation

PHG4ForwardHcalSubsystem::PHG4ForwardHcalSubsystem ( const std::string &  name = "FORWARD_HCAL_DEFAULT",
const int  layer = 0 
)

Constructor

Definition at line 30 of file PHG4ForwardHcalSubsystem.cc.

View newest version in sPHENIX GitHub at line 30 of file PHG4ForwardHcalSubsystem.cc

References PHG4DetectorSubsystem::InitializeParameters().

+ Here is the call graph for this function:

PHG4ForwardHcalSubsystem::~PHG4ForwardHcalSubsystem ( )
virtual

Destructor

Definition at line 37 of file PHG4ForwardHcalSubsystem.cc.

View newest version in sPHENIX GitHub at line 37 of file PHG4ForwardHcalSubsystem.cc

References m_DisplayAction.

Member Function Documentation

PHG4Detector * PHG4ForwardHcalSubsystem::GetDetector ( void  ) const
overridevirtual

Accessors (reimplemented)

Reimplemented from PHG4Subsystem.

Definition at line 121 of file PHG4ForwardHcalSubsystem.cc.

View newest version in sPHENIX GitHub at line 121 of file PHG4ForwardHcalSubsystem.cc

References m_Detector.

PHG4DisplayAction* PHG4ForwardHcalSubsystem::GetDisplayAction ( ) const
inlineoverridevirtual

return pointer to this subsystem display setting

Reimplemented from PHG4Subsystem.

Definition at line 45 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 45 of file PHG4ForwardHcalSubsystem.h

References m_DisplayAction.

PHG4SteppingAction* PHG4ForwardHcalSubsystem::GetSteppingAction ( void  ) const
inlineoverridevirtual

return pointer to this subsystem stepping action

Reimplemented from PHG4Subsystem.

Definition at line 44 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 44 of file PHG4ForwardHcalSubsystem.h

References m_SteppingAction.

int PHG4ForwardHcalSubsystem::InitRunSubsystem ( PHCompositeNode *  topNode)
overridevirtual

Creates the m_Detector object Creates the stepping action Creates relevant hit nodes that will be populated by the stepping action and stored in the output DST

Reimplemented from PHG4DetectorSubsystem.

Definition at line 43 of file PHG4ForwardHcalSubsystem.cc.

View newest version in sPHENIX GitHub at line 43 of file PHG4ForwardHcalSubsystem.cc

References PHCompositeNode::addNode(), PHG4DetectorSubsystem::CheckOverlap(), PHNodeIterator::findFirst(), PHG4DetectorSubsystem::get_int_param(), PHG4DetectorSubsystem::GetParams(), m_AbsorberNodeName, m_Detector, m_DisplayAction, m_HitNodeName, m_SteppingAction, m_SupportNodeName, Fun4AllBase::Name(), PHG4Detector::OverlapCheck(), PHG4ForwardHcalSteppingAction::SetAbsorberNodeName(), PHG4ForwardHcalSteppingAction::SetHitNodeName(), PHG4ForwardHcalSteppingAction::SetSupportNodeName(), showdetailed, PHG4ForwardHcalDetector::SuperDetector(), PHG4DetectorSubsystem::SuperDetector(), PHG4Detector::topNode(), PHG4Detector::Verbosity(), and Fun4AllBase::Verbosity().

+ Here is the call graph for this function:

void PHG4ForwardHcalSubsystem::Print ( const std::string &  what = "ALL") const
overridevirtual

Print info (from SubsysReco)

Reimplemented from SubsysReco.

Definition at line 178 of file PHG4ForwardHcalSubsystem.cc.

View newest version in sPHENIX GitHub at line 178 of file PHG4ForwardHcalSubsystem.cc

References PHG4DetectorSubsystem::BeginRunExecuted(), PHG4DetectorSubsystem::GetParams(), m_SteppingAction, Fun4AllBase::Name(), PHParameters::Print(), and PHG4SteppingAction::Print().

+ Here is the call graph for this function:

int PHG4ForwardHcalSubsystem::process_event ( PHCompositeNode *  topNode)
overridevirtual

Event processing

Reimplemented from SubsysReco.

Definition at line 109 of file PHG4ForwardHcalSubsystem.cc.

View newest version in sPHENIX GitHub at line 109 of file PHG4ForwardHcalSubsystem.cc

References m_SteppingAction, and PHG4SteppingAction::SetInterfacePointers().

+ Here is the call graph for this function:

void PHG4ForwardHcalSubsystem::SetDefaultParameters ( )
overrideprivatevirtual

Implements PHG4DetectorSubsystem.

Definition at line 126 of file PHG4ForwardHcalSubsystem.cc.

View newest version in sPHENIX GitHub at line 126 of file PHG4ForwardHcalSubsystem.cc

References PHG4Utils::md5sum(), PHG4DetectorSubsystem::set_default_double_param(), PHG4DetectorSubsystem::set_default_int_param(), and PHG4DetectorSubsystem::set_default_string_param().

+ Here is the call graph for this function:

void PHG4ForwardHcalSubsystem::SetDetailed ( bool  b)
inline

Set level of detail for display

Definition at line 55 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 55 of file PHG4ForwardHcalSubsystem.h

References showdetailed.

Referenced by FHCALSetup().

+ Here is the caller graph for this function:

void PHG4ForwardHcalSubsystem::SetTowerMappingFile ( const std::string &  filename)

Set mapping file for calorimeter towers

Definition at line 172 of file PHG4ForwardHcalSubsystem.cc.

View newest version in sPHENIX GitHub at line 172 of file PHG4ForwardHcalSubsystem.cc

References PHG4DetectorSubsystem::get_string_param(), PHG4Utils::md5sum(), and PHG4DetectorSubsystem::set_string_param().

Referenced by FHCALSetup().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void PHG4ForwardHcalSubsystem::SetUseFeTungstenAbsorber ( int  useTungsten)
inline

Definition at line 51 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 51 of file PHG4ForwardHcalSubsystem.h

References PHG4DetectorSubsystem::set_int_param().

Referenced by FHCALSetup().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

std::string PHG4ForwardHcalSubsystem::m_AbsorberNodeName
private

Definition at line 74 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 74 of file PHG4ForwardHcalSubsystem.h

Referenced by InitRunSubsystem().

PHG4ForwardHcalDetector* PHG4ForwardHcalSubsystem::m_Detector = nullptr
private

Pointer to the Geant4 implementation of the detector

Definition at line 62 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 62 of file PHG4ForwardHcalSubsystem.h

Referenced by GetDetector(), and InitRunSubsystem().

PHG4DisplayAction* PHG4ForwardHcalSubsystem::m_DisplayAction = nullptr
private

display attribute setting

derives from PHG4DisplayAction

Definition at line 69 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 69 of file PHG4ForwardHcalSubsystem.h

Referenced by GetDisplayAction(), InitRunSubsystem(), and ~PHG4ForwardHcalSubsystem().

std::string PHG4ForwardHcalSubsystem::m_HitNodeName
private

Definition at line 73 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 73 of file PHG4ForwardHcalSubsystem.h

Referenced by InitRunSubsystem().

PHG4SteppingAction* PHG4ForwardHcalSubsystem::m_SteppingAction = nullptr
private

Stepping action

Definition at line 66 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 66 of file PHG4ForwardHcalSubsystem.h

Referenced by GetSteppingAction(), InitRunSubsystem(), Print(), and process_event().

std::string PHG4ForwardHcalSubsystem::m_SupportNodeName
private

Definition at line 75 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 75 of file PHG4ForwardHcalSubsystem.h

Referenced by InitRunSubsystem().

bool PHG4ForwardHcalSubsystem::showdetailed = false
private

Definition at line 71 of file PHG4ForwardHcalSubsystem.h.

View newest version in sPHENIX GitHub at line 71 of file PHG4ForwardHcalSubsystem.h

Referenced by InitRunSubsystem(), and SetDetailed().

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