AFP_RawDataProviderTool Class Reference

#include <AFP_RawDataProviderTool.h>

Inheritance diagram for AFP_RawDataProviderTool:

Collaboration diagram for AFP_RawDataProviderTool:

Public Member Functions
	AFP_RawDataProviderTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~AFP_RawDataProviderTool ()
	Does nothing.
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
StatusCode	convert (std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &vecRobs, AFP_RawContainer *rawContainer) const
	Fill rawContainer with collections created from provided vecRobs.
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.

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
ToolHandle< AFP_ByteStream2RawCnv >	m_decoder {this, "AFP_ByteStream2RawCnv", "AFP_ByteStream2RawCnv", "ByteStream convertor tool"}
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 22 of file AFP_RawDataProviderTool.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

AFP_RawDataProviderTool()

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

Definition at line 14 of file AFP_RawDataProviderTool.cxx.

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

~AFP_RawDataProviderTool()

AFP_RawDataProviderTool::~AFP_RawDataProviderTool ( )

virtual

Does nothing.

Definition at line 22 of file AFP_RawDataProviderTool.cxx.

{}

Member Function Documentation

convert()

StatusCode AFP_RawDataProviderTool::convert	(	std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &	vecRobs,
		AFP_RawContainer *	rawContainer ) const

Fill rawContainer with collections created from provided vecRobs.

Definition at line 44 of file AFP_RawDataProviderTool.cxx.

{
  std::set<uint32_t> robIdSet;
 
  if (!rawContainer) {
    ATH_MSG_WARNING("NULL pointer passed in rawContainer.");
    return StatusCode::SUCCESS;
  }
 
  if (vecRobs.empty()) {
    ATH_MSG_DEBUG("vecRobs.size() == 0");
    return StatusCode::SUCCESS;
  }
 
  // Loop over robs and fill rawContainer
  for (const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment* rob : vecRobs) {
    const uint32_t robId = rob->rod_source_id();
 
    if (robIdSet.insert(robId).second) {
      StatusCode sc = m_decoder->fillCollection(rob, rawContainer);
      if (sc.isFailure()) {
        ATH_MSG_ERROR("Failed filling collection");
        return StatusCode::FAILURE;
      }
    }
 
  } // end for loop
 
  return StatusCode::SUCCESS;
}

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

finalize()

StatusCode AFP_RawDataProviderTool::finalize ( )

virtual

Definition at line 76 of file AFP_RawDataProviderTool.cxx.

                                             {
  StatusCode sc = AthAlgTool::finalize();
  ATH_MSG_DEBUG("FINALIZE AFP_RawDataProviderTool");
  if (sc.isFailure()) {
    ATH_MSG_WARNING("FINALIZE failed");
    return StatusCode::SUCCESS;
  }
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode AFP_RawDataProviderTool::initialize ( )

virtual

Definition at line 24 of file AFP_RawDataProviderTool.cxx.

                                               {
  ATH_MSG_INFO("Initializing " << name() << "...");
 
  StatusCode sc = AthAlgTool::initialize();
  ATH_MSG_DEBUG("INITIALIZE AFP_RawDataProviderTool");
  if (sc.isFailure()) {
    ATH_MSG_WARNING(" Failed to init baseclass");
    return StatusCode::SUCCESS;
  }
 
  if (m_decoder.retrieve().isFailure()) {
    ATH_MSG_WARNING("FAILED TO RETRIEVE TOOL " << m_decoder);
    return StatusCode::SUCCESS;
  } else {
    ATH_MSG_DEBUG("Retrieved decoder tool " << m_decoder);
  }
  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 & AFP_RawDataProviderTool::interfaceID ( )

static

Definition at line 10 of file AFP_RawDataProviderTool.cxx.

                                                        {
  return IID_IAFP_RawCollByteStreamTool;
}

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

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

Member Data Documentation

m_decoder

ToolHandle<AFP_ByteStream2RawCnv> AFP_RawDataProviderTool::m_decoder {this, "AFP_ByteStream2RawCnv", "AFP_ByteStream2RawCnv", "ByteStream convertor tool"}

private

Definition at line 39 of file AFP_RawDataProviderTool.h.

{this, "AFP_ByteStream2RawCnv", "AFP_ByteStream2RawCnv", "ByteStream convertor tool"};

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_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:

• AFP_RawDataProviderTool.h
• AFP_RawDataProviderTool.cxx