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

Detector Subsystem module. More...

#include <fun4all_eicdetectors/blob/master/simulation/g4simulation/g4beastmagnet/BeastMagnetSubsystem.h>

+ Inheritance diagram for BeastMagnetSubsystem:
+ Collaboration diagram for BeastMagnetSubsystem:

Public Member Functions

 BeastMagnetSubsystem (const std::string &name="BeastMagnet")
 constructor
 
virtual ~BeastMagnetSubsystem ()
 destructor
 
int InitRunSubsystem (PHCompositeNode *) override
 
int process_event (PHCompositeNode *) override
 event processing
 
PHG4DetectorGetDetector () const override
 accessors (reimplemented)
 
PHG4SteppingActionGetSteppingAction () 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
 

Private Attributes

BeastMagnetDetectorm_Detector
 detector construction
 
PHG4SteppingActionm_SteppingAction
 particle tracking "stepping" action
 
PHG4DisplayActionm_DisplayAction
 display attribute setting
 

Additional Inherited Members

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

Detailed Description

Detector Subsystem module.

The detector is constructed and registered via BeastMagnetDetector

See Also
BeastMagnetDetector
BeastMagnetSubsystem

Definition at line 24 of file BeastMagnetSubsystem.h.

View newest version in sPHENIX GitHub at line 24 of file BeastMagnetSubsystem.h

Constructor & Destructor Documentation

BeastMagnetSubsystem::BeastMagnetSubsystem ( const std::string &  name = "BeastMagnet")

constructor

Definition at line 32 of file BeastMagnetSubsystem.cc.

View newest version in sPHENIX GitHub at line 32 of file BeastMagnetSubsystem.cc

References PHG4DetectorSubsystem::InitializeParameters().

+ Here is the call graph for this function:

BeastMagnetSubsystem::~BeastMagnetSubsystem ( )
virtual

destructor

Definition at line 44 of file BeastMagnetSubsystem.cc.

View newest version in sPHENIX GitHub at line 44 of file BeastMagnetSubsystem.cc

References m_DisplayAction.

Member Function Documentation

PHG4Detector * BeastMagnetSubsystem::GetDetector ( void  ) const
overridevirtual

accessors (reimplemented)

Reimplemented from PHG4Subsystem.

Definition at line 113 of file BeastMagnetSubsystem.cc.

View newest version in sPHENIX GitHub at line 113 of file BeastMagnetSubsystem.cc

References m_Detector.

PHG4DisplayAction* BeastMagnetSubsystem::GetDisplayAction ( ) const
inlineoverridevirtual

return pointer to this subsystem display setting

Reimplemented from PHG4Subsystem.

Definition at line 49 of file BeastMagnetSubsystem.h.

View newest version in sPHENIX GitHub at line 49 of file BeastMagnetSubsystem.h

References m_DisplayAction.

PHG4SteppingAction* BeastMagnetSubsystem::GetSteppingAction ( void  ) const
inlineoverridevirtual

return pointer to this subsystem stepping action

Reimplemented from PHG4Subsystem.

Definition at line 48 of file BeastMagnetSubsystem.h.

View newest version in sPHENIX GitHub at line 48 of file BeastMagnetSubsystem.h

References m_SteppingAction.

int BeastMagnetSubsystem::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 50 of file BeastMagnetSubsystem.cc.

View newest version in sPHENIX GitHub at line 50 of file BeastMagnetSubsystem.cc

References PHCompositeNode::addNode(), PHG4DetectorSubsystem::CheckOverlap(), PHNodeIterator::findFirst(), PHG4DetectorSubsystem::get_int_param(), PHG4DetectorSubsystem::GetParams(), m_Detector, m_DisplayAction, m_SteppingAction, Fun4AllBase::Name(), PHG4Detector::OverlapCheck(), BeastMagnetDetector::SuperDetector(), and PHG4DetectorSubsystem::SuperDetector().

+ Here is the call graph for this function:

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

Print info (from SubsysReco)

Reimplemented from SubsysReco.

Definition at line 103 of file BeastMagnetSubsystem.cc.

View newest version in sPHENIX GitHub at line 103 of file BeastMagnetSubsystem.cc

References m_Detector, and BeastMagnetDetector::Print().

+ Here is the call graph for this function:

int BeastMagnetSubsystem::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 92 of file BeastMagnetSubsystem.cc.

View newest version in sPHENIX GitHub at line 92 of file BeastMagnetSubsystem.cc

References m_SteppingAction, and PHG4SteppingAction::SetInterfacePointers().

+ Here is the call graph for this function:

void BeastMagnetSubsystem::SetDefaultParameters ( )
overrideprotectedvirtual

Implements PHG4DetectorSubsystem.

Definition at line 119 of file BeastMagnetSubsystem.cc.

View newest version in sPHENIX GitHub at line 119 of file BeastMagnetSubsystem.cc

References PHG4DetectorSubsystem::set_default_double_param(), and PHG4DetectorSubsystem::set_default_string_param().

+ Here is the call graph for this function:

Member Data Documentation

BeastMagnetDetector* BeastMagnetSubsystem::m_Detector
private

detector construction

derives from PHG4Detector

Definition at line 61 of file BeastMagnetSubsystem.h.

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

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

PHG4DisplayAction* BeastMagnetSubsystem::m_DisplayAction
private

display attribute setting

derives from PHG4DisplayAction

Definition at line 69 of file BeastMagnetSubsystem.h.

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

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

PHG4SteppingAction* BeastMagnetSubsystem::m_SteppingAction
private

particle tracking "stepping" action

derives from PHG4SteppingActions

Definition at line 65 of file BeastMagnetSubsystem.h.

View newest version in sPHENIX GitHub at line 65 of file BeastMagnetSubsystem.h

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


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