ConstantFieldSvc Class Reference

#include <ConstantFieldSvc.h>

Inheritance diagram for ConstantFieldSvc:

Collaboration diagram for ConstantFieldSvc:

Public Member Functions
	ConstantFieldSvc (const std::string &name, ISvcLocator *pSvcLocator)
	Basic constructor and destructor. More...
	~ConstantFieldSvc ()=default
StatusCode	initialize () override final
	Athena method. More...
G4MagneticField *	getField () override final
	Retrieve a G4 magnetic field object. More...

Protected Member Functions
G4MagneticField *	makeField () override final
	Create the field object. More...

Protected Attributes
thread_utils::ThreadLocalOwner< G4MagneticField >	m_fieldHolder
	Thread-local field object. More...

Private Attributes
Field vector components - What are the units??
Gaudi::Property< double >	m_fieldX {this, "FieldX", 0., "Field X component"}
Gaudi::Property< double >	m_fieldY {this, "FieldY", 0., "Field Y component"}
Gaudi::Property< double >	m_fieldZ {this, "FieldZ", 0., "Field Z component"}

Detailed Description

Todo:

Needs documentation

Definition at line 19 of file ConstantFieldSvc.h.

Constructor & Destructor Documentation

ConstantFieldSvc()

ConstantFieldSvc::ConstantFieldSvc	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Basic constructor and destructor.

Definition at line 10 of file ConstantFieldSvc.cxx.

  : G4MagFieldSvcBase(name, pSvcLocator)
{
}

~ConstantFieldSvc()

ConstantFieldSvc::~ConstantFieldSvc ( )

default

Member Function Documentation

getField()

G4MagneticField * G4MagFieldSvcBase::getField ( )

finaloverrideinherited

Retrieve a G4 magnetic field object.

If one doesn't yet exist in the current thread, it will be created.

Definition at line 29 of file G4MagFieldSvcBase.cxx.

{
  ATH_MSG_DEBUG("G4MagFieldSvcBase::getField");
 
  // Check if we already have a field setup for current thread
  auto field = m_fieldHolder.get();
  // If not, we create one
  if(!field) {
    field = makeField();
    m_fieldHolder.set(field);
  }
 
  return field;
}

initialize()

StatusCode ConstantFieldSvc::initialize ( )

finaloverride

Athena method.

called at initialization time, being customized here

Definition at line 15 of file ConstantFieldSvc.cxx.

{
  ATH_MSG_DEBUG( "Initializing " << name() );
  return StatusCode::SUCCESS;
}

makeField()

G4MagneticField * ConstantFieldSvc::makeField ( )

finaloverrideprotectedvirtual

Create the field object.

Implements G4MagFieldSvcBase.

Definition at line 21 of file ConstantFieldSvc.cxx.

{
  ATH_MSG_VERBOSE( "ConstantFieldSvc::makeField" );
  const G4ThreeVector fieldVec(m_fieldX, m_fieldY, m_fieldZ);
  return new G4UniformMagField(fieldVec);
}

Member Data Documentation

m_fieldHolder

thread_utils::ThreadLocalOwner<G4MagneticField> G4MagFieldSvcBase::m_fieldHolder

protectedinherited

Thread-local field object.

Definition at line 48 of file G4MagFieldSvcBase.h.

m_fieldX

Gaudi::Property<double> ConstantFieldSvc::m_fieldX {this, "FieldX", 0., "Field X component"}

private

Definition at line 39 of file ConstantFieldSvc.h.

m_fieldY

Gaudi::Property<double> ConstantFieldSvc::m_fieldY {this, "FieldY", 0., "Field Y component"}

private

Definition at line 40 of file ConstantFieldSvc.h.

m_fieldZ

Gaudi::Property<double> ConstantFieldSvc::m_fieldZ {this, "FieldZ", 0., "Field Z component"}

private

Definition at line 41 of file ConstantFieldSvc.h.

---

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

• ConstantFieldSvc.h
• ConstantFieldSvc.cxx