DataSvcHelpers::RegistryEntry Class Reference

Definition of an entry in the transient data store. More...

#include <GaudiKernel/RegistryEntry.h>

Inheritance diagram for DataSvcHelpers::RegistryEntry:

Collaboration diagram for DataSvcHelpers::RegistryEntry:

Public Types
typedef Store::const_iterator	Iterator
	Iterator definition. More...
Public Types inherited from IRegistry
typedef std::string	name_type
	Type definitions Name type. More...
typedef std::string	id_type
	Identifier Key type. More...

Public Member Functions
	RegistryEntry (std::string path, RegistryEntry *parent=nullptr)
	Standard Constructor. More...
	~RegistryEntry () override
	Standard Destructor. More...
unsigned long	release () override
	IInterface implementation: Reference the object. More...
unsigned long	addRef () override
	IInterface implementation: Dereference the object. More...
const std::string &	name () const override
	Retrieve name of the entry. More...
const std::string &	identifier () const override
	Full identifier (or key) More...
IDataProviderSvc *	dataSvc () const override
	Retrieve pointer to Transient Store. More...
DataObject *	object () const override
	Retrive object behind the link. More...
IOpaqueAddress *	address () const override
	Retrieve opaque storage address. More...
virtual IRegistry *	parent () const
	Pointer to parent directory entry. More...
virtual bool	isSoft () const
	Is the link soft or hard. More...
const Store &	leaves () const
	Access the leaves of the object. More...
virtual int	size () const
	Return the size of the container(=number of objects) More...
virtual bool	isEmpty () const
	Simple check if the Container is empty. More...
virtual Iterator	begin () const
	Return starting point for container iteration. More...
virtual Iterator	end () const
	Return end elemtn if the container. More...
virtual IRegistry *	find (const IRegistry *obj) const
	Try to find an object identified by its pointer. More...
virtual IRegistry *	find (const std::string &path) const
	Try to find an object identified by its relative name to the directory. More...
void	setAddress (IOpaqueAddress *pAddress) override
	Set/Update Opaque address. More...
void	setObject (DataObject *obj)
	Set/Update object address. More...
virtual long	add (const std::string &name, DataObject *pObject, bool is_soft=false)
	Add entry to data store. More...
virtual long	add (const std::string &name, IOpaqueAddress *pAddress, bool is_soft=false)
	Add entry to data store. More...
virtual long	remove (const std::string &name)
	Remove an entry from the store. More...
virtual long	add (IRegistry *obj)
	Add object to the container. More...
virtual long	remove (IRegistry *obj)
	Remove an object from the container. More...
virtual long	deleteElements ()
	Delete all contained elements. More...
virtual long	traverseTree (IDataStoreAgent *pAgent, int level=0)
	traverse data tree More...
Public Member Functions inherited from IRegistry
virtual	~IRegistry ()=default
	destructor More...

Private Types
typedef std::vector< IRegistry * >	Store
	Definition of datastore type. More...

Private Member Functions
void	assemblePath (std::string &buffer) const
	The following entries serve two aspects: 1) They are faster for recursive calls, because they are non-virtual 2) They can be re-used for the non-const entry points using a const_cast of the result. More...
IRegistry *	i_find (const IRegistry *pDirectory) const
	Internal method to retrieve data directory. More...
RegistryEntry *	i_find (boost::string_ref path) const
	Internal method to retrieve data directory. More...
RegistryEntry *	i_find (const DataObject *pObject) const
	Internal method to locate object entry. More...
RegistryEntry *	i_create (std::string name)
	Internal method to create entries. More...
long	i_add (RegistryEntry *entry)
	Internal method to add entries. More...
void	setParent (RegistryEntry *pParent)
	Set new parent pointer. More...
void	setDataSvc (IDataProviderSvc *s)
	Set the transient data store. More...
virtual RegistryEntry *	parentEntry ()
	Pointer to parent registry entry. More...
RegistryEntry *	findLeaf (boost::string_ref path) const
	Find identified leaf in this registry node. More...
RegistryEntry *	findLeaf (const DataObject *key) const
	Find identified leaf in this registry node. More...
void	makeHard (DataObject *pObject)
	Initialize link as hard link. More...
void	makeHard (IOpaqueAddress *pAddress)
	Initialize link as hard link. More...
