L1TopoByteStreamCnv Class Reference

ByteStream converter for the L1TopoRDOCollection. More...

#include <L1TopoByteStreamCnv.h>

Inheritance diagram for L1TopoByteStreamCnv:

Collaboration diagram for L1TopoByteStreamCnv:

Public Member Functions
	L1TopoByteStreamCnv (ISvcLocator *svcloc)
	Standard constructor.
	~L1TopoByteStreamCnv ()
	Standard destructor.
virtual StatusCode	initialize ()
	Function connecting to all the needed services/tools.
virtual StatusCode	createObjConst (IOpaqueAddress *pAddr, DataObject *&pObj) const
	Function creating the L1TopoRDOCollection object from a L1Topo ROB fragment.
virtual StatusCode	createRepConst (DataObject *pObj, IOpaqueAddress *&pAddr) const
	Function creating the L1Topo ROB fragment from a L1TopoRDOCollection object.
virtual long	repSvcType () const
	Function needed by the framework.
virtual StatusCode	createObj (IOpaqueAddress *pAddress, DataObject *&refpObject) override final
	Create the transient representation of an object.
virtual StatusCode	createRep (DataObject *pObject, IOpaqueAddress *&refpAddress) override final
	Convert the transient object to the requested representation.
const std::string &	name () const
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Static Public Member Functions
static long	storageType ()
	Function needed by the framework.
static CLID	classID ()
	Function needed by the framework.

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
ToolHandle< L1TopoByteStreamTool >	m_tool
	Tool doing the actual conversion.
L1TopoSrcIdMap *	m_srcIdMap
	Object storing the various IDs of the CTP fragment.
ServiceHandle< IROBDataProviderSvc >	m_robDataProvider
	Service used when reading the BS data.
ServiceHandle< IByteStreamEventAccess >	m_ByteStreamEventAccess
	Service used when writing the BS data.
std::string	m_name
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels).
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging).

Detailed Description

ByteStream converter for the L1TopoRDOCollection.

   This is a quite standard BS converter for the output sent from
   L1Topo to its ROS. It uses a separate tool
   (L1TopoByteStreamTool) to do the actual work of the conversion,
   this converter is just to communicate with the framework.
   It was based on CTPByteStreamCnv by David Berge
   and the L1Calo converters by Alan Watson and Peter Faulkner.

See also

L1TopoByteStreamTool

Author

Simon George

Date

Date

2014-11-12 00:00:00

Definition at line 40 of file L1TopoByteStreamCnv.h.

Constructor & Destructor Documentation

L1TopoByteStreamCnv()

L1TopoByteStreamCnv::L1TopoByteStreamCnv

(

ISvcLocator *

svcloc

)

Standard constructor.

The constructor sets up all the ToolHandle and ServiceHandle objects and initialises the base class in the correct way.

Definition at line 28 of file L1TopoByteStreamCnv.cxx.

    : AthConstConverter(storageType(), classID(), svcloc, "L1TopoByteStreamCnv"),
      m_tool("L1TopoByteStreamTool"),
      m_srcIdMap(0),
      m_robDataProvider("ROBDataProviderSvc", "L1TopoByteStreamCnv"),
      m_ByteStreamEventAccess("ByteStreamCnvSvc", "L1TopoByteStreamCnv") {}

~L1TopoByteStreamCnv()

L1TopoByteStreamCnv::~L1TopoByteStreamCnv

(

)

Standard destructor.

The destructor actually does some cleanup, it deletes the L1TopoSrcIdMap object that is created in the initialize() function.

Definition at line 39 of file L1TopoByteStreamCnv.cxx.

                                          {
  if (m_srcIdMap) {
    delete m_srcIdMap;
    m_srcIdMap = 0;
  }
}

Member Function Documentation

classID()

CLID L1TopoByteStreamCnv::classID ( )

static

Function needed by the framework.

Function telling the framework the Class ID of the object that this converter is for (L1TopoRDOCollection).

