Athena::RootCnv Class Reference

This class provides the abstract converter to translate an object to/from its persistent ROOT representation. More...

#include <RootCnv.h>

Inheritance diagram for Athena::RootCnv:

Collaboration diagram for Athena::RootCnv:

Public Member Functions
	RootCnv (const CLID &id, ISvcLocator *pSvcLocator)
	Standard Constructor.
	RootCnv (ISvcLocator *pSvcLocator)
virtual	~RootCnv ()
	Destructor.
virtual StatusCode	initialize ()
	Gaudi Service Interface method implementations:
virtual StatusCode	finalize ()
long	repSvcType () const
	Retrieve the class type of the data store the converter uses.
virtual StatusCode	createObj (IOpaqueAddress *pAddr, DataObject *&pObj)
	Create a transient object from a ROOT persistent representation.
virtual StatusCode	fillObjRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Resolve the references of the created transient object.
virtual StatusCode	createRep (DataObject *pObj, IOpaqueAddress *&pAddr)
	Create a ROOT persistent representation for a transient object.
virtual StatusCode	fillRepRefs (IOpaqueAddress *pAddr, DataObject *pObj)
	Resolve the references of the created transient object.
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 ()
static const CLID &	classID ()

Protected Attributes
ServiceHandle< ::IAthenaRootCnvSvc >	m_cnvSvc
	ServiceHandle to the conversion service.

Private Member Functions
	RootCnv ()
	Default constructor:
	RootCnv (const ::Athena::RootCnv &)
RootCnv &	operator= (const ::Athena::RootCnv &)
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
RootType	m_ttype
	transient type
RootType	m_ptype
	persistent type
ITPCnvBase *	m_tpcnv
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).

Friends
class	CnvFactory< Athena::RootCnv >

Detailed Description

This class provides the abstract converter to translate an object to/from its persistent ROOT representation.

Definition at line 37 of file RootCnv.h.

Constructor & Destructor Documentation

RootCnv() [1/4]

Athena::RootCnv::RootCnv	(	const CLID &	id,
		ISvcLocator *	pSvcLocator )

Standard Constructor.

Definition at line 44 of file RootCnv.cxx.

                                                         : ::Converter(ROOT_StorageType, id, pSvcLocator),
        ::AthMessaging((pSvcLocator != 0 ? msgSvc() : 0), ::name_from_clid(id)),
    m_cnvSvc("Athena::RootCnvSvc/AthenaRootCnvSvc", ::name_from_clid(id)),
    m_ttype(),
    m_ptype(),
    m_tpcnv(0) {
}

RootCnv() [2/4]

Athena::RootCnv::RootCnv

(

ISvcLocator *

pSvcLocator

)

Definition at line 52 of file RootCnv.cxx.

                                         : ::Converter(ROOT_StorageType, CLID_NULL, pSvcLocator),
        ::AthMessaging( msgSvc(), ::name_from_clid(CLID_NULL)),
    m_cnvSvc("Athena::RootCnvSvc/AthenaRootCnvSvc", ::name_from_clid(CLID_NULL)),
    m_ttype(),
    m_ptype(),
    m_tpcnv(0) {
}

~RootCnv()

Athena::RootCnv::~RootCnv ( )

virtual

Destructor.

Definition at line 60 of file RootCnv.cxx.

                  {
}

RootCnv() [3/4]

Athena::RootCnv::RootCnv ( )

private

Default constructor:

RootCnv() [4/4]

Athena::RootCnv::RootCnv ( const ::Athena::RootCnv & )

private

Member Function Documentation

classID()

const CLID & Athena::RootCnv::classID ( )

inlinestatic

Returns

class ID.

Definition at line 79 of file RootCnv.h.

{ return CLID_NULL; }

createObj()

StatusCode Athena::RootCnv::createObj ( IOpaqueAddress * pAddr, DataObject *& pObj )

virtual

Create a transient object from a ROOT persistent representation.

Parameters

pAddr	[IN] IOpaqueAddress of ROOT persistent representation.
pObj	[OUT] pointer to the transient object.

Definition at line 105 of file RootCnv.cxx.

                                                                      {
  ATH_MSG_DEBUG("createObj(" << pAddr << ", " << pObj << ")");
  /*
  Athena::RootBranchAddress* rba = dynamic_cast<Athena::RootBranchAddress*>(pAddr);
  if (!rba) {
    ATH_MSG_DEBUG(*pAddr->par() << " is NOT a GenericAddress!");
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG("loading branch: [" << rba->par()[0] << "/" << rba->par()[1] << "]...");
  rba->setBranchAddress(m_type);
  ATH_MSG_DEBUG("loading branch: [" << rba->par()[0] << "/" << rba->par()[1] << "]... [done]");
  Athena::DataBucketBranch* dbb = new DataBucketBranch(rba->clID(), rba->m_ptr);
  pObj = dbb;
  return StatusCode::SUCCESS;
  */
  return StatusCode::FAILURE;
}

createRep()

StatusCode Athena::RootCnv::createRep ( DataObject * pObj, IOpaqueAddress *& pAddr )

virtual

Create a ROOT persistent representation for a transient object.

Parameters

pObj	[IN] pointer to the transient object.
pAddr	[OUT] IOpaqueAddress of ROOT persistent representation.