void	makeSoft (DataObject *pObject)
	Initialize link as soft link. More...
void	makeSoft (IOpaqueAddress *pAddress)
	Initialize link as soft link. More...

Private Attributes
unsigned long	m_refCount = 0
	Reference counter. More...
bool	m_isSoft = false
	Is the link soft or hard? More...
std::string	m_fullpath
	String containing full path of the object (volatile) More...
std::string	m_path
	Path name. More...
RegistryEntry *	m_pParent = nullptr
	Pointer to parent. More...
IOpaqueAddress *	m_pAddress = nullptr
	Pointer to opaque address (load info) More...
DataObject *	m_pObject = nullptr
	Pointer to object. More...
IDataProviderSvc *	m_pDataProviderSvc = nullptr
	Pointer to hosting transient store. More...
Store	m_store
	Store of leaves. More...

Friends
class	::DataSvc
class	::TsDataSvc

Detailed Description

Definition of an entry in the transient data store.

The RegistryEntry represents an entry of the transient data store. The object holds the recipe how to retrieve objects from the persistent world (member IOpaqueAddress) as well as the backward link to the parent entry and the leaves.

Author

Markus Frank

Sebastien Ponce

Definition at line 36 of file RegistryEntry.h.

Member Typedef Documentation

typedef Store::const_iterator DataSvcHelpers::RegistryEntry::Iterator

Iterator definition.

Definition at line 45 of file RegistryEntry.h.

typedef std::vector<IRegistry*> DataSvcHelpers::RegistryEntry::Store

private

Definition of datastore type.

Definition at line 39 of file RegistryEntry.h.

Constructor & Destructor Documentation

DataSvcHelpers::RegistryEntry::RegistryEntry	(	std::string	path,
		RegistryEntry *	parent = nullptr
	)

Standard Constructor.

Definition at line 44 of file RegistryEntry.cpp.

                                                                                :
  m_path(std::move(path)),
  m_pParent(parent)
{
  std::string::size_type sep = m_path.rfind(SEPARATOR);
  if ( m_path.front() != SEPARATOR ) m_path.insert(0,1,SEPARATOR);
  if ( sep != std::string::npos )  m_path.erase(0,sep);
  assemblePath(m_fullpath);
  addRef();
}

DataSvcHelpers::RegistryEntry::~RegistryEntry ( )

override

Standard Destructor.

Standard destructor.

Definition at line 56 of file RegistryEntry.cpp.

                                             {
  deleteElements();
  if ( m_pObject  )   {
    if ( !m_isSoft ) m_pObject->setRegistry(nullptr);
    m_pObject->release();
  }
  if ( m_pAddress )   {
    if ( !m_isSoft ) m_pAddress->setRegistry(nullptr);
    m_pAddress->release();
  }
}

Member Function Documentation

long DataSvcHelpers::RegistryEntry::add ( const std::string &  name, DataObject *  pObject, bool  is_soft = false  )

virtual

Add entry to data store.

Add entry to the current data store item.

Reimplemented in Hive::HiveEventRegistryEntry.

Definition at line 197 of file RegistryEntry.cpp.

                                                                                                  {
  RegistryEntry* entry = i_create(name);
  if ( !entry ) return StatusCode::FAILURE;
  ( is_soft ) ? entry->makeSoft(pObject) : entry->makeHard(pObject);
  i_add( entry );
  return StatusCode::SUCCESS;
}

long DataSvcHelpers::RegistryEntry::add ( const std::string &  name, IOpaqueAddress *  pAddress, bool  is_soft = false  )

virtual

Add entry to data store.

Add entry to the current data store item.

Reimplemented in Hive::HiveEventRegistryEntry.

Definition at line 206 of file RegistryEntry.cpp.

                                                                                                       {
  RegistryEntry* entry = i_create(name);
  if ( !entry )  return StatusCode::FAILURE;
  ( is_soft ) ? entry->makeSoft(pAddress) : entry->makeHard(pAddress);
  i_add( entry );
  return StatusCode::SUCCESS;
}

long DataSvcHelpers::RegistryEntry::add ( IRegistry *  obj )

virtual

Add object to the container.

Reimplemented in Hive::HiveEventRegistryEntry.

