Trk::TrackCollectionProvider Class Reference

#include <TrackCollectionProvider.h>

Inheritance diagram for Trk::TrackCollectionProvider:

Collaboration diagram for Trk::TrackCollectionProvider:

Public Member Functions
	TrackCollectionProvider (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~TrackCollectionProvider ()
StatusCode	initialize ()
StatusCode	finalize ()
StatusCode	trackCollection (const TrackCollection *&tracks)
virtual void	setLogStream (std::ostream *os)
	sets the output stream for the logfile
virtual void	setNtuple (TFile *)
	sets ntuple
virtual StatusCode	fillNtuple ()
	writes tree to ntuple
virtual void	printSummary ()
	Print statistical summary to logfile.
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 ()

Protected Member Functions
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
std::ostream *	m_logStream = nullptr
	logfile output stream

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
Gaudi::Property< std::string >	m_inputCol
int	m_nRetrievalErrors = 0
	number of retrieval errors at the beginning of the job
Gaudi::Property< int >	m_maxRetrievalErrors
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 25 of file TrackCollectionProvider.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

TrackCollectionProvider()

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

Definition at line 10 of file TrackCollectionProvider.cxx.

    : AthAlgTool(type,name,parent)
  {
    declareInterface<ITrackCollectionProvider>(this);
  }

~TrackCollectionProvider()

TrackCollectionProvider::~TrackCollectionProvider ( )

virtualdefault

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; }

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

fillNtuple()

virtual StatusCode Trk::ITrackCollectionProvider::fillNtuple ( )

inlinevirtualinherited

writes tree to ntuple

Reimplemented in Trk::MSConstraintTracksProvider.

Definition at line 46 of file ITrackCollectionProvider.h.

{ return StatusCode::SUCCESS; }

finalize()

StatusCode TrackCollectionProvider::finalize

(

)

Definition at line 30 of file TrackCollectionProvider.cxx.

  {
    return StatusCode::SUCCESS;
  }

initialize()

StatusCode TrackCollectionProvider::initialize

(

)

Definition at line 24 of file TrackCollectionProvider.cxx.

  {
    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 & ITrackCollectionProvider::interfaceID ( )

inlinestaticinherited

Definition at line 57 of file ITrackCollectionProvider.h.

                                                                  {
    return   IID_TRK_ITrackCollectionProvider;
  }

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.

printSummary()

virtual void Trk::ITrackCollectionProvider::printSummary ( )

inlinevirtualinherited

Print statistical summary to logfile.

Reimplemented in Trk::ConstrainedTrackProvider, and Trk::MSConstraintTracksProvider.

Definition at line 50 of file ITrackCollectionProvider.h.

{}

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();
  }

setLogStream()

virtual void Trk::ITrackCollectionProvider::setLogStream ( std::ostream * os )

inlinevirtualinherited

sets the output stream for the logfile

Definition at line 40 of file ITrackCollectionProvider.h.

{ m_logStream = os; }

setNtuple()

virtual void Trk::ITrackCollectionProvider::setNtuple ( TFile * )

inlinevirtualinherited

sets ntuple

Reimplemented in Trk::MSConstraintTracksProvider.

Definition at line 43 of file ITrackCollectionProvider.h.

{}

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 >, and AthCheckedComponent<::AthAlgTool >.

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.

trackCollection()

StatusCode TrackCollectionProvider::trackCollection ( const TrackCollection *& tracks )

virtual

Implements Trk::ITrackCollectionProvider.

Definition at line 37 of file TrackCollectionProvider.cxx.

  {
    ATH_MSG_DEBUG("in TrackCollectionProvider::trackCollection");
 
    originalTracks=nullptr;
    
    // check if m_inputCol is a TrackCollection and exists for this event
    // perhaps this can be done in a much nicer way on the python side ala PyUtils/checkFile.py
    // do it here for now
    if( !evtStore()->contains<TrackCollection>(m_inputCol) ||
    evtStore()->retrieve(originalTracks,m_inputCol).isFailure() ) {
      
      originalTracks=nullptr;
      
      ATH_MSG_DEBUG("input track collection \'"<<m_inputCol<<"\' not found for this event");
      
      if(m_maxRetrievalErrors>=0) {
    ++m_nRetrievalErrors;
    if(m_nRetrievalErrors>=m_maxRetrievalErrors) {
      msg(MSG::FATAL)<<"Input track collection \'"<<m_inputCol<<"\' not found in first "
             <<m_nRetrievalErrors<<" events. Aborting."<<endmsg;
      msg(MSG::FATAL)<<"Maximum allowed number of events without the track collection "
             <<"can be changed using the \'MaxRetrievalErrors\' option (-1 for infinite)."
             <<endmsg;
      return StatusCode::FAILURE;
    }
      }
      return StatusCode::SUCCESS;
    }
    ATH_MSG_DEBUG("found "<<originalTracks->size()<<" tracks");
 
    // if we're here it means that the track collection m_inputCol exists in the file
    // (it can be empty) so we change the error cutoff to process the whole file
    if(m_maxRetrievalErrors>=0)
      m_maxRetrievalErrors=-1;
    
    return StatusCode::SUCCESS;
  }

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);
      }
    }
  }

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_inputCol

Gaudi::Property<std::string> Trk::TrackCollectionProvider::m_inputCol

private

Initial value:

{this, "InputTrkCol", "MooreTracks",
    "Name of input track collection"}

Definition at line 37 of file TrackCollectionProvider.h.

                                       {this, "InputTrkCol", "MooreTracks",
    "Name of input track collection"};

m_logStream

std::ostream* Trk::ITrackCollectionProvider::m_logStream = nullptr

protectedinherited

logfile output stream

Definition at line 53 of file ITrackCollectionProvider.h.

m_maxRetrievalErrors

Gaudi::Property<int> Trk::TrackCollectionProvider::m_maxRetrievalErrors

private

Initial value:

{this, "MaxRetrievalErrors", 10,
      "maximum allowed number of retrieval errors at the beginning of the job (-1 for infinite)"}

Definition at line 41 of file TrackCollectionProvider.h.

                                           {this, "MaxRetrievalErrors", 10,
      "maximum allowed number of retrieval errors at the beginning of the job (-1 for infinite)"};

m_nRetrievalErrors

int Trk::TrackCollectionProvider::m_nRetrievalErrors = 0

private

number of retrieval errors at the beginning of the job

Definition at line 40 of file TrackCollectionProvider.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:

• TrackCollectionProvider.h
• TrackCollectionProvider.cxx