Tool doing the CTP_RDO <-> ByteStream conversion. More...

#include <CTPByteStreamTool.h>

Inheritance diagram for CTPByteStreamTool:

Collaboration diagram for CTPByteStreamTool:

Public Member Functions
	CTPByteStreamTool (const std::string &type, const std::string &name, const IInterface *parent)
	Default constructor.
StatusCode	convert (const ROBF rob, CTP_RDO &result)
	Convert ROBFragment to CTP_RDO.
StatusCode	convert (const CTP_RDO result, RawEventWrite re)
	convert CTP_RDO to ByteStream
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 ()
	AlgTool 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 OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment	ROBF
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
CTPSrcIdMap	m_srcIdMap
	Object storing the various IDs of the CTP fragment.
FullEventAssembler< CTPSrcIdMap >	m_fea
	Object used in creating the CTP ROB fragment.
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

Tool doing the CTP_RDO <-> ByteStream conversion.

   The actual work of translating the information in a CTP_RDO object
   into a CTP ROB fragment and vice-versa is done with this tool.

See also: CTPByteStreamCnv

Author: David Berge

Date

Date: 2007-12-14 15:33:07

Definition at line 33 of file CTPByteStreamTool.h.

Member Typedef Documentation

◆ ROBF

typedef OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment CTPByteStreamTool::ROBF

private

Definition at line 36 of file CTPByteStreamTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CTPByteStreamTool()

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

Default constructor.

The constructor takes care of correctly constructing the base class and declaring the tool's interface to the framework.

Definition at line 31 of file CTPByteStreamTool.cxx.

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

Member Function Documentation

◆ convert() [1/2]

StatusCode CTPByteStreamTool::convert	(	const CTP_RDO *	result,
		RawEventWrite *	re )

convert CTP_RDO to ByteStream

Conversion from RDO to eformat::ROBFragment.

This is called from the CTPByteStreamCnv::createRep method.

Definition at line 43 of file CTPByteStreamTool.cxx.

                                                                                {
 
  MsgStream log( msgSvc(), name() );
  ATH_MSG_DEBUG("executing convert() from RDO to ROBFragment");
 
  //get CTP version
  unsigned int ctpVersionNumber = result->getCTPVersionNumber();
  CTPdataformatVersion ctpVersion(ctpVersionNumber);
  
  // Clear Event Assembler
  m_fea.clear();
 
  // Reset lumi-block number to 1
  m_fea.setDetEvtType( 1 );
  // Set L1Apos to center of readout window
  uint16_t minorVersion = ( result->getNumberOfBunches() - 1u ) / 2u;
  minorVersion &= ctpVersion.getL1APositionMask();
  minorVersion <<= ctpVersion.getL1APositionShift();
  m_fea.setRodMinorVersion( minorVersion );  
 
  FullEventAssembler< CTPSrcIdMap >::RODDATA* theROD;
 
  // Source ID of CTP
  const uint32_t rodId = m_srcIdMap.getRodID();
 
  ATH_MSG_DEBUG(" ROD ID:" << MSG::hex << rodId);
 
  // get the ROD data container to be filled
  theROD = m_fea.getRodData( rodId );
 
  ATH_MSG_VERBOSE(" Dumping CTP words:");
 
  // fill Data Words
  const std::vector< uint32_t >& vDataWords = result->getDataWords();
  std::vector< uint32_t >::const_iterator it = vDataWords.begin();
  std::vector< uint32_t >::const_iterator end = vDataWords.end();
  for( ; it != end; ++it ) {
    theROD->push_back( *it );
    ATH_MSG_VERBOSE("     0x" << MSG::hex << std::setw( 8 )  << ( *it ));
  }
 
  // Now fill full event
  ATH_MSG_DEBUG("Now filling the event with the CTP fragment");
  m_fea.fill( re, log );
 
  return StatusCode::SUCCESS;
}

◆ convert() [2/2]

StatusCode CTPByteStreamTool::convert	(	const ROBF *	rob,
		CTP_RDO *&	result )

Convert ROBFragment to CTP_RDO.

Conversion from eformat::ROBFragment to RDO.

This is called from the CTPByteStreamCnv::createObj method.

Definition at line 96 of file CTPByteStreamTool.cxx.

                                                                         {
 
  MsgStream log( msgSvc(), name() );
  ATH_MSG_DEBUG("executing convert() from ROBFragment to RDO");
  
  const uint32_t ctpRodId = m_srcIdMap.getRodID();
  const uint32_t rodId = rob->rod_source_id();
 
  ATH_MSG_DEBUG(" expected ROD sub-detector ID: " << std::hex << ctpRodId 
      << " ID found: " << std::hex << rodId << std::dec);  
 
  if ( rodId == ctpRodId ) {
 
    ATH_MSG_VERBOSE(" Dumping CTP words:");
 
    // For generality let's declare the data pointer like this. Altough it's
    // unlikely to ever change from being a pointer to uint32_t-s.
    OFFLINE_FRAGMENTS_NAMESPACE::PointerType it_data;
    rob->rod_data( it_data );
    const uint32_t ndata = rob->rod_ndata();
 
    // data words
    std::vector<uint32_t> vDataWords;
    for ( uint32_t i = 0; i < ndata; ++i, ++it_data ) {
      vDataWords.push_back( static_cast<uint32_t>( *it_data ) );
      ATH_MSG_VERBOSE("     0x" << MSG::hex << std::setw( 8 )  << *it_data);
    }
 
    // create CTP RDO
    uint32_t nExtraWords=0;
    nExtraWords=CTPfragment::numberExtraPayloadWords(rob);
    unsigned int ctpVersionNumber = CTPfragment::ctpFormatVersion(rob);
    result = new CTP_RDO(ctpVersionNumber, std::move(vDataWords) , nExtraWords);
 
    uint8_t l1apos =  CTPfragment::lvl1AcceptBunch(rob);
    result->setL1AcceptBunchPosition(l1apos);
 
    uint32_t tc = CTPfragment::turnCounter(rob);
    result->setTurnCounter(tc);
 
    return StatusCode::SUCCESS;
  }
 
  ATH_MSG_ERROR("Wrong ROD ID found in the CTP ROB fragment!");
  return StatusCode::FAILURE;
}

◆ 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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ 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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

◆ 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 & CTPByteStreamTool::interfaceID ( )

static

AlgTool InterfaceID.

This function is needed by the framework to know what kind of tool this is.

Definition at line 23 of file CTPByteStreamTool.cxx.

                                                  {
  return IID_ICTPByteStreamTool;
}

◆ 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_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_fea

FullEventAssembler< CTPSrcIdMap > CTPByteStreamTool::m_fea

private

Object used in creating the CTP ROB fragment.

Definition at line 55 of file CTPByteStreamTool.h.

◆ m_srcIdMap

CTPSrcIdMap CTPByteStreamTool::m_srcIdMap

private

Object storing the various IDs of the CTP fragment.

Definition at line 53 of file CTPByteStreamTool.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:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ROBF

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CTPByteStreamTool()

Member Function Documentation

◆ convert() [1/2]

◆ convert() [2/2]

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_fea

◆ m_srcIdMap

◆ m_varHandleArraysDeclared

◆ m_vhka