Definition at line 169 of file RegistryEntry.cpp.

                                                      {
    RegistryEntry* pEntry = CAST_REGENTRY(RegistryEntry*, obj);
    return i_add(pEntry);
}

unsigned long DataSvcHelpers::RegistryEntry::addRef ( )

inlineoverridevirtual

IInterface implementation: Dereference the object.

Implements IRegistry.

Definition at line 118 of file RegistryEntry.h.

                                      {
      return ++m_refCount;
    }

IOpaqueAddress* DataSvcHelpers::RegistryEntry::address ( ) const

inlineoverridevirtual

Retrieve opaque storage address.

Implements IRegistry.

Definition at line 138 of file RegistryEntry.h.

                                                {
      return m_pAddress;
    }

void DataSvcHelpers::RegistryEntry::assemblePath ( std::string &  buffer ) const

private

The following entries serve two aspects: 1) They are faster for recursive calls, because they are non-virtual 2) They can be re-used for the non-const entry points using a const_cast of the result.

Recursive helper to assemble the full path name of the entry

Definition at line 303 of file RegistryEntry.cpp.

                                                                        {
  if ( m_pParent ) m_pParent->assemblePath(buffer);
  buffer += m_path;
}

virtual Iterator DataSvcHelpers::RegistryEntry::begin ( ) const

inlinevirtual

Return starting point for container iteration.

Definition at line 162 of file RegistryEntry.h.

                                           {
      return m_store.begin();
    }

IDataProviderSvc* DataSvcHelpers::RegistryEntry::dataSvc ( ) const

inlineoverridevirtual

Retrieve pointer to Transient Store.

Implements IRegistry.

Definition at line 130 of file RegistryEntry.h.

                                                {
      return m_pDataProviderSvc;
    }

long DataSvcHelpers::RegistryEntry::deleteElements ( )

virtual

Delete all contained elements.

Delete recursively all elements pending from the current store item.

Definition at line 215 of file RegistryEntry.cpp.

                                                   {
  for (auto& i : m_store ) {
    RegistryEntry* entry = CAST_REGENTRY(RegistryEntry*, i);
    if ( entry )   {
      entry->deleteElements();
      entry->release();
    }
  }
  m_store.erase(m_store.begin(), m_store.end());
  return 0;
}

virtual Iterator DataSvcHelpers::RegistryEntry::end ( ) const

inlinevirtual

Return end elemtn if the container.

Definition at line 166 of file RegistryEntry.h.

                                           {
      return m_store.end();
    }

virtual IRegistry* DataSvcHelpers::RegistryEntry::find ( const IRegistry *  obj ) const

inlinevirtual

Try to find an object identified by its pointer.

Definition at line 170 of file RegistryEntry.h.

                                                             {
      return i_find(obj);
    }

virtual IRegistry* DataSvcHelpers::RegistryEntry::find ( const std::string &  path ) const

inlinevirtual

Try to find an object identified by its relative name to the directory.

Definition at line 174 of file RegistryEntry.h.

                                                              {
      return i_find(path);
    }

RegistryEntry* DataSvcHelpers::RegistryEntry::findLeaf ( boost::string_ref  path ) const

inlineprivate

Find identified leaf in this registry node.

Definition at line 95 of file RegistryEntry.h.

                                                            {
      return i_find(path);
    }

RegistryEntry* DataSvcHelpers::RegistryEntry::findLeaf ( const DataObject *  key ) const

inlineprivate

Find identified leaf in this registry node.

Definition at line 99 of file RegistryEntry.h.

                                                           {
      return i_find(key);
    }

long DataSvcHelpers::RegistryEntry::i_add ( RegistryEntry *  entry )

private

Internal method to add entries.

Add object to the container.

Definition at line 175 of file RegistryEntry.cpp.

                                                               {
//TODO: if this is the sole place where items are added to m_store,
//      and we know here that they must be RegisteryEntry, can we
//      drop the dynamic_cast every where else???
//TODO: if so, can we also change m_store to be std::vector<RegistryEntry*>
//      instead
//TODO: if so, can we not make it std::vector<RegistryEntry> instead?
//TODO: if so, should make sure that a RegistryEntry can be std::move'ed
  try {
    pEntry->setDataSvc(m_pDataProviderSvc);
    m_store.push_back(pEntry);
    pEntry->setParent(this);
    if ( !pEntry->isSoft() && pEntry->address() )   {
      pEntry->address()->setRegistry(pEntry);
    }
  }
  catch ( ... )   {
  }
  return m_store.size();
}

