Detector Subsystem module. More...

#include <coresoftware/blob/master/simulation/g4simulation/g4tpc/PHG4TpcEndCapSubsystem.h>

Inheritance diagram for PHG4TpcEndCapSubsystem:

Collaboration diagram for PHG4TpcEndCapSubsystem:

Public Member Functions
	PHG4TpcEndCapSubsystem (const std::string &name="PHG4TpcEndCap")
	constructor

	~PHG4TpcEndCapSubsystem () override
	destructor

int	InitRunSubsystem (PHCompositeNode *) override

int	process_event (PHCompositeNode *) override
	event processing

PHG4Detector *	GetDetector () const override
	accessors (reimplemented)

PHG4SteppingAction *	GetSteppingAction () const override
	return pointer to this subsystem stepping action

void	Print (const std::string &what="ALL") const override
	Print info (from SubsysReco)

PHG4DisplayAction *	GetDisplayAction () const override
	return pointer to this subsystem display setting

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

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 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.

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
PHG4TpcEndCapDetector *	m_Detector = nullptr
	detector construction

PHG4SteppingAction *	m_SteppingAction = nullptr
	particle tracking "stepping" action

PHG4DisplayAction *	m_DisplayAction = nullptr
	display attribute setting

std::string	m_HitNodeName
	node name for the PHG4Hits

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 PHG4TpcEndCapDetector

See Also: PHG4TpcEndCapDetector; PHG4TpcEndCapSubsystem

Definition at line 26 of file PHG4TpcEndCapSubsystem.h.

View newest version in sPHENIX GitHub at line 26 of file PHG4TpcEndCapSubsystem.h

Constructor & Destructor Documentation

PHG4TpcEndCapSubsystem::PHG4TpcEndCapSubsystem ( const std::string & name = "PHG4TpcEndCap" )

constructor

Definition at line 23 of file PHG4TpcEndCapSubsystem.cc.

View newest version in sPHENIX GitHub at line 23 of file PHG4TpcEndCapSubsystem.cc

References PHG4DetectorSubsystem::InitializeParameters().

Here is the call graph for this function:

PHG4TpcEndCapSubsystem::~PHG4TpcEndCapSubsystem ( )

override

destructor

Definition at line 31 of file PHG4TpcEndCapSubsystem.cc.

View newest version in sPHENIX GitHub at line 31 of file PHG4TpcEndCapSubsystem.cc

References m_DisplayAction.

Member Function Documentation

PHG4Detector * PHG4TpcEndCapSubsystem::GetDetector ( void ) const

overridevirtual

accessors (reimplemented)

Reimplemented from PHG4Subsystem.

Definition at line 109 of file PHG4TpcEndCapSubsystem.cc.

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

References m_Detector.

PHG4DisplayAction* PHG4TpcEndCapSubsystem::GetDisplayAction ( ) const

inlineoverridevirtual

return pointer to this subsystem display setting

Reimplemented from PHG4Subsystem.

Definition at line 54 of file PHG4TpcEndCapSubsystem.h.

View newest version in sPHENIX GitHub at line 54 of file PHG4TpcEndCapSubsystem.h

References m_DisplayAction.

PHG4SteppingAction* PHG4TpcEndCapSubsystem::GetSteppingAction ( void ) const

inlineoverridevirtual

return pointer to this subsystem stepping action

Reimplemented from PHG4Subsystem.

Definition at line 50 of file PHG4TpcEndCapSubsystem.h.

View newest version in sPHENIX GitHub at line 50 of file PHG4TpcEndCapSubsystem.h

References m_SteppingAction.

int PHG4TpcEndCapSubsystem::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 37 of file PHG4TpcEndCapSubsystem.cc.

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

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

Here is the call graph for this function:

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

overridevirtual

Print info (from SubsysReco)

Reimplemented from SubsysReco.

Definition at line 99 of file PHG4TpcEndCapSubsystem.cc.

View newest version in sPHENIX GitHub at line 99 of file PHG4TpcEndCapSubsystem.cc

References m_Detector, and PHG4TpcEndCapDetector::Print().

Here is the call graph for this function:

int PHG4TpcEndCapSubsystem::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 88 of file PHG4TpcEndCapSubsystem.cc.

View newest version in sPHENIX GitHub at line 88 of file PHG4TpcEndCapSubsystem.cc

References m_SteppingAction, and PHG4SteppingAction::SetInterfacePointers().

Here is the call graph for this function:

void PHG4TpcEndCapSubsystem::SetDefaultParameters ( )

overrideprotectedvirtual

Implements PHG4DetectorSubsystem.

Definition at line 115 of file PHG4TpcEndCapSubsystem.cc.

View newest version in sPHENIX GitHub at line 115 of file PHG4TpcEndCapSubsystem.cc

References Acts::UnitConstants::e, PHG4DetectorSubsystem::set_default_double_param(), PHG4DetectorSubsystem::set_default_int_param(), and PHG4DetectorSubsystem::set_default_string_param().

Here is the call graph for this function:

Member Data Documentation

PHG4TpcEndCapDetector* PHG4TpcEndCapSubsystem::m_Detector = nullptr

private

detector construction

derives from PHG4Detector

Definition at line 63 of file PHG4TpcEndCapSubsystem.h.

View newest version in sPHENIX GitHub at line 63 of file PHG4TpcEndCapSubsystem.h

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

PHG4DisplayAction* PHG4TpcEndCapSubsystem::m_DisplayAction = nullptr

private

display attribute setting

derives from PHG4DisplayAction

Definition at line 71 of file PHG4TpcEndCapSubsystem.h.

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

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

std::string PHG4TpcEndCapSubsystem::m_HitNodeName

private

node name for the PHG4Hits

Definition at line 74 of file PHG4TpcEndCapSubsystem.h.

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

Referenced by InitRunSubsystem().

PHG4SteppingAction* PHG4TpcEndCapSubsystem::m_SteppingAction = nullptr

private

particle tracking "stepping" action

derives from PHG4SteppingActions

Definition at line 67 of file PHG4TpcEndCapSubsystem.h.

View newest version in sPHENIX GitHub at line 67 of file PHG4TpcEndCapSubsystem.h

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

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

coresoftware/blob/master/simulation/g4simulation/g4tpc/PHG4TpcEndCapSubsystem.h
coresoftware/blob/master/simulation/g4simulation/g4tpc/PHG4TpcEndCapSubsystem.cc

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation