McAodWriterTool Class Reference

#include <McAodWriterTool.h>

Inheritance diagram for McAodWriterTool:

Collaboration diagram for McAodWriterTool:

Public Member Functions
	McAodWriterTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor with parameters:
virtual	~McAodWriterTool ()
	Destructor:
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
StatusCode	write (const TruthParticleContainer *mcParts)
	Process the TruthParticleContainer through the I/O backend.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Inline methods:

Protected Member Functions
	McAodWriterTool ()
	Default constructor:
void	setupBackend (Gaudi::Details::PropertyBase &ioBackendURL)
	Method to configure the back-end to write out the TruthParticleContainer.
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
StringProperty	m_ioBackendURL
	URL of the I/O back-end (only "ASCII" for now...) glued with the name of the output file name.
StringProperty	m_truthParticlesName
	Location of the TruthParticleContainer to be written out.
std::ofstream *	m_ioBackend
	Abstract base class for the back-end.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 28 of file McAodWriterTool.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

McAodWriterTool() [1/2]

McAodWriterTool::McAodWriterTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Constructor with parameters:

Public methods:

Constructors

Definition at line 41 of file McAodWriterTool.cxx.

                                             : 
  AthAlgTool( type, name, parent ),
  m_ioBackend( nullptr )
{
  //
  // Property declaration
  // 
 
  declareProperty( "Output", 
           m_ioBackendURL = "ascii:mcaod.txt", 
           "Name of the back-end we'll use to write out the "
           "TruthParticleContainer.\nEx: ascii:mcaod.txt" );
  m_ioBackendURL.declareUpdateHandler( &McAodWriterTool::setupBackend,
                       this );
 
  declareProperty( "TruthParticles",
           m_truthParticlesName = "SpclMC",
           "Input location of the TruthParticleContainer to write out" );
 
  declareInterface<IIOMcAodTool>(this);
}

~McAodWriterTool()

McAodWriterTool::~McAodWriterTool ( )

virtual

Destructor:

Destructor.

Definition at line 67 of file McAodWriterTool.cxx.

{ 
  ATH_MSG_DEBUG("Calling destructor");
 
  if ( m_ioBackend ) {
    delete m_ioBackend;
    m_ioBackend = nullptr;
  }
}

McAodWriterTool() [2/2]

McAodWriterTool::McAodWriterTool ( )

protected

Default constructor:

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode McAodWriterTool::execute ( )

virtual

Implements IIOMcAodTool.

Definition at line 105 of file McAodWriterTool.cxx.