DataSvcHelpers::RegistryEntry * DataSvcHelpers::RegistryEntry::i_create ( std::string  name )

private

Internal method to create entries.

Internal method to add entries.

Definition at line 159 of file RegistryEntry.cpp.

                                                                                   {
  if ( nam.front() != SEPARATOR ) nam.insert(0,1,SEPARATOR);
  // if this object is already present, this is an error....
  auto not_present = std::none_of( std::begin(m_store), std::end(m_store),
                                   [&](IRegistry* i) { return nam == i->name();
  } );
  return not_present ? new RegistryEntry( std::move(nam), this ) : nullptr;
}

IRegistry * DataSvcHelpers::RegistryEntry::i_find ( const IRegistry *  pDirectory ) const

private

Internal method to retrieve data directory.

Try to find an object identified by its pointer.

Definition at line 228 of file RegistryEntry.cpp.

                                                                             {
  auto i = std::find(m_store.begin(),m_store.end(),obj);
  return (i!=m_store.end()) ? (*i) : nullptr;
}

DataSvcHelpers::RegistryEntry * DataSvcHelpers::RegistryEntry::i_find ( boost::string_ref  path ) const

private

Internal method to retrieve data directory.

Find identified leaf in this registry node.

Definition at line 234 of file RegistryEntry.cpp.

                                                                                           {
  if ( path.front() == SEPARATOR ) path.remove_prefix(1);  // strip leading '/', if present
  while (!path.empty()) {
    // check that the chars of path prior to / are the same as regEnt->name()
    // (i.e. match { nam:"/Ab"  path:"/Ab/C"}
    // but not     { nam:"/Abc" path:"/Ab/C"})
    auto loc1 = path.find(SEPARATOR);
    auto cpath = path.substr(0,loc1);
    if (loc1 != boost::string_ref::npos) {
      path.remove_prefix(loc1+1);
    } else {
      path.clear();
    }
    auto i = std::find_if( std::begin(m_store), std::end(m_store),
                           [&](decltype(m_store)::const_reference reg) {
      return cpath == boost::string_ref{reg->name()}.substr(1);
    });
    if ( i!=std::end(m_store) ) {
      RegistryEntry* regEnt = CAST_REGENTRY(RegistryEntry*, *i);
      return  path.empty() ?  regEnt : regEnt->i_find(path);
    }
    // If this node is "/NodeA", this part allows to find "/NodeA/NodeB" as
    // our "/NodeB" child.
    if ( cpath != boost::string_ref{m_path}.substr(1) ) break;
  }
  return nullptr;
}

DataSvcHelpers::RegistryEntry * DataSvcHelpers::RegistryEntry::i_find ( const DataObject *  pObject ) const

private

Internal method to locate object entry.

Find identified leaf in this registry node.

Definition at line 263 of file RegistryEntry.cpp.

                                                                                              {
  if ( key )  {
    if ( key == m_pObject )    {
      return const_cast<RegistryEntry*>(this);
    }
    // Look in the immediate level:
    RegistryEntry *result = CAST_REGENTRY(RegistryEntry*, i_find(key->registry()));
    if ( result ) return result;
    // Go levels down
    for (const auto& i : m_store) {
      try   {
        const RegistryEntry *entry = CAST_REGENTRY(RegistryEntry*, i);
        result = entry->i_find(key);
        if( result ) return result;
      }
      catch ( ... )   {    }
    }
  }
  return nullptr;
}

const std::string& DataSvcHelpers::RegistryEntry::identifier ( ) const

inlineoverridevirtual

Full identifier (or key)

Implements IRegistry.

Definition at line 126 of file RegistryEntry.h.

                                                    {
      return m_fullpath;
    }

virtual bool DataSvcHelpers::RegistryEntry::isEmpty ( ) const

inlinevirtual

Simple check if the Container is empty.

Definition at line 158 of file RegistryEntry.h.

                                               {
      return m_store.size() == 0;
    }

