Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4Example03Subsystem Class Reference

example Fun4All module More...

#include <g4exampledetector/blob/master/color/source/G4Example03Subsystem.h>

+ Inheritance diagram for G4Example03Subsystem:
+ Collaboration diagram for G4Example03Subsystem:

Public Member Functions

 G4Example03Subsystem (const std::string &name="Example03")
 constructor
 
virtual ~G4Example03Subsystem ()
 destructor
 
virtual int InitRunSubsystem (PHCompositeNode *)
 
virtual int process_event (PHCompositeNode *)
 event processing
 
virtual PHG4DetectorGetDetector () const
 accessors (reimplemented)
 
virtual PHG4SteppingActionGetSteppingAction () const
 return pointer to this subsystem stepping action
 
virtual void Print (const std::string &what="ALL") const
 Print info (from SubsysReco)
 
PHG4DisplayActionGetDisplayAction () const
 return pointer to this subsystem display setting
 
void set_color (const double red, const double green, const double blue, const double alpha=1.)
 
- 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
 
void UseCDB (const std::string &domain)
 
FILE_TYPE get_filetype () const
 
void UseCalibFiles (const FILE_TYPE ftyp)
 
int ReadParamsFromCDB (const std::string &domain)
 
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)
 
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 ()
 

Private Attributes

G4Example03Detectorm_Detector
 detector geometry
 
PHG4SteppingActionm_SteppingAction
 
PHG4DisplayActionm_DisplayAction
 particle tracking "stepping" action
 
std::array< double, 4 > m_ColorArray
 Color setting if we want to override the default.
 

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

example Fun4All module

The detector is constructed and registered via G4Example03Detector

See Also
G4Example03Detector
G4Example03Subsystem

Definition at line 27 of file G4Example03Subsystem.h.

View newest version in sPHENIX GitHub at line 27 of file G4Example03Subsystem.h

Constructor & Destructor Documentation

G4Example03Subsystem::G4Example03Subsystem ( const std::string &  name = "Example03")

constructor

Definition at line 24 of file G4Example03Subsystem.cc.

View newest version in sPHENIX GitHub at line 24 of file G4Example03Subsystem.cc

References PHG4DetectorSubsystem::InitializeParameters().

+ Here is the call graph for this function:

G4Example03Subsystem::~G4Example03Subsystem ( )
virtual

destructor

Definition at line 36 of file G4Example03Subsystem.cc.

View newest version in sPHENIX GitHub at line 36 of file G4Example03Subsystem.cc

References m_DisplayAction.

Member Function Documentation

PHG4Detector * G4Example03Subsystem::GetDetector ( void  ) const
virtual

accessors (reimplemented)

Reimplemented from PHG4Subsystem.

Definition at line 105 of file G4Example03Subsystem.cc.

View newest version in sPHENIX GitHub at line 105 of file G4Example03Subsystem.cc

References m_Detector.

PHG4DisplayAction* G4Example03Subsystem::GetDisplayAction ( ) const
inlinevirtual

return pointer to this subsystem display setting

Reimplemented from PHG4Subsystem.

Definition at line 57 of file G4Example03Subsystem.h.

View newest version in sPHENIX GitHub at line 57 of file G4Example03Subsystem.h

References m_DisplayAction.

virtual PHG4SteppingAction* G4Example03Subsystem::GetSteppingAction ( void  ) const
inlinevirtual

return pointer to this subsystem stepping action

Reimplemented from PHG4Subsystem.

Definition at line 53 of file G4Example03Subsystem.h.

View newest version in sPHENIX GitHub at line 53 of file G4Example03Subsystem.h

References m_SteppingAction.

int G4Example03Subsystem::InitRunSubsystem ( PHCompositeNode topNode)
virtual

creates the m_Detector object and place it on the node tree, under "DETECTORS" node (or whatever) reates the stepping action and place it on the node tree, under "ACTIONS" node creates relevant hit nodes that will be populated by the stepping action and stored in the output DST

Reimplemented from PHG4DetectorSubsystem.

Definition at line 42 of file G4Example03Subsystem.cc.

View newest version in sPHENIX GitHub at line 42 of file G4Example03Subsystem.cc

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

+ Here is the call graph for this function:

void G4Example03Subsystem::Print ( const std::string &  what = "ALL") const
virtual

Print info (from SubsysReco)

Reimplemented from SubsysReco.

Definition at line 95 of file G4Example03Subsystem.cc.

View newest version in sPHENIX GitHub at line 95 of file G4Example03Subsystem.cc

References m_Detector, and G4Example03Detector::Print().

Referenced by Fun4All_G4_Example03().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int G4Example03Subsystem::process_event ( PHCompositeNode topNode)
virtual

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 84 of file G4Example03Subsystem.cc.

View newest version in sPHENIX GitHub at line 84 of file G4Example03Subsystem.cc

References m_SteppingAction, and PHG4SteppingAction::SetInterfacePointers().

+ Here is the call graph for this function:

void G4Example03Subsystem::set_color ( const double  red,
const double  green,
const double  blue,
const double  alpha = 1. 
)
inline

Definition at line 59 of file G4Example03Subsystem.h.

View newest version in sPHENIX GitHub at line 59 of file G4Example03Subsystem.h

References alpha, Acts::Test::blue, Acts::Test::green, m_ColorArray, and Acts::Test::red.

Referenced by Fun4All_G4_Example03().

+ Here is the caller graph for this function:

void G4Example03Subsystem::SetDefaultParameters ( )
privatevirtual

Implements PHG4DetectorSubsystem.

Definition at line 110 of file G4Example03Subsystem.cc.

View newest version in sPHENIX GitHub at line 110 of file G4Example03Subsystem.cc

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

+ Here is the call graph for this function:

Member Data Documentation

std::array<double, 4> G4Example03Subsystem::m_ColorArray
private

Color setting if we want to override the default.

Definition at line 83 of file G4Example03Subsystem.h.

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

Referenced by InitRunSubsystem(), and set_color().

G4Example03Detector* G4Example03Subsystem::m_Detector
private

detector geometry

defives from PHG4Detector

Definition at line 73 of file G4Example03Subsystem.h.

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

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

PHG4DisplayAction* G4Example03Subsystem::m_DisplayAction
private

particle tracking "stepping" action

derives from PHG4SteppingActions display attribute setting

derives from PHG4DisplayAction

Definition at line 81 of file G4Example03Subsystem.h.

View newest version in sPHENIX GitHub at line 81 of file G4Example03Subsystem.h

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

PHG4SteppingAction* G4Example03Subsystem::m_SteppingAction
private

Definition at line 75 of file G4Example03Subsystem.h.

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

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


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