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

Collaboration diagram for SmartRef< TYPE >:

[legend]

Public Types
enum	{ VALID = StreamBuffer::VALID, INVALID = StreamBuffer::INVALID }

typedef TYPE	entry_type
	Entry type definition. More...

Public Member Functions
	SmartRef (const TYPE *pObject=nullptr)
	Standard Constructor. More...

	SmartRef (const SmartRef &copy)
	Copy Constructor. More...

	SmartRef (long hint, long link, const TYPE *obj=nullptr)
	Constructor. More...

	SmartRef (const ContainedObject pObj, long hint, long link, const TYPE obj=nullptr)
	Constructor for references to contained objects passing environment. More...

	SmartRef (const DataObject pObj, long hint, long link, const TYPE obj=nullptr)
	Constructor for references to contained objects passing environment. More...

	SmartRef (const DataObject pObj, long hint, const TYPE obj=nullptr)
	Constructor for references to DataObjects passing environment. More...

bool	shouldFollowLink (const DataObject *) const
	Check if link should be followed: link must be valid and object not yet loaded. More...

bool	shouldFollowLink (const ContainedObject *) const
	Check if link should be followed: link must be valid and object not yet loaded. More...

long	hintID () const
	Access hint id: More...

long	linkID () const
	Access link id: More...

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

const std::type_info *	type () const
	Access to embedded type. More...

TYPE *	data ()
	Access to raw data pointer. More...

const TYPE *	data () const

const TYPE *	target () const
	Access to the object. More...

TYPE *	target ()
	Access to the object. More...

const std::string &	path () const
	Return the path of the linked object inside the data store. More...

bool	operator== (const SmartRef< TYPE > &c) const
	Equality operator. More...

bool	operator== (SmartRef< TYPE > &rhs)

	operator bool () const
	explicit conversion to bool to check for object existence (will load object) More...

const SmartRef< TYPE > &	_setEnvironment (const DataObject pObj, const ContainedObject pContd) const
	Set the environment (CONST) More...

SmartRef< TYPE > &	_setEnvironment (const DataObject pObj, const ContainedObject pContd)
	Set the environment (CONST) More...

SmartRef< TYPE > &	operator() (ContainedObject *pObj)
	operator(): assigns parent object for serialisation More...

const SmartRef< TYPE > &	operator() (const ContainedObject *pObj) const
	operator() const: assigns parent object for serialisation More...

SmartRef< TYPE > &	operator() (DataObject *pObj)
	operator(): assigns parent object for serialisation More...

const SmartRef< TYPE > &	operator() (const DataObject *pObj) const
	operator() const: assigns parent object for serialisation More...

SmartRef< TYPE > &	operator= (const SmartRef< TYPE > &c)
	Assignment. More...

SmartRef< TYPE > &	operator= (const TYPE *pObject)
	Assignment. More...

TYPE &	operator* ()
	Dereference operator. More...

const TYPE &	operator* () const
	Dereference operator. More...

TYPE *	operator-> ()
	Dereference operator. More...

const TYPE *	operator-> () const
	Dereference operator to const object. More...

	operator const TYPE * () const
	Implicit type conversion to const object. More...

	operator TYPE * ()
	Implicit type conversion. More...

StreamBuffer &	writeRef (StreamBuffer &s) const
	Write the reference to the stream buffer (needed due to stupid G++ compiler) More...

StreamBuffer &	readRef (StreamBuffer &s)
	Read the reference from the stream buffer (needed due to stupid G++ compiler) More...

Private Attributes
SmartRefBase	m_base

const TYPE *	m_target = nullptr
	Pointer to target data object. More...

Friends
class	SmartRefArray< TYPE >
	The container must be a friend. More...

class	SmartRefList< TYPE >

class	SmartRefMap< TYPE >

bool	operator== (SmartRef< TYPE > &lhs, TYPE *rhs)

bool	operator== (const SmartRef< TYPE > &lhs, const TYPE *rhs)

StreamBuffer &	operator<< (StreamBuffer &_s, const SmartRef< TYPE > &ptr)
	Output Streamer operator. More...

StreamBuffer &	operator>> (StreamBuffer &_s, SmartRef< TYPE > &ptr)
	Input Streamer operator. More...

Detailed Description

template<class TYPE>
class SmartRef< TYPE >

Kernel objects: SmartRef.

