ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PHG4BbcSubsystem Class Reference

Fun4All module to simulate the BBC detector, aka MBD. More...

#include <coresoftware/blob/master/simulation/g4simulation/g4detectors/PHG4BbcSubsystem.h>

+ Inheritance diagram for PHG4BbcSubsystem:
+ Collaboration diagram for PHG4BbcSubsystem:

Public Member Functions

 PHG4BbcSubsystem (const std::string &name="BBC")
 constructor
 
 ~PHG4BbcSubsystem (void) override
 destructor
 
int InitRunSubsystem (PHCompositeNode *) override
 
int process_event (PHCompositeNode *) override
 event processing
 
PHG4DetectorGetDetector () const override
 accessors (reimplemented)
 
PHG4SteppingActionGetSteppingAction (void) const override
 return pointer to this subsystem stepping action
 
PHG4DisplayActionGetDisplayAction () const override
 return pointer to this subsystem display setting
 
void Print (const std::string &what="ALL") const override
 Print info (from SubsysReco)
 
- 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
 
PHParametersGetParams () 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 PHG4EventActionGetEventAction (void) const
 return pointer to this subsystem event action
 
virtual PHG4TrackingActionGetTrackingAction (void) const
 return pointer to this subsystem stepping action
 
virtual PHG4StackingActionGetStackingAction () const
 
void OverlapCheck (const bool chk=true)
 
bool CheckOverlap () const
 
void SetMotherSubsystem (PHG4Subsystem *subsys)
 
PHG4SubsystemGetMotherSubsystem () const
 
void SetLogicalVolume (G4LogicalVolume *vol)
 
G4LogicalVolumeGetLogicalVolume () 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.
 

Protected Member Functions

void SetDefaultParameters () override
 
- 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
 

Protected Attributes

PHG4BbcDetectorm_Detector = nullptr
 MBD geometry and construction.
 
PHG4SteppingActionm_SteppingAction = nullptr
 particle tracking "stepping" action
 
PHG4DisplayActionm_DisplayAction = nullptr
 display attribute setting
 
std::string m_HitNodeName
 
std::string m_SupportNodeName
 

Additional Inherited Members

- Public Types inherited from PHG4DetectorSubsystem
enum  FILE_TYPE { none = 0, xml = 1, root = 2 }
 

Detailed Description

Fun4All module to simulate the BBC detector, aka MBD.

The detector is constructed and registered via PHG4BbcDetector

The PHG4SteppingAction needs to be updated more, but will provide the info for the hit time

See Also
PHG4BbcDetector
PHG4BbcSubsystem

Definition at line 37 of file PHG4BbcSubsystem.h.

View newest version in sPHENIX GitHub at line 37 of file PHG4BbcSubsystem.h

Constructor & Destructor Documentation

PHG4BbcSubsystem::PHG4BbcSubsystem ( const std::string &  name = "BBC")

constructor

Definition at line 26 of file PHG4BbcSubsystem.cc.

View newest version in sPHENIX GitHub at line 26 of file PHG4BbcSubsystem.cc

References PHG4DetectorSubsystem::InitializeParameters().

+ Here is the call graph for this function:

PHG4BbcSubsystem::~PHG4BbcSubsystem ( void  )
override

destructor

Definition at line 33 of file PHG4BbcSubsystem.cc.

View newest version in sPHENIX GitHub at line 33 of file PHG4BbcSubsystem.cc

References m_DisplayAction.

Member Function Documentation

PHG4Detector * PHG4BbcSubsystem::GetDetector ( void  ) const
overridevirtual

accessors (reimplemented)

Reimplemented from PHG4Subsystem.

Definition at line 136 of file PHG4BbcSubsystem.cc.

View newest version in sPHENIX GitHub at line 136 of file PHG4BbcSubsystem.cc

References m_Detector.

PHG4DisplayAction* PHG4BbcSubsystem::GetDisplayAction ( ) const
inlineoverridevirtual

return pointer to this subsystem display setting

Reimplemented from PHG4Subsystem.

Definition at line 61 of file PHG4BbcSubsystem.h.

