SmartRef< TYPE > Class Template Reference

Kernel objects: SmartRef. More...

#include <GaudiKernel/SmartRef.h>

Collaboration diagram for SmartRef< TYPE >:

Public Types
enum	{ VALID = StreamBuffer::VALID, INVALID = StreamBuffer::INVALID }
typedef TYPE	entry_type
	Entry type definition. More...

Public Member Functions
	SmartRef ()
	Standard Constructor. More...
	SmartRef (TYPE *pObject)
	Standard Constructor with initialisation. More...
	SmartRef (const TYPE *pObject)
	Standard Constructor with initialisation from const object. More...
	SmartRef (const SmartRef &copy)
	Copy Constructor. More...
	SmartRef (long hint, long link, TYPE *obj=nullptr)
	Constructor. More...
	SmartRef (const ContainedObject *pObj, long hint, long link, TYPE *obj=nullptr)
	Constructor for references to contained objects passing environment. More...
	SmartRef (const DataObject *pObj, long hint, long link, TYPE *obj=nullptr)
	Constructor for references to contained objects passing environment. More...
	SmartRef (const DataObject *pObj, long hint, TYPE *obj=nullptr)
	Constructor for references to DataObjects passing environment. More...
bool	shouldFollowLink (const DataObject *) const
	Standard destructor. 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!= (const SmartRef< TYPE > &c) const
	NON-Equality operator. 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= (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...

Protected 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 >
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 76 of file SmartRef.h.

Member Typedef Documentation

entry_type

template<class TYPE>

typedef TYPE SmartRef< TYPE >::entry_type

Entry type definition.

Definition at line 85 of file SmartRef.h.

Member Enumeration Documentation

anonymous enum

template<class TYPE>

anonymous enum

Enumerator
VALID
INVALID

Definition at line 83 of file SmartRef.h.

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

Constructor & Destructor Documentation

SmartRef() [1/8]

template<class TYPE>

SmartRef< TYPE >::SmartRef ( )

inline

Standard Constructor.

Definition at line 94 of file SmartRef.h.

             {
    m_base.m_hintID = INVALID;
    m_base.m_linkID = INVALID;
    _setEnvironment( 0, 0 );
  }

SmartRef() [2/8]

template<class TYPE>

SmartRef< TYPE >::SmartRef ( TYPE *  pObject )

inline

Standard Constructor with initialisation.

Definition at line 100 of file SmartRef.h.

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

SmartRef() [3/8]

template<class TYPE>

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

inline

Standard Constructor with initialisation from const object.

Definition at line 107 of file SmartRef.h.

                                  {
    m_base.m_hintID = INVALID;
    m_base.m_linkID = INVALID;
    m_target        = const_cast<TYPE*>( pObject );
    _setEnvironment( 0, 0 );
  }

SmartRef() [4/8]

template<class TYPE>

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

inline

Copy Constructor.

Definition at line 114 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() [5/8]

template<class TYPE>

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

inline

Constructor.

Definition at line 121 of file SmartRef.h.

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

SmartRef() [6/8]

template<class TYPE>

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

inline

Constructor for references to contained objects passing environment.

Definition at line 128 of file SmartRef.h.

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

SmartRef() [7/8]

template<class TYPE>

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

inline

Constructor for references to contained objects passing environment.

Definition at line 136 of file SmartRef.h.

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

SmartRef() [8/8]

template<class TYPE>

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

inline

Constructor for references to DataObjects passing environment.

Definition at line 143 of file SmartRef.h.

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

Member Function Documentation

_setEnvironment() [1/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 186 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>

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

inline

Set the environment (CONST)

Definition at line 193 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 167 of file SmartRef.h.

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

data() [2/2]

template<class TYPE>

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

inline

Definition at line 168 of file SmartRef.h.

{ return m_target; }

hintID()

template<class TYPE>

long SmartRef< TYPE >::hintID ( ) const

inline

Access hint id:

Definition at line 159 of file SmartRef.h.

{ return m_base.m_hintID; }

linkID()

template<class TYPE>

long SmartRef< TYPE >::linkID ( ) const

inline

Access link id:

Definition at line 161 of file SmartRef.h.

{ return m_base.m_linkID; }

operator *() [1/2]

template<class TYPE>

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

inline

Dereference operator.

Definition at line 228 of file SmartRef.h.

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

operator *() [2/2]

template<class TYPE>

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

inline

Dereference operator.

Definition at line 230 of file SmartRef.h.

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

operator const TYPE *()

template<class TYPE>

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

inline

Implicit type conversion to const object.

Definition at line 236 of file SmartRef.h.

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

operator TYPE *()

template<class TYPE>

SmartRef< TYPE >::operator TYPE * ( )

inline

Implicit type conversion.

Definition at line 238 of file SmartRef.h.

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

operator!=()

template<class TYPE>

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

inline

NON-Equality operator.

Definition at line 184 of file SmartRef.h.

{ return !( this->operator==( c ) ); }

operator()() [1/4]

template<class TYPE>

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

inline

operator(): assigns parent object for serialisation

Definition at line 200 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 ContainedObject *  pObj ) const

inline

operator() const: assigns parent object for serialisation

Definition at line 205 of file SmartRef.h.

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

operator()() [3/4]

template<class TYPE>

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

inline

operator(): assigns parent object for serialisation

Definition at line 210 of file SmartRef.h.

{ return _setEnvironment( pObj, nullptr ); }

operator()() [4/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 212 of file SmartRef.h.

{ return _setEnvironment( pObj, nullptr ); }

operator->() [1/2]

template<class TYPE>

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

inline

Dereference operator.

Definition at line 232 of file SmartRef.h.

{ 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 234 of file SmartRef.h.

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

operator=() [1/2]

template<class TYPE>

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

inline

Assignment.

Definition at line 214 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= ( TYPE *  pObject )

inline

Assignment.

Definition at line 221 of file SmartRef.h.

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

operator==()

template<class TYPE>

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

inline

Equality operator.

Definition at line 176 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;
  }

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 174 of file SmartRef.h.

{ 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 283 of file SmartRef.h.

                                                              {
  m_target = dynamic_cast<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 163 of file SmartRef.h.

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

shouldFollowLink() [1/2]

template<class TYPE>

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

inline

Standard destructor.

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

Definition at line 153 of file SmartRef.h.

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

shouldFollowLink() [2/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 155 of file SmartRef.h.

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

target() [1/2]

template<class TYPE >

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

inline

Access to the object.

Access to the object (CONST)

Definition at line 269 of file SmartRef.h.

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

target() [2/2]

template<class TYPE >

TYPE * SmartRef< TYPE >::target ( )

inline

Access to the object.

Definition at line 262 of file SmartRef.h.

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

type()

template<class TYPE>

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

inline

Access to embedded type.

Definition at line 165 of file SmartRef.h.

{ 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 276 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 245 of file SmartRef.h.

{ return ptr.writeRef( _s ); }

operator>>

template<class TYPE>

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

friend

Input Streamer operator.

Definition at line 248 of file SmartRef.h.

{ return ptr.readRef( _s ); }

SmartRefArray< TYPE >

template<class TYPE>

friend class SmartRefArray< TYPE >

friend

The container must be a friend.

Definition at line 78 of file SmartRef.h.

SmartRefList< TYPE >

template<class TYPE>

friend class SmartRefList< TYPE >

friend

Definition at line 79 of file SmartRef.h.

SmartRefMap< TYPE >

template<class TYPE>

friend class SmartRefMap< TYPE >

friend

Definition at line 80 of file SmartRef.h.

Member Data Documentation

m_base

template<class TYPE>

SmartRefBase SmartRef< TYPE >::m_base

protected

Definition at line 88 of file SmartRef.h.

m_target

template<class TYPE>

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

mutableprotected

Pointer to target data object.

Definition at line 90 of file SmartRef.h.

---

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

• GaudiKernel/GaudiKernel/SmartRef.h