Description: The SmartRef class allows transparent handling of object links within the data store. Links are unloaded a priori and will only be loaded "on demand", i.e. when dereferenced.

SmartRefs should behave in the same way as normal pointers; The SmartRef object in fact is a smart pointer construct intercepting the dereference operators.

When loading, the executed code resides in the non templated base class. This ensures, that the templated code is minimized and code blow up is inhibited.

Using SmartRefs StreamBuffers are able to also save the references on data conversion requests.

Base Class: SmartRefBase

Dependencies:

Base class: GaudiKernel/SmartRefBase.h

History :

+---------+----------------------------------------------+--------+
|    Date |                 Comment                      | Who    |
+---------+----------------------------------------------+--------+
| 21/04/99| Initial version.                             | MF     |
| 16/01/04| Move base class into aggregation.            | MF     |
+---------+----------------------------------------------+--------+

Author: M.Frank Version: 1.0

Definition at line 64 of file SmartRef.h.

Member Typedef Documentation

◆ entry_type

template<class TYPE >

typedef TYPE SmartRef< TYPE >::entry_type

Entry type definition.

Definition at line 77 of file SmartRef.h.

Member Enumeration Documentation

◆ anonymous enum

template<class TYPE >

anonymous enum

Enumerator
VALID
INVALID

Definition at line 75 of file SmartRef.h.

75 { VALID = StreamBuffer::VALID, INVALID = StreamBuffer::INVALID };

Constructor & Destructor Documentation

◆ SmartRef() [1/6]

template<class TYPE >

SmartRef< TYPE >::SmartRef ( const TYPE * pObject = nullptr )

inline

Standard Constructor.

Definition at line 80 of file SmartRef.h.

                                             {
     m_base.m_hintID = INVALID;
     m_base.m_linkID = INVALID;
     m_target        = pObject;
     _setEnvironment( nullptr, nullptr );
   }

◆ SmartRef() [2/6]

template<class TYPE >

SmartRef< TYPE >::SmartRef ( const SmartRef< TYPE > & copy )

inline

Copy Constructor.

Definition at line 87 of file SmartRef.h.

                                    {
     m_base.m_hintID = copy.m_base.m_hintID;
     m_base.m_linkID = copy.m_base.m_linkID;
     m_target        = copy.m_target;
     _setEnvironment( copy.m_base.m_data, copy.m_base.m_contd );
   }

◆ SmartRef() [3/6]

template<class TYPE >

SmartRef< TYPE >::SmartRef	(	long	hint,
		long	link,
		const TYPE *	obj = `nullptr`
	)

inline

Constructor.

Definition at line 94 of file SmartRef.h.

                                                               {
     m_base.m_hintID = hint;
     m_base.m_linkID = link;
     m_target        = obj;
     _setEnvironment( nullptr, nullptr );
   }

◆ SmartRef() [4/6]

template<class TYPE >

SmartRef< TYPE >::SmartRef	(	const ContainedObject *	pObj,
		long	hint,
		long	link,
		const TYPE *	obj = `nullptr`
	)

inline

Constructor for references to contained objects passing environment.

Definition at line 101 of file SmartRef.h.

                                                                                            {
     m_base.m_hintID       = hint;
     m_base.m_linkID       = link;
     m_target              = obj;
     const DataObject* src = ( pObj ? pObj->parent() : nullptr );
     _setEnvironment( src, pObj );
   }

◆ SmartRef() [5/6]

template<class TYPE >

SmartRef< TYPE >::SmartRef	(	const DataObject *	pObj,
		long	hint,
		long	link,
		const TYPE *	obj = `nullptr`
	)

inline

Constructor for references to contained objects passing environment.

Definition at line 109 of file SmartRef.h.

                                                                                       {
     m_base.m_hintID = hint;
     m_base.m_linkID = link;
     m_target        = obj;
     _setEnvironment( pObj, nullptr );
   }

◆ SmartRef() [6/6]

template<class TYPE >

SmartRef< TYPE >::SmartRef	(	const DataObject *	pObj,
		long	hint,
		const TYPE *	obj = `nullptr`
	)

inline

Constructor for references to DataObjects passing environment.

Definition at line 116 of file SmartRef.h.

                                                                            {
     m_base.m_hintID = hint;
     m_base.m_linkID = INVALID;
     m_target        = obj;
     _setEnvironment( pObj, nullptr );
   }