virtual bool DataSvcHelpers::RegistryEntry::isSoft ( ) const

inlinevirtual

Is the link soft or hard.

Definition at line 146 of file RegistryEntry.h.

                                      {
      return m_isSoft;
    }

const Store& DataSvcHelpers::RegistryEntry::leaves ( ) const

inline

Access the leaves of the object.

Definition at line 150 of file RegistryEntry.h.

                                   {
      return m_store;
    }

void DataSvcHelpers::RegistryEntry::makeHard ( DataObject *  pObject )

private

Initialize link as hard link.

Create hard link.

Definition at line 98 of file RegistryEntry.cpp.

                                                                {
  makeSoft(pObject);
  m_isSoft = false;
  if ( m_pObject )   m_pObject->setRegistry(this);
  if ( m_pAddress )  m_pAddress->setRegistry(this);
}

void DataSvcHelpers::RegistryEntry::makeHard ( IOpaqueAddress *  pAddress )

private

Initialize link as hard link.

Create hard link.

Definition at line 106 of file RegistryEntry.cpp.

                                                                     {
  m_isSoft = false;
  setAddress(pAddress);
}

void DataSvcHelpers::RegistryEntry::makeSoft ( DataObject *  pObject )

private

Initialize link as soft link.

Create soft link.

Definition at line 83 of file RegistryEntry.cpp.

                                                                {
  m_isSoft = true;
  setObject(pObject);
//  if ( 0 != m_pObject )   { // Useless: This justs sets my own address again...
//    setAddress(m_pObject->address());
//  }
}

void DataSvcHelpers::RegistryEntry::makeSoft ( IOpaqueAddress *  pAddress )

private

Initialize link as soft link.

Create soft link.

Definition at line 92 of file RegistryEntry.cpp.

                                                                     {
  m_isSoft = true;
  setAddress(pAddress);
}

const std::string& DataSvcHelpers::RegistryEntry::name ( ) const

inlineoverridevirtual

Retrieve name of the entry.

Implements IRegistry.

Definition at line 122 of file RegistryEntry.h.

                                             {
      return m_path;
    }

DataObject* DataSvcHelpers::RegistryEntry::object ( ) const

inlineoverridevirtual

Retrive object behind the link.

Implements IRegistry.

Definition at line 134 of file RegistryEntry.h.

                                             {
      return m_pObject;
    }

virtual IRegistry* DataSvcHelpers::RegistryEntry::parent ( ) const

inlinevirtual

Pointer to parent directory entry.

Definition at line 142 of file RegistryEntry.h.

                                         {
      return m_pParent;
    }

virtual RegistryEntry* DataSvcHelpers::RegistryEntry::parentEntry ( )

inlineprivatevirtual

Pointer to parent registry entry.

Definition at line 91 of file RegistryEntry.h.

                                           {
      return m_pParent;
    }

unsigned long DataSvcHelpers::RegistryEntry::release ( )

overridevirtual

IInterface implementation: Reference the object.

Release entry.

Implements IRegistry.

Definition at line 69 of file RegistryEntry.cpp.

                                                    {
  unsigned long cnt = --m_refCount;
  if ( !m_refCount ) delete this;
  return cnt;
}

long DataSvcHelpers::RegistryEntry::remove ( const std::string &  name )

virtual

Remove an entry from the store.

Remove entry from data store.

Definition at line 146 of file RegistryEntry.cpp.

                                                                 {
  if ( nam.front() != SEPARATOR ) return remove( SEPARATOR+nam );
  // if this object is already present, this is an error....
  for (auto& i : m_store ) {
    if ( nam == i->name() )   {
      remove(i);
      return StatusCode::SUCCESS;
    }
  }
  return StatusCode::FAILURE;
}

long DataSvcHelpers::RegistryEntry::remove ( IRegistry *  obj )

virtual

Remove an object from the container.

Definition at line 132 of file RegistryEntry.cpp.

                                                              {
  try   {
    RegistryEntry* pEntry = dynamic_cast<RegistryEntry*>(obj);
    auto i = std::remove(std::begin(m_store), std::end(m_store), pEntry);
    if (i != std::end(m_store))   {
      pEntry->release();
      m_store.erase( i, std::end(m_store) );
    }
  }
  catch ( ... )   {     }
  return m_store.size();
}

