G4UA::CaloG4::CalibrationDefaultProcessing Class Reference

User action for default processing of calibration energy deposits. More...

#include <CalibrationDefaultProcessing.h>

Inheritance diagram for G4UA::CaloG4::CalibrationDefaultProcessing:

Collaboration diagram for G4UA::CaloG4::CalibrationDefaultProcessing:

Classes
struct	Config
	Configuration options for constructing this action. More...

Public Member Functions
	CalibrationDefaultProcessing (const Config &config)
	Constructor.
virtual void	BeginOfEventAction (const G4Event *) override
	the BoE actions
virtual void	UserSteppingAction (const G4Step *) override
	the stepping action
G4VSensitiveDetector *	GetDefaultSD ()
	Make the default sensitive detector available to other routines.
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
Config	m_config
	Configuration options.
G4VSensitiveDetector *	m_defaultSD
	The default sensitive detector to be applied to all G4Steps in volumes without a CalibrationSensitiveDetector.
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

User action for default processing of calibration energy deposits.

04-Mar-2004 William Seligman

21-Sep-2004 WGS: Moved to CaloG4Sim.

The calibration studies rely on every volume in the simulation being made into a sensitive detector. There is a practical problem: What if we're still in the middle of developing code, and not every volume has been made sensitive yet? What if we've overlooked a volume?

This class provides a "default behavior" for all energy deposits that are not made in a volume that's been made sensitive for calibration studies.

Since we need to examine the particles at every G4Step, this class makes use of a UserAction interface class.

Definition at line 43 of file CalibrationDefaultProcessing.h.

Constructor & Destructor Documentation

CalibrationDefaultProcessing()

G4UA::CaloG4::CalibrationDefaultProcessing::CalibrationDefaultProcessing

(

const Config &

config

)

Constructor.

Member Function Documentation

BeginOfEventAction()

virtual void G4UA::CaloG4::CalibrationDefaultProcessing::BeginOfEventAction ( const G4Event * )

overridevirtual

the BoE actions

GetDefaultSD()

G4VSensitiveDetector * G4UA::CaloG4::CalibrationDefaultProcessing::GetDefaultSD ( )

inline

Make the default sensitive detector available to other routines.

Definition at line 65 of file CalibrationDefaultProcessing.h.

{ return m_defaultSD; }

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 163 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 178 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

UserSteppingAction()

virtual void G4UA::CaloG4::CalibrationDefaultProcessing::UserSteppingAction ( const G4Step * )

overridevirtual

the stepping action

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_config

Config G4UA::CaloG4::CalibrationDefaultProcessing::m_config

private

Configuration options.

Definition at line 70 of file CalibrationDefaultProcessing.h.

m_defaultSD

G4VSensitiveDetector* G4UA::CaloG4::CalibrationDefaultProcessing::m_defaultSD

private

The default sensitive detector to be applied to all G4Steps in volumes without a CalibrationSensitiveDetector.

Definition at line 74 of file CalibrationDefaultProcessing.h.

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

---

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

• CalibrationDefaultProcessing.h