Member Function Documentation

◆ _setEnvironment() [1/2]

template<class TYPE >

SmartRef<TYPE>& SmartRef< TYPE >::_setEnvironment	(	const DataObject *	pObj,
		const ContainedObject *	pContd
	)

inline

Set the environment (CONST)

Definition at line 175 of file SmartRef.h.

                                                                                            {
     m_base.m_data  = pObj;
     m_base.m_contd = pContd;
     m_base.setObjectType( data() );
     return *this;
   }

◆ _setEnvironment() [2/2]

template<class TYPE >

const SmartRef<TYPE>& SmartRef< TYPE >::_setEnvironment	(	const DataObject *	pObj,
		const ContainedObject *	pContd
	)		const

inline

Set the environment (CONST)

Definition at line 168 of file SmartRef.h.

                                                                                                        {
     m_base.m_data  = pObj;
     m_base.m_contd = pContd;
     m_base.setObjectType( data() );
     return *this;
   }

◆ data() [1/2]

template<class TYPE >

TYPE* SmartRef< TYPE >::data ( )

inline

Access to raw data pointer.

Definition at line 137 of file SmartRef.h.

137 { return const_cast<TYPE*>( m_target ); }

◆ data() [2/2]

template<class TYPE >

const TYPE* SmartRef< TYPE >::data ( ) const

inline

Definition at line 138 of file SmartRef.h.

138 { return m_target; }

◆ hintID()

template<class TYPE >

long SmartRef< TYPE >::hintID ( ) const

inline

Access hint id:

Definition at line 129 of file SmartRef.h.

129 { return m_base.m_hintID; }

◆ linkID()

template<class TYPE >

long SmartRef< TYPE >::linkID ( ) const

inline

Access link id:

Definition at line 131 of file SmartRef.h.

131 { return m_base.m_linkID; }

◆ operator bool()

template<class TYPE >

SmartRef< TYPE >::operator bool ( ) const

inlineexplicit

explicit conversion to bool to check for object existence (will load object)

Definition at line 165 of file SmartRef.h.

165 { return target() != nullptr; }

◆ operator const TYPE *()

template<class TYPE >

SmartRef< TYPE >::operator const TYPE * ( ) const

inline

Implicit type conversion to const object.

Definition at line 218 of file SmartRef.h.

218 { return SmartRef<TYPE>::target(); }

◆ operator TYPE *()

template<class TYPE >

SmartRef< TYPE >::operator TYPE * ( )

inline

Implicit type conversion.

Definition at line 220 of file SmartRef.h.

220 { return SmartRef<TYPE>::target(); }

◆ operator()() [1/4]

template<class TYPE >

const SmartRef<TYPE>& SmartRef< TYPE >::operator() ( const ContainedObject * pObj ) const

inline

operator() const: assigns parent object for serialisation

Definition at line 187 of file SmartRef.h.

                                                                         {
     const DataObject* src = ( pObj ? pObj->parent() : nullptr );
     return _setEnvironment( src, pObj );
   }

◆ operator()() [2/4]

template<class TYPE >

const SmartRef<TYPE>& SmartRef< TYPE >::operator() ( const DataObject * pObj ) const

inline

operator() const: assigns parent object for serialisation

Definition at line 194 of file SmartRef.h.

194 { return _setEnvironment( pObj, nullptr ); }

◆ operator()() [3/4]

template<class TYPE >

SmartRef<TYPE>& SmartRef< TYPE >::operator() ( ContainedObject * pObj )

inline

operator(): assigns parent object for serialisation

Definition at line 182 of file SmartRef.h.

                                                       {
     const DataObject* src = ( pObj ? pObj->parent() : nullptr );
     return _setEnvironment( src, pObj );
   }

◆ operator()() [4/4]

template<class TYPE >

SmartRef<TYPE>& SmartRef< TYPE >::operator() ( DataObject * pObj )

inline

operator(): assigns parent object for serialisation

Definition at line 192 of file SmartRef.h.

192 { return _setEnvironment( pObj, nullptr ); }

◆ operator*() [1/2]

template<class TYPE >

TYPE& SmartRef< TYPE >::operator* ( )

inline

Dereference operator.

Definition at line 210 of file SmartRef.h.

210 { return *SmartRef<TYPE>::target(); }

◆ operator*() [2/2]

template<class TYPE >

const TYPE& SmartRef< TYPE >::operator* ( ) const