{
  // retrieve the TruthParticles
  const TruthParticleContainer * mcParts = nullptr;
  if ( evtStore()->retrieve( mcParts, m_truthParticlesName ).isFailure() ||
       nullptr == mcParts ) {
    ATH_MSG_WARNING("Could not retrieve a TruthParticleContainer at ["
            << m_truthParticlesName << "] !!");
    return StatusCode::RECOVERABLE;
  }
 
  return write(mcParts);
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

finalize()

StatusCode McAodWriterTool::finalize ( )

virtual

Implements IIOMcAodTool.

Definition at line 96 of file McAodWriterTool.cxx.

{
  ATH_MSG_INFO("Finalizing " << name() << "...");
  ATH_MSG_DEBUG("Closing backend...");
  m_ioBackend->close();
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode McAodWriterTool::initialize ( )

virtual

Implements IIOMcAodTool.

Definition at line 79 of file McAodWriterTool.cxx.

{
  ATH_MSG_INFO("Initializing " << name() << "...");
  // Get pointer to StoreGateSvc and cache it :
  if ( !evtStore().retrieve().isSuccess() ) {
    ATH_MSG_ERROR("Unable to retrieve pointer to StoreGateSvc");
    return StatusCode::FAILURE;
  }
 
  // setup backend
  if ( nullptr == m_ioBackend ) {
    setupBackend(m_ioBackendURL);
  }
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

const InterfaceID & IIOMcAodTool::interfaceID ( )

inlinestaticinherited

Inline methods:

Definition at line 59 of file IIOMcAodTool.h.

{ 
   return IID_IIOMcAodTool; 
}

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setupBackend()

void McAodWriterTool::setupBackend ( Gaudi::Details::PropertyBase & ioBackendURL )

protected

Method to configure the back-end to write out the TruthParticleContainer.

Definition at line 159 of file McAodWriterTool.cxx.

{
  // defaults
  std::string protocol = "ascii";
  std::string fileName = "mcaod.txt";
 
  // reset internal state
  if ( m_ioBackend ) {
    delete m_ioBackend;
    m_ioBackend = nullptr;
  }
 
  // caching URL
  const std::string& url = m_ioBackendURL.value();
  
  std::string::size_type protocolPos = url.find(s_protocolSep);
 
  if ( std::string::npos != protocolPos ) {
    protocol = url.substr( 0, protocolPos );
    fileName = url.substr( protocolPos+1, std::string::npos );
  } else {
    //protocol = "ascii";
    fileName = url;
  }
 
  // get the protocol name in lower cases
  std::transform( protocol.begin(), protocol.end(), 
          protocol.begin(),
          ToLower() );
 
  if ( "ascii" == protocol ) {
    m_ioBackend = new std::ofstream( fileName.c_str(),
                     std::ios::out | std::ios::trunc );
 
  } else {
    ATH_MSG_WARNING("UNKNOWN protocol [" << protocol << "] !!" << endmsg
            << "Will use [ascii] instead...");
    protocol = "ascii";
    m_ioBackend = new std::ofstream( fileName.c_str(),
                     std::ios::out | std::ios::trunc );
  }    
 
  ATH_MSG_DEBUG("Using protocol [" << protocol << "] and write to ["
        << fileName << "]");
}

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

write()

StatusCode McAodWriterTool::write

(

const TruthParticleContainer *

mcParts

)

Process the TruthParticleContainer through the I/O backend.

Non-const methods:

Definition at line 123 of file McAodWriterTool.cxx.

{
  if ( nullptr == mcParts ) {
    ATH_MSG_WARNING("NULL pointer to TruthParticleContainer !!");
    return StatusCode::RECOVERABLE;
  }
 
  std::ofstream& out = *m_ioBackend;
  out << std::fixed;
 
  out << "---" << std::setw(5) << mcParts->size() << std::endl;
  for ( unsigned int i = 0; i != mcParts->size(); ++i ) {
    const TruthParticle* mc = (*mcParts)[i];
    out << "P " << std::setprecision(3) << std::setw(10) << mc->px()
    << " "  << std::setprecision(3) << std::setw(10) << mc->py()
    << " "  << std::setprecision(3) << std::setw(10) << mc->pz()
    << " "  << std::setprecision(3) << std::setw(10) << mc->e()
    << " "  << std::setprecision(3) << std::setw(10) << mc->pdgId()
    << " "  << std::setprecision(3) << std::setw(10) << mc->charge()
    << " "  << std::setprecision(3) << std::setw(10) << HepMC::barcode(mc->genParticle())
    << std::endl;
    out << "EtIsol " 
    << std::setw(3) << TruthParticleParameters::NbrOfCones
    << " : ";
    for ( unsigned int iCone = 0; 
      iCone != TruthParticleParameters::NbrOfCones;
      ++iCone ) {
      out << " " << std::setprecision(3) << std::setw(10) 
      << mc->etIsol(static_cast<TruthParticleParameters::ConeSize>(iCone));
    }
    out << std::endl;
  }
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_ioBackend

std::ofstream* McAodWriterTool::m_ioBackend

protected

Abstract base class for the back-end.

Definition at line 96 of file McAodWriterTool.h.

m_ioBackendURL

StringProperty McAodWriterTool::m_ioBackendURL

protected

URL of the I/O back-end (only "ASCII" for now...) glued with the name of the output file name.

Ex: "ascii:/home/foo/mcaod.txt" If no protocol separator ':' is found, fallback is "ASCII"

Definition at line 88 of file McAodWriterTool.h.

m_truthParticlesName

StringProperty McAodWriterTool::m_truthParticlesName

protected

Location of the TruthParticleContainer to be written out.

Definition at line 92 of file McAodWriterTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• McAodWriterTool.h
• McAodWriterTool.cxx