void DataSvcHelpers::RegistryEntry::setAddress ( IOpaqueAddress *  pAddress )

overridevirtual

Set/Update Opaque address.

Update Opaque address of registry entry.

Implements IRegistry.

Definition at line 112 of file RegistryEntry.cpp.

                                                                          {
  if ( pAddress )   {
    pAddress->addRef();
    pAddress->setRegistry(this);
  }
  if ( m_pAddress ) m_pAddress->release();
  m_pAddress = pAddress;
}

void DataSvcHelpers::RegistryEntry::setDataSvc ( IDataProviderSvc *  s )

inlineprivate

Set the transient data store.

Definition at line 87 of file RegistryEntry.h.

                                            {
      m_pDataProviderSvc = s;
    }

void DataSvcHelpers::RegistryEntry::setObject

(

DataObject *

obj

)

Set/Update object address.

Set object pointer of data store item.

Definition at line 122 of file RegistryEntry.cpp.

                                                                   {
  if ( pObject  )  {
    pObject->addRef();
    if ( !isSoft() ) pObject->setRegistry(this);
  }
  if ( m_pObject ) m_pObject->release();
  m_pObject = pObject;
}

void DataSvcHelpers::RegistryEntry::setParent ( RegistryEntry *  pParent )

private

Set new parent pointer.

Definition at line 76 of file RegistryEntry.cpp.

                                                                     {
  m_pParent = pParent;
  m_fullpath.clear();
  assemblePath(m_fullpath);
}

virtual int DataSvcHelpers::RegistryEntry::size ( ) const

inlinevirtual

Return the size of the container(=number of objects)

Definition at line 154 of file RegistryEntry.h.

                                          {
      return m_store.size();
    }

long DataSvcHelpers::RegistryEntry::traverseTree ( IDataStoreAgent *  pAgent, int  level = 0  )

virtual

traverse data tree

Definition at line 285 of file RegistryEntry.cpp.

                                                                                 {
  bool go_down = pAgent->analyse(this, level);
  long status = StatusCode::SUCCESS;
  if ( go_down )    {
    for ( auto& i : m_store )   {
      try   {
        RegistryEntry* entry = CAST_REGENTRY(RegistryEntry*, i);
        entry->traverseTree(pAgent, level+1);
      }
      catch (...)   {
        status = StatusCode::FAILURE;
      }
    }
  }
  return status;
}

Friends And Related Function Documentation

friend class ::DataSvc

friend

Definition at line 41 of file RegistryEntry.h.

friend class ::TsDataSvc

friend

Definition at line 43 of file RegistryEntry.h.

Member Data Documentation

std::string DataSvcHelpers::RegistryEntry::m_fullpath

private

String containing full path of the object (volatile)

Definition at line 52 of file RegistryEntry.h.

bool DataSvcHelpers::RegistryEntry::m_isSoft = false

private

Is the link soft or hard?

Definition at line 50 of file RegistryEntry.h.

IOpaqueAddress* DataSvcHelpers::RegistryEntry::m_pAddress = nullptr

private

Pointer to opaque address (load info)

Definition at line 58 of file RegistryEntry.h.

std::string DataSvcHelpers::RegistryEntry::m_path

private

Path name.

Definition at line 54 of file RegistryEntry.h.

IDataProviderSvc* DataSvcHelpers::RegistryEntry::m_pDataProviderSvc = nullptr

private

Pointer to hosting transient store.

Definition at line 62 of file RegistryEntry.h.

DataObject* DataSvcHelpers::RegistryEntry::m_pObject = nullptr

private

Pointer to object.

Definition at line 60 of file RegistryEntry.h.

RegistryEntry* DataSvcHelpers::RegistryEntry::m_pParent = nullptr

private

Pointer to parent.

Definition at line 56 of file RegistryEntry.h.

unsigned long DataSvcHelpers::RegistryEntry::m_refCount = 0

private

Reference counter.

Definition at line 48 of file RegistryEntry.h.

Store DataSvcHelpers::RegistryEntry::m_store

private

Store of leaves.

Definition at line 64 of file RegistryEntry.h.

---

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

• GaudiKernel/GaudiKernel/RegistryEntry.h
• GaudiKernel/src/Lib/RegistryEntry.cpp