inline

Dereference operator.

Definition at line 212 of file SmartRef.h.

212 { return *SmartRef<TYPE>::target(); }

◆ operator->() [1/2]

template<class TYPE >

TYPE* SmartRef< TYPE >::operator-> ( )

inline

Dereference operator.

Definition at line 214 of file SmartRef.h.

214 { return SmartRef<TYPE>::target(); }

◆ operator->() [2/2]

template<class TYPE >

const TYPE* SmartRef< TYPE >::operator-> ( ) const

inline

Dereference operator to const object.

Definition at line 216 of file SmartRef.h.

216 { return SmartRef<TYPE>::target(); }

◆ operator=() [1/2]

template<class TYPE >

SmartRef<TYPE>& SmartRef< TYPE >::operator= ( const SmartRef< TYPE > & c )

inline

Assignment.

Definition at line 196 of file SmartRef.h.

                                                        {
     m_target        = c.m_target;
     m_base.m_hintID = c.m_base.m_hintID;
     m_base.m_linkID = c.m_base.m_linkID;
     return _setEnvironment( c.m_base.m_data, c.m_base.m_contd );
   }

◆ operator=() [2/2]

template<class TYPE >

SmartRef<TYPE>& SmartRef< TYPE >::operator= ( const TYPE * pObject )

inline

Assignment.

Definition at line 203 of file SmartRef.h.

                                                    {
     m_target        = pObject;
     m_base.m_hintID = INVALID;
     m_base.m_linkID = INVALID;
     return *this;
   }

◆ operator==() [1/2]

template<class TYPE >

bool SmartRef< TYPE >::operator== ( const SmartRef< TYPE > & c ) const

inline

Equality operator.

Definition at line 152 of file SmartRef.h.

                                                    {
     if ( m_target && c.m_target ) return m_target == c.m_target;
     if ( !m_target && !c.m_target ) return m_base.isEqual( m_target, c.m_base );
     if ( m_target && !c.m_target ) return m_base.isEqualEx( m_target, c.m_base );
     if ( !m_target && c.m_target ) return c.m_base.isEqualEx( c.m_target, m_base );
     return false;
   }

◆ operator==() [2/2]

template<class TYPE >

bool SmartRef< TYPE >::operator== ( SmartRef< TYPE > & rhs )

inline

Definition at line 159 of file SmartRef.h.

159 { return std::as_const( *this ) == std::as_const( rhs ); }

◆ path()

template<class TYPE >

const std::string& SmartRef< TYPE >::path ( ) const

inline

Return the path of the linked object inside the data store.

Definition at line 150 of file SmartRef.h.

150 { return m_base.path(); }

◆ readRef()

template<class TYPE >

StreamBuffer& SmartRef< TYPE >::readRef ( StreamBuffer & s )

inline

Read the reference from the stream buffer (needed due to stupid G++ compiler)

Definition at line 227 of file SmartRef.h.

                                            {
     m_target = dynamic_cast<const TYPE*>( m_base.readObject( m_target, s ) );
     return s;
   }

◆ set()

template<class TYPE >

void SmartRef< TYPE >::set	(	DataObject *	pObj,
		long	hint_id,
		long	link_id
	)

inline

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

Definition at line 133 of file SmartRef.h.

133 { m_base.set( pObj, hint_id, link_id ); }

◆ shouldFollowLink() [1/2]

template<class TYPE >

bool SmartRef< TYPE >::shouldFollowLink ( const ContainedObject * ) const

inline

Check if link should be followed: link must be valid and object not yet loaded.

Definition at line 125 of file SmartRef.h.

                                                         {
     return !m_target && m_base.m_hintID != INVALID && m_base.m_linkID != INVALID;
   }

◆ shouldFollowLink() [2/2]

template<class TYPE >

bool SmartRef< TYPE >::shouldFollowLink ( const DataObject * ) const

inline

Check if link should be followed: link must be valid and object not yet loaded.

Definition at line 123 of file SmartRef.h.

123 { return !m_target && m_base.m_hintID != INVALID; }

◆ target() [1/2]

template<class TYPE >

TYPE* SmartRef< TYPE >::target ( )

inline

Access to the object.

Definition at line 145 of file SmartRef.h.

                  {
     if ( !m_target ) { m_target = dynamic_cast<const TYPE*>( m_base.accessData( m_target ) ); }
     return const_cast<TYPE*>( m_target );
   }

