User example objects: SmartRefBase. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/SmartRefBase.h>

Collaboration diagram for SmartRefBase:

[legend]

Public Types
enum	{ DATAOBJECT, CONTAINEDOBJECT }

Public Member Functions
const ContainedObject *	accessData (const ContainedObject *typ) const
	Load on demand of ContainedObject like references. More...

const DataObject *	accessData (const DataObject *typ) const
	Load on demand of DataObject like references. More...

bool	isEqualEx (const DataObject *pObj, const SmartRefBase &c) const
	Extended equality check. More...

bool	isEqualEx (const ContainedObject *pObj, const SmartRefBase &c) const
	Extended equality check. More...

bool	isEqual (const ContainedObject *, const SmartRefBase &c) const
	Equality operator for ContainedObject like references. More...

bool	isEqual (const DataObject *, const SmartRefBase &c) const
	Equality operator for DataObject like references. More...

void	writeObject (const DataObject *pObject, StreamBuffer &s) const
	Output streamer for DataObject like references. More...

void	writeObject (const ContainedObject *pObject, StreamBuffer &s) const
	Output streamer for ContainedObject like references. More...

DataObject *	readObject (const DataObject *, StreamBuffer &s) const
	Input streamer for DataObject like references. More...

ContainedObject *	readObject (const ContainedObject *, StreamBuffer &s) const
	Output streamer for ContainedObject like references. More...

void	setObjectType (const ContainedObject *) const

void	setObjectType (const DataObject *) const

const std::string &	path () const
	Shortcut to access the path to the linked object. More...

long	objectType () const

void	set (DataObject *pObj, long hint_id, long link_id)
	Setup smart reference when reading. Must be allowed from external sources. More...

Public Attributes
long	m_hintID
	Object data: ID of the link hint to the identifiable object. More...

long	m_linkID
	Object data: ID of the object within the identifiable container (if any) More...

const DataObject *	m_data
	Object data: Pointer to the identifiable object the link originates. More...

const ContainedObject *	m_contd
	Object data: Pointer to the Contained object (if applicable) More...

long	m_type

Detailed Description

User example objects: SmartRefBase.

Description: Base class of SmartReference objects. The base class handles the object requests to the data store. The separation of the SmartReference and the base class is mainly to avoid code blow up, because if the object is not yet present serious work must be performed in order to request the object from the store and invoke object updates to keep pointers in sync.

Base Class: None

Dependencies: None

History :

+---------+----------------------------------------------+--------+
|    Date |                 Comment                      | Who    |
+---------+----------------------------------------------+--------+
| 21/06/99| Initial version.                             | MF     |
+---------+----------------------------------------------+--------+

Author: M.Frank Version: 1.0

Definition at line 57 of file SmartRefBase.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
DATAOBJECT
CONTAINEDOBJECT

Definition at line 70 of file SmartRefBase.h.

70 { DATAOBJECT, CONTAINEDOBJECT };

Member Function Documentation

◆ accessData() [1/2]

const ContainedObject * SmartRefBase::accessData ( const ContainedObject * typ ) const

Load on demand of ContainedObject like references.

Load on demand: ContainedObject type references.

Definition at line 43 of file SmartRefBase.cpp.

                                                                               {
   if ( m_hintID != StreamBuffer::INVALID && m_linkID != StreamBuffer::INVALID ) {
     const _Container* cnt = dynamic_cast<const _Container*>( accessData( m_data ) );
     if ( cnt ) return cnt->containedObject( m_linkID );
   }
   return nullptr;
 }

◆ accessData() [2/2]

const DataObject * SmartRefBase::accessData ( const DataObject * typ ) const

Load on demand of DataObject like references.

Load on demand: DataObject type references.

Definition at line 52 of file SmartRefBase.cpp.

                                                                     {
   if ( !m_data && m_contd ) m_data = m_contd->parent();
   DataObject* source = const_cast<DataObject*>( m_data );
   if ( m_hintID == StreamBuffer::INVALID || !source ) return nullptr;
   LinkManager* mgr = source->linkMgr();
   if ( !mgr ) return nullptr;
   LinkManager::Link* link = mgr->link( m_hintID );
   if ( !link ) return nullptr;
   DataObject* target = link->object();
   if ( !target ) {
     IRegistry* reg = source->registry();
     if ( !reg ) return nullptr;
     IDataProviderSvc* datasvc = reg->dataSvc();
     if ( datasvc && datasvc->retrieveObject( link->path(), target ).isSuccess() ) { link->setObject( target ); }
   }
   return target;
 }

◆ isEqual() [1/2]

bool SmartRefBase::isEqual	(	const ContainedObject *	,
		const SmartRefBase &	c
	)		const

inline

Equality operator for ContainedObject like references.

Definition at line 82 of file SmartRefBase.h.

                                                                         {
     return ( m_hintID == c.m_hintID && m_linkID == c.m_linkID && m_data == c.m_data && m_contd == c.m_contd );
   }

◆ isEqual() [2/2]

bool SmartRefBase::isEqual	(	const DataObject *	,
		const SmartRefBase &	c
	)		const

inline

Equality operator for DataObject like references.

Definition at line 86 of file SmartRefBase.h.

                                                                    {
     return m_linkID == c.m_linkID && m_data == c.m_data;
   }

◆ isEqualEx() [1/2]

bool SmartRefBase::isEqualEx	(	const ContainedObject *	pObj,
		const SmartRefBase &	c
	)		const

Extended equality check.

