Barcode::ValidationBarcodeSvc Class Reference

#include <ValidationBarcodeSvc.h>

Inheritance diagram for Barcode::ValidationBarcodeSvc:

Collaboration diagram for Barcode::ValidationBarcodeSvc:

Public Member Functions
	ValidationBarcodeSvc (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters. More...
virtual	~ValidationBarcodeSvc ()
	Destructor. More...
virtual StatusCode	initialize () override
	Athena algorithm's interface methods. More...
virtual StatusCode	finalize () override
	framework methods More...
virtual void	handle (const Incident &inc) override
	Incident to reset the barcodes at the beginning of the event. More...
virtual int	newSimulationVertex () override
	Generate a new unique vertex barcode, based on the parent particle barcode and the physics process code causing the truth vertex. More...
virtual int	newSecondaryParticle (int parentBC=HepMC::UNDEFINED_ID) override
	Generate a new unique barcode for a secondary particle, based on the parent particle barcode. More...
virtual int	newGeneratedParticle (int parentBC=HepMC::UNDEFINED_ID) override
	Generate a new unique particle barcode below the simulation offset (for particles from pre-defined decays) More...
virtual int	newGeneratedVertex () override
	Generate a new unique vertex barcode below the simulation offset. More...
virtual int	secondaryParticleBcOffset () const override
	Return the secondary particle and vertex offsets. More...
virtual int	secondaryVertexBcOffset () const override
	Return the secondary vertex offset. More...
virtual void	registerLargestGeneratedParticleBC (int) override
	Inform the BarcodeSvc about the largest particle and vertex Barcodes in the event input. More...
virtual void	registerLargestGeneratedVtxBC (int) override
virtual void	registerLargestSecondaryParticleBC (int) override
virtual void	registerLargestSimulationVtxBC (int) override

Private Attributes
ServiceHandle< IIncidentSvc >	m_incidentSvc
	IncidentSvc to catch begin of event and end of envent. More...
int	m_firstVertex
	barcode information used for GenVertices More...
int	m_vertexIncrement
int	m_currentVertex
int	m_firstSecondary
	barcode information used for secondary GenParticles More...
int	m_secondaryIncrement
int	m_currentSecondary
int	m_particleGenerationIncrement
	barcode offset for each generation of updated particles More...
int	m_barcodeGenerationOffset
	not sure why this is needed... More...

Detailed Description

This BarcodeService reproduces the barcode treatmend for MC12: http://acode-browser.usatlas.bnl.gov/lxr/source/atlas/Simulation/G4Sim/MCTruth/src/TruthStrategyManager.cxx

Author

Andreas.Salzburger -at- cern.ch , Elmar.Ritsch -at- cern.ch

Definition at line 32 of file ValidationBarcodeSvc.h.

Constructor & Destructor Documentation

ValidationBarcodeSvc()

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

Constructor with parameters.

Constructor.

Definition at line 12 of file ValidationBarcodeSvc.cxx.

                                                                                        :
  base_class(name,svc),
  m_incidentSvc("IncidentSvc", name),
  m_firstVertex(-HepMC::SIM_BARCODE_THRESHOLD-1),
  m_vertexIncrement(-1),
  m_currentVertex(-1),
  m_firstSecondary(HepMC::SIM_BARCODE_THRESHOLD+1),
  m_secondaryIncrement(1),
  m_currentSecondary(1),
  m_particleGenerationIncrement(HepMC::SIM_REGENERATION_INCREMENT),
  m_barcodeGenerationOffset(1e8)
{
  // python properties
  declareProperty("VertexIncrement"            ,  m_vertexIncrement);
  declareProperty("SecondaryIncrement"         ,  m_secondaryIncrement);
  declareProperty("BarcodeGenerationOffset"    ,  m_barcodeGenerationOffset);
}

~ValidationBarcodeSvc()

Barcode::ValidationBarcodeSvc::~ValidationBarcodeSvc ( )

virtual

Destructor.

Definition at line 31 of file ValidationBarcodeSvc.cxx.

{}

Member Function Documentation

finalize()

StatusCode Barcode::ValidationBarcodeSvc::finalize ( )

overridevirtual

framework methods

Definition at line 148 of file ValidationBarcodeSvc.cxx.

{
  ATH_MSG_VERBOSE ("finalize() ...");
  ATH_MSG_VERBOSE ("finalize() successful");
  return StatusCode::SUCCESS;
}

handle()

void Barcode::ValidationBarcodeSvc::handle ( const Incident &  inc )

overridevirtual

Incident to reset the barcodes at the beginning of the event.

Handle incident.

Definition at line 136 of file ValidationBarcodeSvc.cxx.

{
  if ( inc.type() == IncidentType::BeginEvent )
    {
      ATH_MSG_VERBOSE("'BeginEvent' incident caught. Resetting Vertex and Particle barcode counters.");
      m_currentVertex    = m_firstVertex    - m_vertexIncrement;
      m_currentSecondary = m_firstSecondary - m_secondaryIncrement;
    }
}

initialize()

StatusCode Barcode::ValidationBarcodeSvc::initialize ( )

overridevirtual

Athena algorithm's interface methods.

framework methods

Definition at line 36 of file ValidationBarcodeSvc.cxx.

{
  ATH_MSG_VERBOSE ("initialize() ...");
 
  CHECK( m_incidentSvc.retrieve() );
 
  // register to the incident service: BeginEvent needed for refresh of counter
  m_incidentSvc->addListener( this, IncidentType::BeginEvent);
 
  ATH_MSG_VERBOSE ("initialize() successful");
  return StatusCode::SUCCESS;
}

newGeneratedParticle()

int Barcode::ValidationBarcodeSvc::newGeneratedParticle ( int  parentBC = HepMC::UNDEFINED_ID )

overridevirtual

Generate a new unique particle barcode below the simulation offset (for particles from pre-defined decays)

Definition at line 87 of file ValidationBarcodeSvc.cxx.

{
  m_currentSecondary += m_secondaryIncrement;
  // a naive overflow checking based on the fact that particle
  // barcodes should never be negative
  if ( m_currentSecondary < 0)
    {
      ATH_MSG_ERROR("ValidationBarcodeSvc::newGeneratedParticle(...)"
                    << " will return a particle barcode of less than 0: "
                    << m_currentSecondary << ". Possibly Integer Overflow?");
    }
  int primGen = int( (parentBC-m_particleGenerationIncrement) / m_barcodeGenerationOffset);
  int returnBC = m_currentSecondary + (primGen+1)*m_barcodeGenerationOffset;
 
  return returnBC;
}

newGeneratedVertex()

int Barcode::ValidationBarcodeSvc::newGeneratedVertex ( )

overridevirtual

Generate a new unique vertex barcode below the simulation offset.

Generate a new unique vertex barcode.

Definition at line 106 of file ValidationBarcodeSvc.cxx.

{
  m_currentVertex += m_vertexIncrement;
  // a naive underflog checking based on the fact that vertex
  // barcodes should never be positive
  if ( m_currentVertex > 0)
    {
      ATH_MSG_ERROR("ValidationBarcodeSvc::newGeneratedVertex(...)"
                    << " will return a vertex barcode greater than 0: "
                    << m_currentVertex << ". Possibly Integer Underflow?");
    }
  return m_currentVertex;
}

newSecondaryParticle()

int Barcode::ValidationBarcodeSvc::newSecondaryParticle ( int  parentBC = HepMC::UNDEFINED_ID )

overridevirtual

Generate a new unique barcode for a secondary particle, based on the parent particle barcode.

Definition at line 68 of file ValidationBarcodeSvc.cxx.

{
  m_currentSecondary += m_secondaryIncrement;
  // a naive overflow checking based on the fact that particle
  // barcodes should never be negative
  if ( m_currentSecondary < 0)
    {
      ATH_MSG_ERROR("ValidationBarcodeSvc::newSecondaryParticle(...)"
                    << " will return a particle barcode of less than 0: "
                    << m_currentSecondary << ". Possibly Integer Overflow?");
    }
  int primGen = int( (parentBC-m_particleGenerationIncrement) / m_barcodeGenerationOffset);
  int returnBC = m_currentSecondary + (primGen+1)*m_barcodeGenerationOffset;
 
  return returnBC;
}

newSimulationVertex()

int Barcode::ValidationBarcodeSvc::newSimulationVertex ( )

overridevirtual

Generate a new unique vertex barcode, based on the parent particle barcode and the physics process code causing the truth vertex.

Generate a new unique vertex barcode.

Definition at line 51 of file ValidationBarcodeSvc.cxx.

{
  m_currentVertex += m_vertexIncrement;
  // a naive underflog checking based on the fact that vertex
  // barcodes should never be positive
  if ( m_currentVertex > 0)
    {
      ATH_MSG_ERROR("ValidationBarcodeSvc::newVertex(...)"
                    << " will return a vertex barcode greater than 0: "
                    << m_currentVertex << ". Possibly Integer Underflow?");
    }
  return m_currentVertex;
}

registerLargestGeneratedParticleBC()

virtual void Barcode::ValidationBarcodeSvc::registerLargestGeneratedParticleBC ( int  )

inlineoverridevirtual

Inform the BarcodeSvc about the largest particle and vertex Barcodes in the event input.

Definition at line 68 of file ValidationBarcodeSvc.h.

{};

registerLargestGeneratedVtxBC()

virtual void Barcode::ValidationBarcodeSvc::registerLargestGeneratedVtxBC ( int  )

inlineoverridevirtual

Definition at line 69 of file ValidationBarcodeSvc.h.

{};

registerLargestSecondaryParticleBC()

virtual void Barcode::ValidationBarcodeSvc::registerLargestSecondaryParticleBC ( int  )

inlineoverridevirtual

Definition at line 70 of file ValidationBarcodeSvc.h.

{};

registerLargestSimulationVtxBC()

virtual void Barcode::ValidationBarcodeSvc::registerLargestSimulationVtxBC ( int  )

inlineoverridevirtual

Definition at line 71 of file ValidationBarcodeSvc.h.

{};

secondaryParticleBcOffset()

int Barcode::ValidationBarcodeSvc::secondaryParticleBcOffset ( ) const

overridevirtual

Return the secondary particle and vertex offsets.

Return the secondary particle offset.

Definition at line 122 of file ValidationBarcodeSvc.cxx.

{
  return m_firstSecondary;
}

secondaryVertexBcOffset()

int Barcode::ValidationBarcodeSvc::secondaryVertexBcOffset ( ) const

overridevirtual

Return the secondary vertex offset.

Definition at line 129 of file ValidationBarcodeSvc.cxx.

{
  return m_firstVertex;
}

Member Data Documentation

m_barcodeGenerationOffset

int Barcode::ValidationBarcodeSvc::m_barcodeGenerationOffset

private

not sure why this is needed...

Definition at line 88 of file ValidationBarcodeSvc.h.

m_currentSecondary

int Barcode::ValidationBarcodeSvc::m_currentSecondary

private

Definition at line 84 of file ValidationBarcodeSvc.h.

m_currentVertex

int Barcode::ValidationBarcodeSvc::m_currentVertex

private

Definition at line 79 of file ValidationBarcodeSvc.h.

m_firstSecondary

int Barcode::ValidationBarcodeSvc::m_firstSecondary

private

barcode information used for secondary GenParticles

Definition at line 82 of file ValidationBarcodeSvc.h.

m_firstVertex

int Barcode::ValidationBarcodeSvc::m_firstVertex

private

barcode information used for GenVertices

Definition at line 77 of file ValidationBarcodeSvc.h.

m_incidentSvc

ServiceHandle<IIncidentSvc> Barcode::ValidationBarcodeSvc::m_incidentSvc

private

IncidentSvc to catch begin of event and end of envent.

Definition at line 74 of file ValidationBarcodeSvc.h.

m_particleGenerationIncrement

int Barcode::ValidationBarcodeSvc::m_particleGenerationIncrement

private

barcode offset for each generation of updated particles

Definition at line 87 of file ValidationBarcodeSvc.h.

m_secondaryIncrement

int Barcode::ValidationBarcodeSvc::m_secondaryIncrement

private

Definition at line 83 of file ValidationBarcodeSvc.h.

m_vertexIncrement

int Barcode::ValidationBarcodeSvc::m_vertexIncrement

private

Definition at line 78 of file ValidationBarcodeSvc.h.

---

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

• ValidationBarcodeSvc.h
• ValidationBarcodeSvc.cxx