◆ target() [2/2]

template<class TYPE >

const TYPE* SmartRef< TYPE >::target ( ) const

inline

Access to the object.

Definition at line 140 of file SmartRef.h.

                              {
     if ( !m_target ) { m_target = dynamic_cast<const TYPE*>( m_base.accessData( m_target ) ); }
     return m_target;
   }

◆ type()

template<class TYPE >

const std::type_info* SmartRef< TYPE >::type ( ) const

inline

Access to embedded type.

Definition at line 135 of file SmartRef.h.

135 { return &typeid( TYPE ); }

◆ writeRef()

template<class TYPE >

StreamBuffer& SmartRef< TYPE >::writeRef ( StreamBuffer & s ) const

inline

Write the reference to the stream buffer (needed due to stupid G++ compiler)

Definition at line 222 of file SmartRef.h.

                                                   {
     m_base.writeObject( m_target, s );
     return s;
   }

Friends And Related Function Documentation

◆ operator<<

template<class TYPE >

StreamBuffer& operator<<	(	StreamBuffer &	_s,
		const SmartRef< TYPE > &	ptr
	)

friend

Output Streamer operator.

Definition at line 233 of file SmartRef.h.

233 { return ptr.writeRef( _s ); }

◆ operator== [1/2]

template<class TYPE >

bool operator==	(	const SmartRef< TYPE > &	lhs,
		const TYPE *	rhs
	)

friend

Definition at line 162 of file SmartRef.h.

162 { return lhs.target() == rhs; }

◆ operator== [2/2]

template<class TYPE >

bool operator==	(	SmartRef< TYPE > &	lhs,
		TYPE *	rhs
	)

friend

Definition at line 161 of file SmartRef.h.

161 { return lhs.target() == rhs; }

◆ operator>>

template<class TYPE >

StreamBuffer& operator>>	(	StreamBuffer &	_s,
		SmartRef< TYPE > &	ptr
	)

friend

Input Streamer operator.

Definition at line 236 of file SmartRef.h.

236 { return ptr.readRef( _s ); }

◆ SmartRefArray< TYPE >

template<class TYPE >

friend class SmartRefArray< TYPE >

friend

The container must be a friend.

Definition at line 1 of file SmartRef.h.

◆ SmartRefList< TYPE >

template<class TYPE >

friend class SmartRefList< TYPE >

friend

Definition at line 1 of file SmartRef.h.

◆ SmartRefMap< TYPE >

template<class TYPE >

friend class SmartRefMap< TYPE >

friend

Definition at line 1 of file SmartRef.h.

Member Data Documentation

◆ m_base

template<class TYPE >

SmartRefBase SmartRef< TYPE >::m_base

private

Definition at line 70 of file SmartRef.h.

◆ m_target

template<class TYPE >

const TYPE* SmartRef< TYPE >::m_target = nullptr

mutableprivate

Pointer to target data object.

Definition at line 72 of file SmartRef.h.

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

GaudiKernel/include/GaudiKernel/SmartRef.h

Public Types

Public Member Functions

Private Attributes

Friends

Detailed Description

template<class TYPE> class SmartRef< TYPE >

Member Typedef Documentation

◆ entry_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SmartRef() [1/6]

◆ SmartRef() [2/6]

◆ SmartRef() [3/6]

◆ SmartRef() [4/6]

◆ SmartRef() [5/6]

◆ SmartRef() [6/6]

Member Function Documentation

◆ _setEnvironment() [1/2]

◆ _setEnvironment() [2/2]

◆ data() [1/2]

◆ data() [2/2]

◆ hintID()

◆ linkID()

◆ operator bool()

◆ operator const TYPE *()

◆ operator TYPE *()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ path()

◆ readRef()

◆ set()

◆ shouldFollowLink() [1/2]

◆ shouldFollowLink() [2/2]

◆ target() [1/2]

◆ target() [2/2]

◆ type()

◆ writeRef()

Friends And Related Function Documentation

◆ operator<<

◆ operator== [1/2]

◆ operator== [2/2]

◆ operator>>

◆ SmartRefArray< TYPE >

◆ SmartRefList< TYPE >

◆ SmartRefMap< TYPE >

Member Data Documentation

◆ m_base

◆ m_target

template<class TYPE>
class SmartRef< TYPE >