Definition at line 89 of file SmartRefBase.cpp.

                                                                                        {
   return isEqualEx( pObj->parent(), c ) && pObj->index() == c.m_linkID;
 }

◆ isEqualEx() [2/2]

bool SmartRefBase::isEqualEx	(	const DataObject *	pObj,
		const SmartRefBase &	c
	)		const

Extended equality check.

Definition at line 71 of file SmartRefBase.cpp.

                                                                                   {
   if ( c.m_hintID != StreamBuffer::INVALID && pObj ) {
     DataObject* source = const_cast<DataObject*>( c.m_data );
     if ( source ) {
       LinkManager* mgr = source->linkMgr();
       if ( mgr ) {
         const LinkManager::Link* link = mgr->link( c.m_hintID );
         if ( link ) {
           IRegistry* pReg = pObj->registry();
           return pReg && link->path() == pReg->identifier();
         }
       }
     }
   }
   return false;
 }

◆ objectType()

long SmartRefBase::objectType ( ) const

inline

Definition at line 114 of file SmartRefBase.h.

114 { return m_type; }

◆ path()

const std::string & SmartRefBase::path ( ) const

Shortcut to access the path to the linked object.

Definition at line 93 of file SmartRefBase.cpp.

                                           {
   static std::string s_empty_string{};
   DataObject*        source = nullptr;
   if ( !m_data && m_contd ) m_data = m_contd->parent();
   source = const_cast<DataObject*>( m_data );
   if ( m_hintID != StreamBuffer::INVALID && source ) {
     LinkManager* mgr = source->linkMgr();
     if ( mgr ) {
       const LinkManager::Link* link = mgr->link( m_hintID );
       if ( link ) return link->path();
     }
   }
   return s_empty_string;
 }

◆ readObject() [1/2]

ContainedObject* SmartRefBase::readObject	(	const ContainedObject *	,
		StreamBuffer &	s
	)		const

inline

Output streamer for ContainedObject like references.

Definition at line 102 of file SmartRefBase.h.

                                                                                  {
     ContainedObject* pObj = 0;
     s.getContainedLink( pObj, m_hintID, m_linkID );
     return pObj;
   }

◆ readObject() [2/2]

DataObject* SmartRefBase::readObject	(	const DataObject *	,
		StreamBuffer &	s
	)		const

inline

Input streamer for DataObject like references.

Definition at line 96 of file SmartRefBase.h.

                                                                        {
     DataObject* pObj = 0;
     s.getIdentifiedLink( pObj, m_hintID );
     return pObj;
   }

◆ set()

void SmartRefBase::set	(	DataObject *	pObj,
		long	hint_id,
		long	link_id
	)

Setup smart reference when reading. Must be allowed from external sources.

Setup smart reference.

Definition at line 36 of file SmartRefBase.cpp.

                                                                      {
   m_data   = pObj;
   m_hintID = hint_id;
   m_linkID = link_id;
 }

◆ setObjectType() [1/2]

void SmartRefBase::setObjectType ( const ContainedObject * ) const

inline

Definition at line 107 of file SmartRefBase.h.

107 { m_type = CONTAINEDOBJECT; }

◆ setObjectType() [2/2]

void SmartRefBase::setObjectType ( const DataObject * ) const

inline

Definition at line 108 of file SmartRefBase.h.

108 { m_type = DATAOBJECT; }

◆ writeObject() [1/2]

void SmartRefBase::writeObject	(	const ContainedObject *	pObject,
		StreamBuffer &	s
	)		const

inline

Output streamer for ContainedObject like references.

Definition at line 92 of file SmartRefBase.h.

                                                                             {
     s.addContainedLink( pObject, m_hintID, m_linkID );
   }

◆ writeObject() [2/2]

void SmartRefBase::writeObject	(	const DataObject *	pObject,
		StreamBuffer &	s
	)		const

inline

Output streamer for DataObject like references.

Definition at line 90 of file SmartRefBase.h.

90 { s.addIdentifiedLink( pObject, m_hintID ); }

Member Data Documentation

◆ m_contd

const ContainedObject* SmartRefBase::m_contd

mutable

Object data: Pointer to the Contained object (if applicable)

Definition at line 66 of file SmartRefBase.h.

◆ m_data

const DataObject* SmartRefBase::m_data

mutable

Object data: Pointer to the identifiable object the link originates.

Definition at line 64 of file SmartRefBase.h.

◆ m_hintID

long SmartRefBase::m_hintID

mutable

Object data: ID of the link hint to the identifiable object.

Definition at line 60 of file SmartRefBase.h.

◆ m_linkID

long SmartRefBase::m_linkID

mutable

Object data: ID of the object within the identifiable container (if any)

Definition at line 62 of file SmartRefBase.h.

◆ m_type

long SmartRefBase::m_type

mutable

Definition at line 68 of file SmartRefBase.h.

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

GaudiKernel/include/GaudiKernel/SmartRefBase.h
GaudiKernel/src/Lib/SmartRefBase.cpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ accessData() [1/2]

◆ accessData() [2/2]

◆ isEqual() [1/2]

◆ isEqual() [2/2]

◆ isEqualEx() [1/2]

◆ isEqualEx() [2/2]

◆ objectType()

◆ path()

◆ readObject() [1/2]

◆ readObject() [2/2]

◆ set()

◆ setObjectType() [1/2]

◆ setObjectType() [2/2]

◆ writeObject() [1/2]

◆ writeObject() [2/2]

Member Data Documentation

◆ m_contd

◆ m_data

◆ m_hintID

◆ m_linkID

◆ m_type