Converter for writing ByteStream from ITkStrips Raw Data. More...

#include <ITkStripsRawContByteStreamCnv.h>

Inheritance diagram for ITkStripsRawContByteStreamCnv:

Collaboration diagram for ITkStripsRawContByteStreamCnv:

Public Member Functions
	ITkStripsRawContByteStreamCnv (ISvcLocator *svcLoc)
	Constructor.
virtual	~ITkStripsRawContByteStreamCnv ()=default
	Destructor.
virtual StatusCode	initialize () override
	Initialize.
virtual long	repSvcType () const override
	Retrieve the class type of the data store the converter uses.
virtual StatusCode	createObjConst (IOpaqueAddress , DataObject &) const override
	createObj method (not used!)
virtual StatusCode	createRepConst (DataObject pDataObject, IOpaqueAddress &pOpaqueAddress) const override
	Method to convert ITkStrips Raw Data into ByteStream.
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 ()
	Storage type.
static CLID	classID ()
	Class ID.

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

Private Attributes
ToolHandle< ISCTRawContByteStreamTool >	m_rawContByteStreamTool
	Tool to do coversion from ITkStrips RDO container to ByteStream.
ServiceHandle< IByteStreamEventAccess >	m_byteStreamEventAccess
	Interface for accessing raw 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

Converter for writing ByteStream from ITkStrips Raw Data.

This will do the conversion on demand, triggered by the ByteStreamAddressProviderSvc. Since it is not possible to configure a Converter with Python Configurables, we use a tool (ITkStripsRawContByteStreamTool) which in turn uses the lightweight ITkStripsRodEncoder class, to do the actual converting.

Definition at line 28 of file ITkStripsRawContByteStreamCnv.h.

Constructor & Destructor Documentation

◆ ITkStripsRawContByteStreamCnv()

ITkStripsRawContByteStreamCnv::ITkStripsRawContByteStreamCnv ( ISvcLocator * svcLoc )

Constructor.

Definition at line 19 of file ITkStripsRawContByteStreamCnv.cxx.

                                                                                :
  AthConstConverter(storageType(), classID(), svcLoc, "ITkStripsRawContByteStreamCnv"),
  m_rawContByteStreamTool{"ITkStripsRawContByteStreamTool"},
  m_byteStreamEventAccess{"ByteStreamCnvSvc", "ITkStripsRawContByteStreamCnv"}
{
}

◆ ~ITkStripsRawContByteStreamCnv()

virtual ITkStripsRawContByteStreamCnv::~ITkStripsRawContByteStreamCnv ( )

virtualdefault

Destructor.

Member Function Documentation

◆ classID()

CLID ITkStripsRawContByteStreamCnv::classID ( )

inlinestatic

Class ID.

Definition at line 45 of file ITkStripsRawContByteStreamCnv.h.

45{ return ClassID_traits<SCT_RDO_Container>::ID(); }

ClassID_traits::ID

static constexpr CLID ID()

Definition Control/AthenaKernel/AthenaKernel/ClassID_traits.h:44

◆ 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()

virtual StatusCode ITkStripsRawContByteStreamCnv::createObjConst	(	IOpaqueAddress *	,
		DataObject *&	) const

inlineoverridevirtual

createObj method (not used!)

Reimplemented from AthConstConverter.

Definition at line 48 of file ITkStripsRawContByteStreamCnv.h.

48{ return StatusCode::FAILURE; }

◆ 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 ITkStripsRawContByteStreamCnv::createRepConst	(	DataObject *	pDataObject,
		IOpaqueAddress *&	pOpaqueAddress ) const

overridevirtual

Method to convert ITkStrips Raw Data into ByteStream.

Gets pointer to RawEvent, get ID container of ITkStrips RDO. Sets up opaque address for Storegate.

Uses ITkStrips RawContByteStreamTool to convert Raw Data to ByteStream.

Parameters

pDataObject	Pointer to data object.
pOpaqueAddress	Opaque address to object.

Reimplemented from AthConstConverter.

Definition at line 46 of file ITkStripsRawContByteStreamCnv.cxx.

{
  // Get IDC for ITK Raw Data
  SCT_RDO_Container* itkStripsRDOCont{nullptr};
  if (not SG::fromStorable(pDataObject, itkStripsRDOCont)) {
    ATH_MSG_ERROR( " Can not cast to SCTRawContainer " );
    return StatusCode::FAILURE;
  }
 
  // Set up the IOpaqueAddress for Storegate
  std::string dataObjectName{pDataObject->registry()->name()};
  pOpaqueAddress = new ByteStreamAddress(classID(), dataObjectName, "");
  pOpaqueAddress->addRef();//avoid memory leak 
  // Use the tool to do the conversion
  ATH_CHECK(m_rawContByteStreamTool->convert(itkStripsRDOCont) );
 
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode ITkStripsRawContByteStreamCnv::initialize ( )

overridevirtual

Initialize.

Definition at line 28 of file ITkStripsRawContByteStreamCnv.cxx.

{
  ATH_CHECK(AthConstConverter::initialize());
  ATH_MSG_DEBUG( " initialize " );
 
  // Retrieve ByteStreamCnvSvc
  ATH_CHECK(m_byteStreamEventAccess.retrieve());
  ATH_MSG_VERBOSE( "Retrieved service " << m_byteStreamEventAccess );
 
  // Retrieve byte stream tool
  ATH_CHECK(m_rawContByteStreamTool.retrieve());
  ATH_MSG_VERBOSE( "Retrieved tool " << m_rawContByteStreamTool );
 
  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.

183{ return msg() << lvl; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:167

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

67{ return m_name; }

AthConstConverter::m_name

std::string m_name

Definition AthConstConverter.h:71

◆ repSvcType()

virtual long ITkStripsRawContByteStreamCnv::repSvcType ( ) const

inlineoverridevirtual

Retrieve the class type of the data store the converter uses.

Definition at line 41 of file ITkStripsRawContByteStreamCnv.h.

41{ 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 ITkStripsRawContByteStreamCnv::storageType ( )

inlinestatic

Storage type.

Definition at line 43 of file ITkStripsRawContByteStreamCnv.h.

43{ return ByteStreamAddress::storageType(); }

ByteStreamAddress::storageType

static constexpr long storageType()

Definition ByteStreamAddress.h:51

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> ITkStripsRawContByteStreamCnv::m_byteStreamEventAccess

private

Interface for accessing raw data.

Definition at line 69 of file ITkStripsRawContByteStreamCnv.h.

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ 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_rawContByteStreamTool

ToolHandle<ISCTRawContByteStreamTool> ITkStripsRawContByteStreamCnv::m_rawContByteStreamTool

private

Tool to do coversion from ITkStrips RDO container to ByteStream.

Definition at line 66 of file ITkStripsRawContByteStreamCnv.h.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ITkStripsRawContByteStreamCnv()

◆ ~ITkStripsRawContByteStreamCnv()

Member Function Documentation

◆ classID()

◆ createObj()

◆ createObjConst()

◆ createRep()

◆ createRepConst()

◆ initialize()

◆ initMessaging()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ name()

◆ repSvcType()

◆ setLevel()

◆ storageType()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_byteStreamEventAccess

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_name

◆ m_nm

◆ m_rawContByteStreamTool