Definition at line 50 of file L1TopoByteStreamCnv.cxx.

                                  {
  return ClassID_traits<L1TopoRDOCollection>::ID();
}

createObj()

StatusCode AthConstConverter::createObj ( IOpaqueAddress * pAddress, DataObject *& refpObject )

finaloverridevirtualinherited

Create the transient representation of an object.

Non-const version; just calls the const version.

Definition at line 44 of file AthConstConverter.cxx.

{
  return createObjConst (pAddress, refpObject);
}

createObjConst()

StatusCode L1TopoByteStreamCnv::createObjConst ( IOpaqueAddress * pAddr, DataObject *& pObj ) const

virtual

Function creating the L1TopoRDOCollection object from a L1Topo ROB fragment.

This function creates the L1TopoRDO collection from the BS data.

It requests the ROB fragments with the ROB IDs of the L1Topo DAQ modules and gives these fragments to the L1TopoByteStreamTool for conversion.

Reimplemented from AthConstConverter.

Definition at line 118 of file L1TopoByteStreamCnv.cxx.

                                                                        {
  ATH_MSG_DEBUG("createObj() called");
  // -------------------------------------------------------------------------
  ByteStreamAddress* pBS_Addr = dynamic_cast<ByteStreamAddress*>(pAddr);
  CHECK(pBS_Addr != nullptr);
  const EventContext& ctx = pBS_Addr->getEventContext();
  // -------------------------------------------------------------------------
  //coverity[FORWARD_NULL:FALSE]
  const std::string nm = *(pBS_Addr->par());
  ATH_MSG_DEBUG("Creating Objects " << nm);
 
  // Create an empty collection. This is a DataVector<L1TopoRDO> which is like a
  // vector of pointers to L1TopoRDO and it owns the L1TopoRDOs from a memory
  // cleanup point of view
  L1TopoRDOCollection* result = new L1TopoRDOCollection();
  StatusCode sc = m_tool->convert(ctx, nm, result);
  if (sc.isFailure()) {
    return sc;
  }
  ATH_MSG_DEBUG("Converted  " << result->size() << " ROBs");
  pObj = SG::asStorable(result);
 
  return StatusCode::SUCCESS;
}

createRep()

StatusCode AthConstConverter::createRep ( DataObject * pObject, IOpaqueAddress *& refpAddress )

finaloverridevirtualinherited

Convert the transient object to the requested representation.

Non-const version; just calls the const version.

Definition at line 56 of file AthConstConverter.cxx.

{
  return createRepConst (pObject, refpAddress);
}

createRepConst()

StatusCode L1TopoByteStreamCnv::createRepConst ( DataObject * pObj, IOpaqueAddress *& pAddr ) const

virtual

Function creating the L1Topo ROB fragment from a L1TopoRDOCollection object.

This function receives a L1TopoRDO object as input, and adds the ROB fragment of the L1Topo to the current raw event using the IByteStreamEventAccess interface.

Reimplemented from AthConstConverter.

Definition at line 149 of file L1TopoByteStreamCnv.cxx.

                                                                             {
  ATH_MSG_DEBUG("createRep() called");
 
  RawEventWrite* re = m_ByteStreamEventAccess->getRawEvent();
 
  L1TopoRDOCollection* result;
  if (!SG::fromStorable(pObj, result)) {
    ATH_MSG_ERROR(" Cannot cast to L1TopoRDOCollection");
    return StatusCode::FAILURE;
  } else {
    ATH_MSG_DEBUG(" Found " << result->size() << " L1TopoRDOs to convert to ROBs");
  }
 
  ByteStreamAddress* addr =
      new ByteStreamAddress(classID(), pObj->registry()->name(), "");
 
  pAddr = addr;
 
  // Convert to ByteStream
  for (L1TopoRDOCollection::const_iterator it = result->begin();
       it != result->end(); ++it) {
    StatusCode sc = m_tool->convert(*it, re);
    if (sc.isFailure()) {
      ATH_MSG_ERROR(" Failed to create ROB for L1TopoRDO:  " << **it);
      return sc;
    }
  }
  return StatusCode::SUCCESS;
}

