#include <LegacyBarcodeSvc.h>

Inheritance diagram for Barcode::LegacyBarcodeSvc:

Collaboration diagram for Barcode::LegacyBarcodeSvc:

Classes
struct	BarcodeInfo

Public Member Functions
	LegacyBarcodeSvc (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters. More...

virtual	~LegacyBarcodeSvc ()=default
	Destructor. More...

virtual StatusCode	initialize () override
	Athena algorithm's interface methods. More...

virtual StatusCode	initializeBarcodes (int largestGeneratedParticleBC=0, int largestGeneratedVertexBC=0) override
	Construct and insert a new set of barcode members. More...

virtual StatusCode	resetBarcodes (int largestGeneratedParticleBC=0, int largestGeneratedVertexBC=0) override
	Reset barcodes. More...

virtual int	newSecondaryParticle (int) override
	Generate a new unique barcode for a secondary particle above the simulation offset. More...

virtual int	newGeneratedParticle (int) override
	Generate a new unique particle barcode below the simulation offset (for particles from pre-defined decays) More...

virtual int	newSimulationVertex () override
	Generate a new unique vertex barcode above the simulation offset. More...

virtual int	newGeneratedVertex () override
	Generate a new unique vertex barcode below the simulation offset. More...

virtual void	registerLargestGeneratedParticleBC (int bc) override
	Inform the BarcodeSvc about the largest particle and vertex Barcodes in the event input. More...

virtual void	registerLargestGeneratedVtxBC (int bc) override

virtual void	registerLargestSecondaryParticleBC (int bc) override

virtual void	registerLargestSimulationVtxBC (int bc) override

virtual int	secondaryParticleBcOffset () const override
	Return the secondary particle and vertex offsets. More...

virtual int	secondaryVertexBcOffset () const override
	Return the secondary vertex offset. More...

Private Types
using	LegacyBarcodeSvcThreadMap_t = tbb::concurrent_unordered_map< std::thread::id, BarcodeInfo, std::hash< std::thread::id > >

Private Member Functions
BarcodeInfo &	getBarcodeInfo ()

Private Attributes
int	m_firstVertex
	barcode information used for GenVertices More...

int	m_vertexIncrement

int	m_firstSecondary
	barcode information used for secondary GenParticles More...

int	m_particleIncrement

LegacyBarcodeSvcThreadMap_t	m_bcThreadMap

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

Member Typedef Documentation

◆ LegacyBarcodeSvcThreadMap_t

using Barcode::LegacyBarcodeSvc::LegacyBarcodeSvcThreadMap_t = tbb::concurrent_unordered_map < std::thread::id, BarcodeInfo, std::hash<std::thread::id> >

private

Definition at line 96 of file LegacyBarcodeSvc.h.

Constructor & Destructor Documentation

◆ LegacyBarcodeSvc()

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

Constructor with parameters.

Constructor.

Definition at line 11 of file LegacyBarcodeSvc.cxx.

                                                                                 :
   base_class(name,svc),
   m_firstVertex(-HepMC::SIM_BARCODE_THRESHOLD-1),
   m_vertexIncrement(-1),
   m_firstSecondary(HepMC::SIM_BARCODE_THRESHOLD+1),
   m_particleIncrement(1)
 {
 }

◆ ~LegacyBarcodeSvc()

virtual Barcode::LegacyBarcodeSvc::~LegacyBarcodeSvc ( )

virtualdefault

Destructor.

Member Function Documentation

◆ getBarcodeInfo()

Barcode::LegacyBarcodeSvc::BarcodeInfo & Barcode::LegacyBarcodeSvc::getBarcodeInfo ( )

private

Definition at line 61 of file LegacyBarcodeSvc.cxx.

                                                                             {
     const auto tid = std::this_thread::get_id();
     auto bcPair = m_bcThreadMap.find(tid);
     if ( bcPair == m_bcThreadMap.end() ) {
       ATH_MSG_WARNING( "getBarcodeInfo: failed to find BarcodeInfo for thread ID " << tid << ", created a new one." );
       Barcode::LegacyBarcodeSvc::BarcodeInfo barcodeInfo = BarcodeInfo(-HepMC::SIM_BARCODE_THRESHOLD, HepMC::SIM_BARCODE_THRESHOLD, 0, 0);
       auto result = m_bcThreadMap.insert( std::make_pair( tid, barcodeInfo ) );
       if (result.second) {
         auto bcPair = m_bcThreadMap.find(tid);
         return bcPair->second;
       }
       ATH_MSG_ERROR ( "getBarcodeInfo: could not add a the new BarcodeInfo object to the map!" );
       return m_bcThreadMap.begin()->second;
     }
     return bcPair->second;
 }

◆ initialize()

StatusCode Barcode::LegacyBarcodeSvc::initialize ( )

overridevirtual

Athena algorithm's interface methods.

framework methods

Definition at line 22 of file LegacyBarcodeSvc.cxx.

 {
   ATH_MSG_VERBOSE ("initialize() ...");
   ATH_MSG_DEBUG( "LegacyBarcodeSvc start of initialize in thread ID: " << std::this_thread::get_id() );
  
   ATH_CHECK( this->initializeBarcodes() );
  
   ATH_MSG_VERBOSE ("initialize() successful");
   return StatusCode::SUCCESS;
 }

◆ initializeBarcodes()

StatusCode Barcode::LegacyBarcodeSvc::initializeBarcodes	(	int	largestGeneratedParticleBC = `0`,
		int	largestGeneratedVertexBC = `0`
	)

overridevirtual

Construct and insert a new set of barcode members.

To be called for every new thread.

Definition at line 34 of file LegacyBarcodeSvc.cxx.

                                                                                                                    {
     static std::mutex barcodeMutex;
     std::lock_guard<std::mutex> barcodeLock(barcodeMutex);
     ATH_MSG_DEBUG( name() << "::initializeBarcodes()" );
  
   // look for pair containing barcode info using the thread ID
   // if it doesn't exist, construct one and insert it.
   const auto tid = std::this_thread::get_id();
   auto bcPair = m_bcThreadMap.find(tid);
   if ( bcPair == m_bcThreadMap.end() ) {
     auto result = m_bcThreadMap.insert( std::make_pair( tid, BarcodeInfo(-HepMC::SIM_BARCODE_THRESHOLD, HepMC::SIM_BARCODE_THRESHOLD, largestGeneratedVertexBC, largestGeneratedParticleBC) ) );
       if (result.second) {
           ATH_MSG_DEBUG( "initializeBarcodes: initialized new barcodes for thread ID " << tid );
           ATH_CHECK( this->resetBarcodes(largestGeneratedParticleBC, largestGeneratedVertexBC) );
           ATH_MSG_DEBUG( "initializeBarcodes: reset new barcodes for thread ID " << tid );
       } else {
           ATH_MSG_ERROR( "initializeBarcodes: failed to initialize new barcode for thread ID " << tid );
       }
   } else {
       ATH_MSG_DEBUG( "initializeBarcodes: barcodes for this thread ID found, did not construct new" );
       ATH_CHECK( this->resetBarcodes(largestGeneratedParticleBC, largestGeneratedVertexBC) );
       ATH_MSG_DEBUG( "initializeBarcodes: reset existing barcodes for thread ID " << tid );
   }
   return StatusCode::SUCCESS;
 }

◆ newGeneratedParticle()

int Barcode::LegacyBarcodeSvc::newGeneratedParticle ( int )

overridevirtual

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

Generate a new unique barcode for a particle produced in a pre-defined decay

Definition at line 149 of file LegacyBarcodeSvc.cxx.

 {
   BarcodeInfo& bc = getBarcodeInfo();
   bc.currentGeneratedParticle += m_particleIncrement;
   // a naive overflow checking based on the fact that particle
   // barcodes should never be negative
   if (bc.currentGeneratedParticle < 0)
     {
       ATH_MSG_WARNING("LegacyBarcodeSvc::newGeneratedParticle()"
                     << " will return a particle barcode of less than 0: "
                     << bc.currentGeneratedParticle << ". Reset to "
                     << HepMC::UNDEFINED_ID);
  
       bc.currentGeneratedParticle = HepMC::UNDEFINED_ID;
     }
   if ( bc.currentGeneratedParticle > HepMC::SIM_BARCODE_THRESHOLD) {
       ATH_MSG_ERROR("LegacyBarcodeSvc::newGeneratedParticle()"
                     << " will return a particle barcode below "
                     << -HepMC::SIM_BARCODE_THRESHOLD << ": "
                     << bc.currentGeneratedParticle << ". Expect clashes with simulation particles.");
     }
  
   return bc.currentGeneratedParticle;
 }

◆ newGeneratedVertex()

int Barcode::LegacyBarcodeSvc::newGeneratedVertex ( )

overridevirtual

Generate a new unique vertex barcode below the simulation offset.

Generate a new unique vertex barcode for pre-defined decay vertices.

Definition at line 123 of file LegacyBarcodeSvc.cxx.

 {
   BarcodeInfo& bc = getBarcodeInfo();
   bc.currentGeneratedVertex += m_vertexIncrement;
   // a naive underflog checking based on the fact that vertex
   // barcodes should never be positive
   if ( bc.currentGeneratedVertex > 0) {
       ATH_MSG_WARNING("LegacyBarcodeSvc::newGeneratedVertex()"
                     << " will return a vertex barcode greater than 0: "
                     << bc.currentGeneratedVertex << ". Reset to "
                     << HepMC::UNDEFINED_ID);
  
       bc.currentGeneratedVertex = HepMC::UNDEFINED_ID;
     }
   if ( bc.currentGeneratedVertex < -HepMC::SIM_BARCODE_THRESHOLD) {
       ATH_MSG_ERROR("LegacyBarcodeSvc::newGeneratedVertex()"
                     << " will return a vertex barcode below "
                     << -HepMC::SIM_BARCODE_THRESHOLD << ": "
                     << bc.currentGeneratedVertex << ". Expect clashes with simulation vertices.");
     }
  
   return bc.currentGeneratedVertex;
 }

◆ newSecondaryParticle()

int Barcode::LegacyBarcodeSvc::newSecondaryParticle ( int )

overridevirtual

Generate a new unique barcode for a secondary particle above the simulation offset.

Generate a new unique barcode for a secondary particle.

Definition at line 101 of file LegacyBarcodeSvc.cxx.

 {
   BarcodeInfo& bc = getBarcodeInfo();
   bc.currentSecondaryParticle += m_particleIncrement;
   // a naive overflow checking based on the fact that particle
   // barcodes should never be negative
   if (bc.currentSecondaryParticle < HepMC::SIM_BARCODE_THRESHOLD)
     {
       ATH_MSG_WARNING("LegacyBarcodeSvc::newSecondaryParticle()"
                     << " will return a particle barcode of less than "
                     << HepMC::SIM_BARCODE_THRESHOLD << ": "
                     << bc.currentSecondaryParticle << ". Reset to "
                     << HepMC::UNDEFINED_ID);
  
       bc.currentSecondaryParticle = HepMC::UNDEFINED_ID;
     }
  
   return bc.currentSecondaryParticle;
 }

◆ newSimulationVertex()

int Barcode::LegacyBarcodeSvc::newSimulationVertex ( )

overridevirtual

Generate a new unique vertex barcode above the simulation offset.

Generate a new unique vertex simulated barcode.

Definition at line 80 of file LegacyBarcodeSvc.cxx.

 {
   BarcodeInfo& bc = getBarcodeInfo();
   bc.currentSimulationVertex += m_vertexIncrement;
   // a naive underflog checking based on the fact that vertex
   // barcodes should never be positive
   if ( bc.currentSimulationVertex > -HepMC::SIM_BARCODE_THRESHOLD)
     {
       ATH_MSG_WARNING("LegacyBarcodeSvc::newSimulationVertex()"
                     << " will return a vertex barcode greater than "
                     << -HepMC::SIM_BARCODE_THRESHOLD << ": "
                     << bc.currentSimulationVertex << ". Reset to "
                     << HepMC::UNDEFINED_ID);
       bc.currentSimulationVertex = HepMC::UNDEFINED_ID;
     }
  
   return bc.currentSimulationVertex;
 }

◆ registerLargestGeneratedParticleBC()

void Barcode::LegacyBarcodeSvc::registerLargestGeneratedParticleBC ( int bc )

overridevirtual

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

Definition at line 175 of file LegacyBarcodeSvc.cxx.

                                                                          {
     ATH_MSG_DEBUG( "registering largest generated particle barcode" );
     BarcodeInfo& barcodeInfo = getBarcodeInfo();
     barcodeInfo.currentGeneratedParticle = bc;
 }

◆ registerLargestGeneratedVtxBC()

void Barcode::LegacyBarcodeSvc::registerLargestGeneratedVtxBC ( int bc )

overridevirtual

Definition at line 182 of file LegacyBarcodeSvc.cxx.

                                                                     {
     ATH_MSG_DEBUG( "registering largest generated particle barcode" );
     BarcodeInfo& barcodeInfo = getBarcodeInfo();
     barcodeInfo.currentGeneratedVertex = bc;
 }

◆ registerLargestSecondaryParticleBC()

void Barcode::LegacyBarcodeSvc::registerLargestSecondaryParticleBC ( int bc )

overridevirtual

Definition at line 189 of file LegacyBarcodeSvc.cxx.

189 {

190 }

◆ registerLargestSimulationVtxBC()

void Barcode::LegacyBarcodeSvc::registerLargestSimulationVtxBC ( int bc )

overridevirtual

Definition at line 193 of file LegacyBarcodeSvc.cxx.

193 {

194 }

◆ resetBarcodes()

StatusCode Barcode::LegacyBarcodeSvc::resetBarcodes	(	int	largestGeneratedParticleBC = `0`,
		int	largestGeneratedVertexBC = `0`
	)

overridevirtual

Reset barcodes.

To be called at the beginning of each event.

Definition at line 209 of file LegacyBarcodeSvc.cxx.

 {
     ATH_MSG_DEBUG( "resetBarcodes: resetting barcodes" );
     BarcodeInfo& bc = getBarcodeInfo();
     bc.currentSimulationVertex = m_firstVertex - m_vertexIncrement;
     bc.currentSecondaryParticle = m_firstSecondary - m_particleIncrement;
     bc.currentGeneratedVertex = largestGeneratedVertexBC;
     bc.currentGeneratedParticle = largestGeneratedParticleBC;
  
     return StatusCode::SUCCESS;
 }

◆ secondaryParticleBcOffset()

int Barcode::LegacyBarcodeSvc::secondaryParticleBcOffset ( ) const

overridevirtual

Return the secondary particle and vertex offsets.

Return the secondary particle offset.

Definition at line 198 of file LegacyBarcodeSvc.cxx.

                                                              {
   return m_firstSecondary;
 }

◆ secondaryVertexBcOffset()

int Barcode::LegacyBarcodeSvc::secondaryVertexBcOffset ( ) const

overridevirtual

Return the secondary vertex offset.

Definition at line 204 of file LegacyBarcodeSvc.cxx.

                                                            {
   return m_firstVertex;
 }

Member Data Documentation

◆ m_bcThreadMap

LegacyBarcodeSvcThreadMap_t Barcode::LegacyBarcodeSvc::m_bcThreadMap

private

Definition at line 98 of file LegacyBarcodeSvc.h.

◆ m_firstSecondary

int Barcode::LegacyBarcodeSvc::m_firstSecondary

private

barcode information used for secondary GenParticles

Definition at line 80 of file LegacyBarcodeSvc.h.

◆ m_firstVertex

int Barcode::LegacyBarcodeSvc::m_firstVertex

private

barcode information used for GenVertices

Definition at line 76 of file LegacyBarcodeSvc.h.

◆ m_particleIncrement

int Barcode::LegacyBarcodeSvc::m_particleIncrement

private

Definition at line 81 of file LegacyBarcodeSvc.h.

◆ m_vertexIncrement

int Barcode::LegacyBarcodeSvc::m_vertexIncrement

private

Definition at line 77 of file LegacyBarcodeSvc.h.

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

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ LegacyBarcodeSvcThreadMap_t

Constructor & Destructor Documentation

◆ LegacyBarcodeSvc()

◆ ~LegacyBarcodeSvc()

Member Function Documentation

◆ getBarcodeInfo()

◆ initialize()

◆ initializeBarcodes()

◆ newGeneratedParticle()

◆ newGeneratedVertex()

◆ newSecondaryParticle()

◆ newSimulationVertex()

◆ registerLargestGeneratedParticleBC()

◆ registerLargestGeneratedVtxBC()

◆ registerLargestSecondaryParticleBC()

◆ registerLargestSimulationVtxBC()

◆ resetBarcodes()

◆ secondaryParticleBcOffset()

◆ secondaryVertexBcOffset()

Member Data Documentation

◆ m_bcThreadMap

◆ m_firstSecondary

◆ m_firstVertex

◆ m_particleIncrement

◆ m_vertexIncrement