Definition at line 128 of file RootCnv.cxx.

                                                                      {
  ATH_MSG_VERBOSE("createRep pObj = " << pObj);
  pAddr = 0;
  if (pObj == 0) {
    ATH_MSG_ERROR("createRep called without DataObject.");
    return StatusCode::FAILURE;
  }
  CLID clid = pObj->clID();
  IRegistry* pR = pObj->registry();
  if (pR == 0) {
    ATH_MSG_ERROR("createRep no registry for DataObject.");
    return StatusCode::FAILURE;
  }
  std::string p[2] = { "", pR->identifier() };
  unsigned long ip[2] = { 0, 0 };
  void* trans = SG::fromStorable(pObj, clid);
  ATH_MSG_DEBUG("writing [" << objType() << "/" << p[1] << "]");
  ATH_MSG_DEBUG("p-type: [" << m_ptype.Name() << "]");
  std::unique_ptr<const Token> token (m_cnvSvc->writeObject(p[1], m_ptype, trans, m_tpcnv));
  if (token == 0 || !m_cnvSvc->createAddress(this->repSvcType(), clid, p, ip, pAddr).isSuccess()) {
    ATH_MSG_ERROR("problem creating opaque address");
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG("writing [" << objType() << "/" << p[1] << "] [done], entry = " << ip[0]);
  return StatusCode::SUCCESS;
}

fillObjRefs()

StatusCode Athena::RootCnv::fillObjRefs ( IOpaqueAddress * pAddr, DataObject * pObj )

virtual

Resolve the references of the created transient object.

Parameters

pAddr	[IN] IOpaqueAddress of ROOT persistent representation.
pObj	[OUT] pointer to the transient object.

Definition at line 123 of file RootCnv.cxx.

                                                                       {
  ATH_MSG_VERBOSE("fillObjRefs(pAddr = " << pAddr << ", " << "pObj = " << pObj << ")...");
  return StatusCode::FAILURE;
}

fillRepRefs()

StatusCode Athena::RootCnv::fillRepRefs ( IOpaqueAddress * pAddr, DataObject * pObj )

virtual

Resolve the references of the created transient object.

Parameters

pAddr	[IN] IOpaqueAddress of ROOT persistent representation.
pObj	[OUT] pointer to the transient object.

Definition at line 155 of file RootCnv.cxx.

                                                                       {
  ATH_MSG_VERBOSE("fillRepRefs(pAddr = " << pAddr << ", " << "pObj = " << pObj << ")...");
  return StatusCode::FAILURE;
}

finalize()

StatusCode Athena::RootCnv::finalize ( )

virtual

Definition at line 93 of file RootCnv.cxx.

                             {
  return ::Converter::finalize();
}

initialize()

StatusCode Athena::RootCnv::initialize ( )

virtual

Gaudi Service Interface method implementations:

Definition at line 63 of file RootCnv.cxx.

                               {
  if (!::Converter::initialize().isSuccess()) {
    ATH_MSG_FATAL("Cannot initialize Converter base class.");
    return StatusCode::FAILURE;
  }
  // Get the AthenaRootCnvSvc
  ATH_CHECK(m_cnvSvc.retrieve());
  CLID clid = this->objType();
  m_tpcnv = m_cnvSvc->getTPConverter(clid);
  if (!m_ttype) {
    m_ttype = m_cnvSvc->getType(clid);
  }
  if (!m_ptype) {
    if (m_tpcnv == 0) {
      // only warn if not a builtin
      if (!m_ttype.IsFundamental()) {
        ATH_MSG_INFO("Cannot get T/P converter, will write transient type [" << m_ttype.Name() << ", clid = " << clid << "]");
      }
      m_ptype = m_cnvSvc->getType(clid);
    } else {
      m_ptype = m_cnvSvc->getType(m_tpcnv->persistentTInfo());
    }
    if (!m_ptype) {
      ATH_MSG_ERROR("Cannot get RootType for DataObject.");
      return StatusCode::FAILURE;
    }
  }
  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;
  }
}

operator=()

RootCnv & Athena::RootCnv::operator= ( const ::Athena::RootCnv & )

private

repSvcType()

long Athena::RootCnv::repSvcType

(

)

const

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

Definition at line 97 of file RootCnv.cxx.

                               {
  return ROOT_StorageType;
}

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 Athena::RootCnv::storageType ( )

static

Returns

storage type.

Definition at line 101 of file RootCnv.cxx.

                          {
  return ROOT_StorageType;
}

Friends And Related Symbol Documentation

CnvFactory< Athena::RootCnv >

friend class CnvFactory< Athena::RootCnv >

friend

Definition at line 1 of file RootCnv.h.

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_cnvSvc

ServiceHandle< ::IAthenaRootCnvSvc> Athena::RootCnv::m_cnvSvc

protected

ServiceHandle to the conversion service.

Definition at line 89 of file RootCnv.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_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_ptype

RootType Athena::RootCnv::m_ptype

private

persistent type

Definition at line 96 of file RootCnv.h.

m_tpcnv

ITPCnvBase* Athena::RootCnv::m_tpcnv

private

Definition at line 98 of file RootCnv.h.

m_ttype

RootType Athena::RootCnv::m_ttype

private

transient type

Definition at line 93 of file RootCnv.h.

---

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

• RootCnv.h
• RootCnv.cxx