initialize()

StatusCode L1TopoByteStreamCnv::initialize ( )

virtual

Function connecting to all the needed services/tools.

Init method gets all necessary services etc.

Definition at line 61 of file L1TopoByteStreamCnv.cxx.

                                           {
  //
  // Initialise the base class:
  //
  StatusCode sc = Converter::initialize();
  if (sc.isFailure()) {
    return sc;
  }
 
  ATH_MSG_DEBUG("L1TopoByteStreamCnv in initialize() ");
 
  //
  // Get ByteStreamCnvSvc:
  //
  sc = m_ByteStreamEventAccess.retrieve();
  if (sc.isFailure()) {
    ATH_MSG_FATAL("Can't get ByteStreamEventAccess interface");
    return sc;
  } else {
    ATH_MSG_DEBUG("Connected to ByteStreamEventAccess interface");
  }
 
  //
  // Get L1TopoByteStreamTool:
  //
  sc = m_tool.retrieve();
  if (sc.isFailure()) {
    ATH_MSG_FATAL("Can't get L1TopoByteStreamTool");
    return sc;
  } else {
    ATH_MSG_DEBUG("Connected to L1TopoByteStreamTool");
  }
 
  //
  // Get ROBDataProvider:
  //
  sc = m_robDataProvider.retrieve();
  if (sc.isFailure()) {
    ATH_MSG_WARNING("Can't get ROBDataProviderSvc");
    // return is disabled for Write BS which does not requre ROBDataProviderSvc
  } else {
    ATH_MSG_DEBUG("Connected to ROBDataProviderSvc");
  }
 
  //
  // Create L1TopoSrcIdMap:
  //
  m_srcIdMap = new L1TopoSrcIdMap();
 
  return StatusCode::SUCCESS;
}

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 167 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 182 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  // If user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

name()

const std::string & AthConstConverter::name ( ) const

inlineinherited

Definition at line 67 of file AthConstConverter.h.

{ return m_name; }

repSvcType()

virtual long L1TopoByteStreamCnv::repSvcType ( ) const

inlinevirtual

Function needed by the framework.

Definition at line 60 of file L1TopoByteStreamCnv.h.

{ return i_repSvcType(); }

setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

storageType()

long L1TopoByteStreamCnv::storageType ( )

static

Function needed by the framework.

Definition at line 54 of file L1TopoByteStreamCnv.cxx.

                                      {
  return ByteStreamAddress::storageType();
}

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging).

Definition at line 141 of file AthMessaging.h.

m_ByteStreamEventAccess

ServiceHandle<IByteStreamEventAccess> L1TopoByteStreamCnv::m_ByteStreamEventAccess

private

Service used when writing the BS data.

Definition at line 76 of file L1TopoByteStreamCnv.h.

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels).

Definition at line 132 of file AthMessaging.h.

m_name

std::string AthConstConverter::m_name

privateinherited

Definition at line 71 of file AthConstConverter.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_robDataProvider

ServiceHandle<IROBDataProviderSvc> L1TopoByteStreamCnv::m_robDataProvider

private

Service used when reading the BS data.

Definition at line 74 of file L1TopoByteStreamCnv.h.

m_srcIdMap

L1TopoSrcIdMap* L1TopoByteStreamCnv::m_srcIdMap

private

Object storing the various IDs of the CTP fragment.

Definition at line 71 of file L1TopoByteStreamCnv.h.

m_tool

ToolHandle<L1TopoByteStreamTool> L1TopoByteStreamCnv::m_tool

private

Tool doing the actual conversion.

Definition at line 68 of file L1TopoByteStreamCnv.h.

---

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

• L1TopoByteStreamCnv.h
• L1TopoByteStreamCnv.cxx