Gaudi::RootDirectoryCnv Class Reference

Description: NTuple directory converter class definition Definition of the converter to manage the directories in an database representing N-Tuples. More...

#include <src/RootDirectoryCnv.h>

Inheritance diagram for Gaudi::RootDirectoryCnv:

Collaboration diagram for Gaudi::RootDirectoryCnv:

Public Member Functions
	RootDirectoryCnv (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
StatusCode	createObj (IOpaqueAddress *pAddr, DataObject *&refpObj) override
	Converter overrides: Create transient object from persistent data. More...
StatusCode	fillObjRefs (IOpaqueAddress *pAddr, DataObject *pObj) override
	Converter overrides: Resolve the references of the transient object. More...
StatusCode	updateObj (IOpaqueAddress *pAddr, DataObject *pObj) override
	Converter overrides: Update transient object from persistent data. More...
StatusCode	updateObjRefs (IOpaqueAddress *pAddr, DataObject *pObj) override
	Converter overrides: Update the references of an updated transient object. More...
StatusCode	createRep (DataObject *pObj, IOpaqueAddress *&refpAddr) override
	Converter overrides: Convert the transient object to the requested representation. More...
StatusCode	fillRepRefs (IOpaqueAddress *pAddr, DataObject *pObj) override
	Converter overrides: Fill references of persistent object representation. More...
StatusCode	updateRep (IOpaqueAddress *pAddr, DataObject *pObj) override
	Converter overrides: Update persistent object representation. More...
StatusCode	updateRepRefs (IOpaqueAddress *pAddr, DataObject *pObj) override
	Converter overrides: Update references of persistent object representation. More...
Public Member Functions inherited from Gaudi::RootStatCnv
	RootStatCnv (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
Public Member Functions inherited from Gaudi::RootConverter
	RootConverter (long typ, const CLID &clid, ISvcLocator *svc, RootCnvSvc *mgr)
	Initializing Constructor. More...
long	repSvcType () const override
	Retrieve the class type of the data store the converter uses. More...
StatusCode	createObj (IOpaqueAddress *pAddr, DataObject *&refpObj) override
	Converter overrides: Create transient object from persistent data. More...
StatusCode	fillObjRefs (IOpaqueAddress *pAddr, DataObject *pObj) override
	Resolve the references of the created transient object. More...
StatusCode	createRep (DataObject *pObj, IOpaqueAddress *&refpAddr) override
	Converter overrides: Convert the transient object to the requested representation. More...
StatusCode	fillRepRefs (IOpaqueAddress *pAddr, DataObject *pObj) override
	Resolve the references of the created transient object. More...
Public Member Functions inherited from Converter
StatusCode	initialize () override
	Initialize the converter. More...
StatusCode	finalize () override
	Initialize the converter. More...
StatusCode	setDataProvider (IDataProviderSvc *svc) override
	Set Data provider service. More...
SmartIF< IDataProviderSvc > &	dataProvider () const override
	Get Data provider service. More...
StatusCode	setConversionSvc (IConversionSvc *svc) override
	Set conversion service the converter is connected to. More...
SmartIF< IConversionSvc > &	conversionSvc () const override
	Get conversion service the converter is connected to. More...
StatusCode	setAddressCreator (IAddressCreator *creator) override
	Set address creator facility. More...
SmartIF< IAddressCreator > &	addressCreator () const override
	Retrieve address creator facility. More...
const CLID &	objType () const override
	Retrieve the class type of objects the converter produces. More...
virtual long	i_repSvcType () const
	Retrieve the class type of the data store the converter uses. More...
StatusCode	createObj (IOpaqueAddress *pAddress, DataObject *&refpObject) override
	Create the transient representation of an object. More...
StatusCode	fillObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Resolve the references of the created transient object. More...
StatusCode	updateObj (IOpaqueAddress *pAddress, DataObject *refpObject) override
	Update the transient object from the other representation. More...
StatusCode	updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the references of an updated transient object. More...
StatusCode	createRep (DataObject *pObject, IOpaqueAddress *&refpAddress) override
	Convert the transient object to the requested representation. More...
StatusCode	fillRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Resolve the references of the converted object. More...
StatusCode	updateRep (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the converted representation of a transient object. More...
StatusCode	updateRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the references of an already converted object. More...
	Converter (long storage_type, const CLID &class_type, ISvcLocator *svc=0)
	Standard Constructor. More...
template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &type, const std::string &name, T *&psvc) const
	Access a service by name, type creating it if it doesn't already exist. More...
SmartIF< IService >	service (const std::string &name, const bool createIf=true) const
	Return a pointer to the service identified by name (or "type/name") More...
Public Member Functions inherited from implements< IConverter >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	implements ()=default
	Default constructor. More...
	implements (const implements &)
	Copy constructor (zero the reference count) More...
implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...
unsigned long	addRef () override
	Reference Interface instance. More...
unsigned long	release () override
	Release Interface instance. More...
unsigned long	refCount () const override
	Current reference count. More...

Additional Inherited Members
Public Types inherited from Converter
using	Factory = Gaudi::PluginService::Factory< IConverter *(ISvcLocator *)>
Public Types inherited from implements< IConverter >
using	base_class = implements< Interfaces... >
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
using	iids = typename extend_interfaces_base::ext_iids
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...
Protected Member Functions inherited from Gaudi::RootStatCnv
MsgStream &	log () const
	Helper to use mesage logger. More...
StatusCode	initialize () override
	Initialize converter object. More...
StatusCode	finalize () override
	Finalize converter object. More...
virtual const std::string	containerName (IRegistry *pDir) const
	Retrieve the name of the container a given object is placed into. More...
virtual const std::string	fileName (IRegistry *pReg) const
	Retrieve the name of the file a given object is placed into. More...
virtual const std::string	topLevel (IRegistry *pReg) const
	Retrieve the full path of the file a given object is placed into. More...
StatusCode	makeError (const std::string &msg, bool throw_exception=false) const
	Helper method to issue error messages. More...
StatusCode	saveDescription (const std::string &path, const std::string &ident, const std::string &desc, const std::string &opt, const CLID &clid)
	Save statistics object description. More...
Protected Member Functions inherited from Converter
SmartIF< ISvcLocator > &	serviceLocator () const
	Retrieve pointer to service locator. More...
SmartIF< IMessageSvc > &	msgSvc () const
	Retrieve pointer to message service. More...
SmartIF< IDataManagerSvc > &	dataManager () const
	Get Data Manager service. More...
Protected Attributes inherited from Gaudi::RootStatCnv
SmartIF< IDataManagerSvc >	m_dataMgr
	Reference to data manager service to manipulate the TES. More...
std::unique_ptr< MsgStream >	m_log
	Reference to logger object. More...
Protected Attributes inherited from Gaudi::RootConverter
RootCnvSvc *	m_dbMgr
	Conversion service needed for proper operation to forward requests. More...
Protected Attributes inherited from implements< IConverter >
std::atomic_ulong	m_refCount
	Reference counter. More...

Detailed Description

Description: NTuple directory converter class definition Definition of the converter to manage the directories in an database representing N-Tuples.

Author

M.Frank

Version

1.0

Definition at line 30 of file RootDirectoryCnv.h.

Constructor & Destructor Documentation

RootDirectoryCnv::RootDirectoryCnv	(	long	typ,
		const CLID &	clid,
		ISvcLocator *	svc,
		RootCnvSvc *	mgr
	)

Initializing Constructor.

Parameters

typ	[IN] Concrete storage type of the converter
clid	[IN] Class identifier of the object
svc	[IN] Pointer to service locator object

Returns

Reference to RootBaseCnv object

Definition at line 30 of file RootDirectoryCnv.cpp.

    : RootStatCnv( typ, clid, svc, mgr ) {}

Member Function Documentation

StatusCode RootDirectoryCnv::createObj ( IOpaqueAddress *  pAddr, DataObject *&  refpObj  )

override

Converter overrides: Create transient object from persistent data.

Parameters

pAddr	[IN] Pointer to object address.
refpObj	[OUT] Location to pointer to store data object

Returns

Status code indicating success or failure.

Definition at line 34 of file RootDirectoryCnv.cpp.

                                                                                {
  refpObj = new NTuple::Directory();
  return StatusCode::SUCCESS;
}

StatusCode RootDirectoryCnv::createRep ( DataObject *  pObj, IOpaqueAddress *&  refpAddr  )

override

Converter overrides: Convert the transient object to the requested representation.

Parameters

pObj	[IN] Pointer to data object
refpAddr	[OUT] Location to store pointer to object address.

Returns

Status code indicating success or failure.

Definition at line 40 of file RootDirectoryCnv.cpp.

                                                                             {
  string dsc;
  if ( objType() == CLID_StatisticsDirectory ) {
    dsc = "Directory containing statistics results.";
  } else if ( objType() == CLID_StatisticsFile ) {
    dsc = "File containing statistics results.";
  } else {
    return StatusCode::FAILURE;
  }
  string ident = containerName( pObj->registry() );
  string path  = fileName( pObj->registry() );
  return saveDescription( path, ident, dsc, ident, objType() );
}

StatusCode RootDirectoryCnv::fillObjRefs ( IOpaqueAddress *  pAddr, DataObject *  pObj  )

override

Converter overrides: Resolve the references of the transient object.

Parameters

pAddr	[IN] Pointer to object address.
pObj	[IN] Pointer to data object

Returns

Status code indicating success or failure.

Definition at line 55 of file RootDirectoryCnv.cpp.

                                                                                  {
  return updateObjRefs( pAddr, pObj );
}

StatusCode RootDirectoryCnv::fillRepRefs ( IOpaqueAddress *  pAddr, DataObject *  pObj  )

override

Converter overrides: Fill references of persistent object representation.

Parameters

pObj	[IN] Pointer to data object
refpAddr	[OUT] Location to store pointer to object address.

Returns

Status code indicating success or failure.

Definition at line 157 of file RootDirectoryCnv.cpp.

                                                                           {
  return StatusCode::SUCCESS;
}

StatusCode RootDirectoryCnv::updateObj ( IOpaqueAddress *  pAddr, DataObject *  pObj  )

override

Converter overrides: Update transient object from persistent data.

Parameters

pAddr	[IN] Pointer to object address.
pObj	[IN] Pointer to data object

Returns

Status code indicating success or failure.

Definition at line 142 of file RootDirectoryCnv.cpp.

                                                                         {
  return StatusCode::SUCCESS;
}

StatusCode RootDirectoryCnv::updateObjRefs ( IOpaqueAddress *  pAddr, DataObject *  pObj  )

override

Converter overrides: Update the references of an updated transient object.

Parameters

pAddr	[IN] Pointer to object address.
pObj	[IN] Pointer to data object

Returns

Status code indicating success or failure.

Definition at line 60 of file RootDirectoryCnv.cpp.

                                                                                       {
  typedef vector<RootNTupleDescriptor*> REFS;
  REFS                                  refs;
  StatusCode                            status = StatusCode( StatusCode::FAILURE, true );
  if ( pAddr ) {
    IRegistry* pReg = pAddr->registry();
    if ( pReg ) {
      typedef vector<IRegistry*> Leaves;
      string                     ident   = pReg->identifier();
      string                     fname   = fileName( pReg );
      string                     cntName = containerName( pReg );
      RootDataConnection*        con     = nullptr;
      Leaves                     leaves;
      status = m_dbMgr->connectDatabase( fname, IDataConnection::READ, &con );
      if ( status.isSuccess() ) {
        TBranch* b = con->getBranch( "##Descriptors", "GaudiStatisticsDescription" );
        if ( b ) {
          for ( Long64_t n = b->GetEntries(), i = 0; i < n; ++i ) {
            RootNTupleDescriptor* ref = nullptr;
            b->SetAddress( &ref );
            int nb = b->GetEntry( i );
            if ( nb > 1 ) {
              string s = ref->container.substr( 0, cntName.length() );
              log() << MSG::VERBOSE << "Read description:" << ref->container << " " << ident << " " << cntName
                    << endmsg;
              if ( s == cntName ) {
                if ( ref->container.length() >= cntName.length() + 1 ) {
                  if ( ref->container.find( '/', cntName.length() + 1 ) == string::npos ) {
                    refs.push_back( ref );
                    continue;
                  }
                }
              }
            }
            delete ref;
          }
        }
        log() << MSG::DEBUG << "Got " << refs.size() << " tuple connection(s)....." << endmsg;
        status = m_dataMgr->objectLeaves( pObject, leaves );
        if ( status.isSuccess() ) {
          for ( auto& ref : refs ) {
            if ( ref ) {
              bool need_to_add =
                  std::none_of( std::begin( leaves ), std::end( leaves ),
                                [&]( Leaves::const_reference j ) { return containerName( j ) == ref->container; } );
              if ( need_to_add ) {
                IOpaqueAddress* pA = nullptr;
                if ( ref->clid == CLID_StatisticsDirectory || ref->clid == CLID_StatisticsFile ||
                     ref->clid == CLID_RowWiseTuple || ref->clid == CLID_ColumnWiseTuple ) {
                  string        spar[] = {fname, ref->container};
                  unsigned long ipar[] = {~0x0UL, ~0x0UL};
                  status               = m_dbMgr->createAddress( repSvcType(), ref->clid, spar, ipar, pA );
                }
                if ( status.isSuccess() ) {
                  string top       = topLevel( pReg );
                  string leaf_name = top + ref->container.substr( 7 );
                  status           = m_dataMgr->registerAddress( leaf_name, pA );
                  if ( status.isSuccess() ) {
                    log() << MSG::DEBUG << "Created address for " << leaf_name << " of type " << ref->clid << endmsg;
                    continue;
                  }
                  makeError( "Failed to register leaves to directory:" + ident, false ).ignore();
                  break;
                }
                makeError( "Failed to create leave address to directory:" + ident, false ).ignore();
                break;
              }
            }
            makeError( "Failed to add leaves to directory:" + ident, false ).ignore();
            break;
          }
        }
      } else {
        return makeError( "Failed to access required tuple data description.", false );
      }
    }
  }
  for ( auto& ref : refs ) delete ref;
  return status;
}

StatusCode RootDirectoryCnv::updateRep ( IOpaqueAddress *  pAddr, DataObject *  pObj  )

override

Converter overrides: Update persistent object representation.

Parameters

pObj	[IN] Pointer to data object
refpAddr	[OUT] Location to store pointer to object address.

Returns

Status code indicating success or failure.

Definition at line 147 of file RootDirectoryCnv.cpp.

                                                                         {
  return StatusCode::SUCCESS;
}

StatusCode RootDirectoryCnv::updateRepRefs ( IOpaqueAddress *  pAddr, DataObject *  pObj  )

override

Converter overrides: Update references of persistent object representation.

Parameters

pObj	[IN] Pointer to data object
refpAddr	[OUT] Location to store pointer to object address.

Returns

Status code indicating success or failure.

Definition at line 152 of file RootDirectoryCnv.cpp.

                                                                             {
  return StatusCode::SUCCESS;
}

---

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

• RootCnv/RootCnv/RootDirectoryCnv.h
• RootCnv/src/RootDirectoryCnv.cpp