View newest version in sPHENIX GitHub at line 61 of file PHG4BbcSubsystem.h

References m_DisplayAction.

PHG4SteppingAction* PHG4BbcSubsystem::GetSteppingAction ( void  ) const
inlineoverridevirtual

return pointer to this subsystem stepping action

Reimplemented from PHG4Subsystem.

Definition at line 60 of file PHG4BbcSubsystem.h.

View newest version in sPHENIX GitHub at line 60 of file PHG4BbcSubsystem.h

References m_SteppingAction.

int PHG4BbcSubsystem::InitRunSubsystem ( PHCompositeNode topNode)
overridevirtual

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

Reimplemented from PHG4DetectorSubsystem.

Definition at line 39 of file PHG4BbcSubsystem.cc.

View newest version in sPHENIX GitHub at line 39 of file PHG4BbcSubsystem.cc

References PHCompositeNode::addNode(), PHG4DetectorSubsystem::CheckOverlap(), PHNodeIterator::findFirst(), PHG4DetectorSubsystem::get_int_param(), PHG4DetectorSubsystem::GetParams(), m_Detector, m_DisplayAction, m_HitNodeName, m_SteppingAction, m_SupportNodeName, Fun4AllBase::Name(), PHG4Detector::OverlapCheck(), PHWHERE, PHG4SteppingAction::SetHitNodeName(), PHG4BbcDetector::SuperDetector(), PHG4DetectorSubsystem::SuperDetector(), and Fun4AllBase::Verbosity().

+ Here is the call graph for this function:

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

Print info (from SubsysReco)

Reimplemented from SubsysReco.

Definition at line 120 of file PHG4BbcSubsystem.cc.

View newest version in sPHENIX GitHub at line 120 of file PHG4BbcSubsystem.cc

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

+ Here is the call graph for this function:

int PHG4BbcSubsystem::process_event ( PHCompositeNode topNode)
overridevirtual

event processing

get all relevant nodes from top nodes (namely hit list) and pass that to the stepping action

Reimplemented from SubsysReco.

Definition at line 109 of file PHG4BbcSubsystem.cc.

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

References m_SteppingAction, and PHG4SteppingAction::SetInterfacePointers().

+ Here is the call graph for this function:

void PHG4BbcSubsystem::SetDefaultParameters ( )
overrideprotectedvirtual

Implements PHG4DetectorSubsystem.

Definition at line 141 of file PHG4BbcSubsystem.cc.

View newest version in sPHENIX GitHub at line 141 of file PHG4BbcSubsystem.cc

Member Data Documentation

PHG4BbcDetector* PHG4BbcSubsystem::m_Detector = nullptr
protected

MBD geometry and construction.

derives from PHG4Detector

Definition at line 72 of file PHG4BbcSubsystem.h.

View newest version in sPHENIX GitHub at line 72 of file PHG4BbcSubsystem.h

Referenced by GetDetector(), InitRunSubsystem(), and Print().

PHG4DisplayAction* PHG4BbcSubsystem::m_DisplayAction = nullptr
protected

display attribute setting

derives from PHG4DisplayAction

Definition at line 80 of file PHG4BbcSubsystem.h.

View newest version in sPHENIX GitHub at line 80 of file PHG4BbcSubsystem.h

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

std::string PHG4BbcSubsystem::m_HitNodeName
protected

Definition at line 82 of file PHG4BbcSubsystem.h.

View newest version in sPHENIX GitHub at line 82 of file PHG4BbcSubsystem.h

Referenced by InitRunSubsystem().

PHG4SteppingAction* PHG4BbcSubsystem::m_SteppingAction = nullptr
protected

particle tracking "stepping" action

derives from PHG4SteppingActions

Definition at line 76 of file PHG4BbcSubsystem.h.

View newest version in sPHENIX GitHub at line 76 of file PHG4BbcSubsystem.h

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

std::string PHG4BbcSubsystem::m_SupportNodeName
protected

Definition at line 83 of file PHG4BbcSubsystem.h.

View newest version in sPHENIX GitHub at line 83 of file PHG4BbcSubsystem.h

Referenced by InitRunSubsystem().


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