LinkManager Class Reference

#include <GaudiKernel/LinkManager.h>

Collaboration diagram for LinkManager:

Classes
class	Link
	Embedded class defining a symbolic link Note: No explicit copy constructor; implicit compiler generated one is just fine. More...
struct	Sentinel

Public Types
enum	DirLinkType { INVALID, VALID }
	Directory link types. More...

Public Member Functions
	LinkManager ()=default
	Standard Constructor. More...
	~LinkManager ()
	Standard Destructor. More...
long	size () const
	Retrieve number of link present. More...
bool	empty () const
const Link *	link (long id) const
	Retrieve symbolic link identified by ID. More...
Link *	link (long id)
const Link *	link (const DataObject *pObject) const
	Retrieve symbolic link identified by object. More...
Link *	link (const DataObject *pObject)
const Link *	link (std::string_view path) const
	Retrieve symbolic link identified by path. More...
Link *	link (std::string_view path)
long	addLink (const std::string &path, const DataObject *pObject)
	Add link by object reference and path. More...
Sentinel	end () const
auto	begin () const

Static Public Member Functions
static LinkManager *	newInstance ()
	Static instantiation. More...
static void	setInstantiator (LinkManager *(*newInstance)())
	Assign new instantiator. More...

Private Attributes
std::vector< Link * >	m_linkVector
	@ TODO: replace by std::vector<std::unique_ptr<Link>> once ROOT does 'automatic' schema conversion from T* to std::unique_ptr<T>... More...

Detailed Description

A LinkManager is the object aggregated into a DataObject, which is responsible for the handling of non-tree like links.

Author

M.Frank

Definition at line 31 of file LinkManager.h.

Member Enumeration Documentation

DirLinkType

enum LinkManager::DirLinkType

Directory link types.

Enumerator
INVALID
VALID

Definition at line 35 of file LinkManager.h.

{ INVALID, VALID };

Constructor & Destructor Documentation

LinkManager()

LinkManager::LinkManager ( )

default

Standard Constructor.

~LinkManager()

LinkManager::~LinkManager

(

)

Standard Destructor.

destructor

Definition at line 29 of file LinkManager.cpp.

                          {
  for ( auto& i : m_linkVector ) delete i;
}

Member Function Documentation

addLink()

long LinkManager::addLink	(	const std::string &	path,
		const DataObject *	pObject
	)

Add link by object reference and path.

Add link by object reference and path string.

Definition at line 75 of file LinkManager.cpp.

                                                                            {
  long n = 0;
  for ( auto& lnk : m_linkVector ) {
    const DataObject* pO = lnk->object();
    if ( pO && pO == pObject ) return n;
    if ( lnk->path() == path ) {
      if ( pObject && pObject != pO ) { lnk->setObject( const_cast<DataObject*>( pObject ) ); }
      return n;
    }
    ++n;
  }
  // Link is completely unknown
  return m_linkVector.emplace_back( new Link( m_linkVector.size(), path, const_cast<DataObject*>( pObject ) ) )->ID();
}

begin()

auto LinkManager::begin ( ) const

inline

Definition at line 107 of file LinkManager.h.

                         {
    class Iterator {
      int                i;
      LinkManager const* parent;
 
    public:
      Iterator( LinkManager const* p, int i ) : i{ i }, parent{ p } {}
      bool      operator==( Sentinel ) const { return i == parent->size(); }
      bool      operator!=( Sentinel ) const { return !( *this == Sentinel{} ); }
      Iterator& operator++() {
        ++i;
        return *this;
      }
      const Link& operator*() const { return *parent->link( i ); }
    };
    return Iterator{ this, 0 };
  }

empty()

bool LinkManager::empty ( ) const

inline

Definition at line 92 of file LinkManager.h.

{ return m_linkVector.empty(); }

end()

Sentinel LinkManager::end ( ) const

inline

Definition at line 106 of file LinkManager.h.

{ return {}; }

link() [1/6]

LinkManager::Link * LinkManager::link

(

const DataObject *

pObject

)

Definition at line 62 of file LinkManager.cpp.

                                                              {
  return pObject ? findLink( m_linkVector, [=]( auto* j ) { return j->object() == pObject; } ) : nullptr;
}

link() [2/6]

const LinkManager::Link * LinkManager::link

(

const DataObject *

pObject

)

const

Retrieve symbolic link identified by object.

Retrieve symbolic link identified by Object pointer.

Definition at line 58 of file LinkManager.cpp.

                                                                          {
  return pObject ? findLink( m_linkVector, [=]( auto* j ) { return j->object() == pObject; } ) : nullptr;
}

link() [3/6]

LinkManager::Link * LinkManager::link

(

long

id

)

Definition at line 53 of file LinkManager.cpp.

                                            {
  return ( 0 <= id && (unsigned)id < m_linkVector.size() ) ? m_linkVector[id] : nullptr;
}

link() [4/6]

const LinkManager::Link * LinkManager::link

(

long

id

)

const

Retrieve symbolic link identified by ID.

Definition at line 49 of file LinkManager.cpp.

                                                        {
  return ( 0 <= id && (unsigned)id < m_linkVector.size() ) ? m_linkVector[id] : nullptr;
}

link() [5/6]

LinkManager::Link * LinkManager::link

(

std::string_view

path

)

Definition at line 70 of file LinkManager.cpp.

                                                        {
  return !path.empty() ? findLink( m_linkVector, [=]( auto* j ) { return j->path() == path; } ) : nullptr;
}

link() [6/6]

const LinkManager::Link * LinkManager::link

(

std::string_view

path

)

const

Retrieve symbolic link identified by path.

Retrieve symbolic link identified by Object path.

Definition at line 67 of file LinkManager.cpp.

                                                                    {
  return !path.empty() ? findLink( m_linkVector, [=]( auto* j ) { return j->path() == path; } ) : nullptr;
}

newInstance()

LinkManager * LinkManager::newInstance ( )

static

Static instantiation.

Definition at line 46 of file LinkManager.cpp.

{ return s_newInstance ? ( *s_newInstance )() : new LinkManager(); }

setInstantiator()

void LinkManager::setInstantiator ( LinkManager *(*)()  newInstance )

static

Assign new instantiator.

Definition at line 43 of file LinkManager.cpp.

{ s_newInstance = newInstance; }

size()

long LinkManager::size ( ) const

inline

Retrieve number of link present.

Definition at line 91 of file LinkManager.h.

{ return m_linkVector.size(); }

Member Data Documentation

m_linkVector

std::vector<Link*> LinkManager::m_linkVector

private

@ TODO: replace by std::vector<std::unique_ptr<Link>> once ROOT does 'automatic' schema conversion from T* to std::unique_ptr<T>...

Or, even better, just std::vector<Link>, given that Link is barely larger than a pointer (40 vs. 8 bytes) – but that requires more invasive schema evolution.

The vector containing all links which are non-tree like

Definition at line 79 of file LinkManager.h.

---

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

• GaudiKernel/include/GaudiKernel/LinkManager.h
• GaudiKernel/src/Lib/LinkManager.cpp