Loading [MathJax]/extensions/tex2jax.js
The Gaudi Framework  v31r0 (aeb156f0)
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
SmartIF< TYPE > Class Template Reference

Small smart pointer class with automatic reference counting for IInterface. More...

#include <GaudiKernel/SmartIF.h>

Collaboration diagram for SmartIF< TYPE >:

Public Member Functions

 SmartIF ()=default
 Default constructor. More...
 
 SmartIF (TYPE *ptr)
 Standard constructor from pointer. More...
 
template<class OTHER >
 SmartIF (OTHER *ptr)
 Standard constructor from any (IInterface-derived) pointer. More...
 
 SmartIF (const SmartIF &rhs)
 Copy constructor. More...
 
 SmartIF (SmartIF &&rhs)
 Move constructor. More...
 
SmartIFoperator= (SmartIF &&rhs)
 Move assignement. More...
 
template<class T >
 SmartIF (const SmartIF< T > &rhs)
 Constructor from another SmartIF, with a different type. More...
 
 ~SmartIF ()
 Standard Destructor. More...
 
bool isValid () const
 Allow for check if smart pointer is valid. More...
 
 operator bool () const
 
bool operator! () const
 
 operator TYPE * () const
 Automatic conversion to pointer. More...
 
TYPE * operator-> () const
 Dereference operator. More...
 
TYPE & operator* () const
 Dereference operator. More...
 
TYPE * get () const
 Get interface pointer. More...
 
TYPE *& pRef ()
 Get reference to the pointer. More...
 
void reset (TYPE *ptr=nullptr)
 Set the internal pointer to the passed one disposing of the old one. More...
 
template<class OTHER >
void reset (OTHER *ptr)
 Set the internal pointer to the passed one disposing of the old one. More...
 
template<typename IFace >
SmartIF< IFace > as () const
 return a new SmartIF instance to another interface More...
 
SmartIFoperator= (IInterface *ptr)
 Assignment operator from IInterface pointer. More...
 
SmartIFoperator= (const SmartIF &rhs)
 Assignment operator. More...
 
template<class T >
SmartIFoperator= (const SmartIF< T > &rhs)
 Assignment operator from a different SmartIF. More...
 

Private Attributes

TYPE * m_interface = nullptr
 Pointer to the instance. More...
 

Detailed Description

template<class TYPE>
class SmartIF< TYPE >

Small smart pointer class with automatic reference counting for IInterface.

SmartIF simplifies the interaction with components in Gaudi by implementing an automatic reference counting and the casting (via IInterface::queryInterface).

Author
Markus Frank
Sebastien Ponce
Marco Clemencic

Definition at line 15 of file IConverter.h.

Constructor & Destructor Documentation

template<class TYPE>
SmartIF< TYPE >::SmartIF ( )
inlinedefault

Default constructor.

template<class TYPE>
SmartIF< TYPE >::SmartIF ( TYPE *  ptr)
inline

Standard constructor from pointer.

Definition at line 29 of file SmartIF.h.

29  : m_interface( ptr ) {
30  if ( m_interface ) m_interface->addRef();
31  }
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22
template<class TYPE>
template<class OTHER >
SmartIF< TYPE >::SmartIF ( OTHER *  ptr)
inline

Standard constructor from any (IInterface-derived) pointer.

Definition at line 34 of file SmartIF.h.

34  {
35  if ( ptr ) reset( ptr );
36  }
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:86
template<class TYPE>
SmartIF< TYPE >::SmartIF ( const SmartIF< TYPE > &  rhs)
inline

Copy constructor.

Definition at line 38 of file SmartIF.h.

38  : m_interface( rhs.get() ) {
39  if ( m_interface ) m_interface->addRef();
40  }
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:76
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22
template<class TYPE>
SmartIF< TYPE >::SmartIF ( SmartIF< TYPE > &&  rhs)
inline

Move constructor.

Definition at line 42 of file SmartIF.h.

42 : m_interface( rhs.m_interface ) { rhs.m_interface = nullptr; }
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22
template<class TYPE>
template<class T >
SmartIF< TYPE >::SmartIF ( const SmartIF< T > &  rhs)
inlineexplicit

Constructor from another SmartIF, with a different type.

Note
it cannot replace the copy constructor.

Definition at line 54 of file SmartIF.h.

54  {
55  reset( rhs.get() );
56  }
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:76
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:86
template<class TYPE>
SmartIF< TYPE >::~SmartIF ( )
inline

Standard Destructor.

Definition at line 58 of file SmartIF.h.

58 { reset(); }
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:86

Member Function Documentation

template<class TYPE>
template<typename IFace >
SmartIF<IFace> SmartIF< TYPE >::as ( ) const
inline

return a new SmartIF instance to another interface

Definition at line 107 of file SmartIF.h.

107  {
108  return SmartIF<IFace>{*this};
109  }
Small smart pointer class with automatic reference counting for IInterface.
Definition: IConverter.h:15
template<class TYPE>
TYPE* SmartIF< TYPE >::get ( ) const
inline

Get interface pointer.

Definition at line 76 of file SmartIF.h.

76 { return m_interface; }
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22
template<class TYPE>
bool SmartIF< TYPE >::isValid ( ) const
inline

Allow for check if smart pointer is valid.

Definition at line 62 of file SmartIF.h.

62 { return m_interface != nullptr; }
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22
template<class TYPE>
SmartIF< TYPE >::operator bool ( ) const
inlineexplicit

Definition at line 64 of file SmartIF.h.

64 { return isValid(); }
bool isValid() const
Allow for check if smart pointer is valid.
Definition: SmartIF.h:62
template<class TYPE>
SmartIF< TYPE >::operator TYPE * ( ) const
inline

Automatic conversion to pointer.

It is also used by the compiler for automatic conversion to boolean.

Definition at line 70 of file SmartIF.h.

70 { return m_interface; }
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22
template<class TYPE>
bool SmartIF< TYPE >::operator! ( ) const
inline

Definition at line 65 of file SmartIF.h.

65 { return !isValid(); }
bool isValid() const
Allow for check if smart pointer is valid.
Definition: SmartIF.h:62
template<class TYPE>
TYPE& SmartIF< TYPE >::operator* ( ) const
inline

Dereference operator.

Definition at line 74 of file SmartIF.h.

74 { return *m_interface; }
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22
template<class TYPE>
TYPE* SmartIF< TYPE >::operator-> ( ) const
inline

Dereference operator.

Definition at line 72 of file SmartIF.h.

72 { return m_interface; }
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22
template<class TYPE>
SmartIF& SmartIF< TYPE >::operator= ( SmartIF< TYPE > &&  rhs)
inline

Move assignement.

Definition at line 44 of file SmartIF.h.

44  {
45  if ( m_interface ) m_interface->release();
47  rhs.m_interface = nullptr;
48  return *this;
49  }
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22
template<class TYPE>
SmartIF& SmartIF< TYPE >::operator= ( IInterface ptr)
inline

Assignment operator from IInterface pointer.

It allows things like SmartIF<T> x; x = 0;

Definition at line 118 of file SmartIF.h.

118  {
119  reset( ptr );
120  return *this;
121  }
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:86
template<class TYPE>
SmartIF& SmartIF< TYPE >::operator= ( const SmartIF< TYPE > &  rhs)
inline

Assignment operator.

Definition at line 123 of file SmartIF.h.

123  {
124  reset( rhs.get() );
125  return *this;
126  }
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:76
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:86
template<class TYPE>
template<class T >
SmartIF& SmartIF< TYPE >::operator= ( const SmartIF< T > &  rhs)
inline

Assignment operator from a different SmartIF.

Note
it cannot replace the assignment operator.

Definition at line 130 of file SmartIF.h.

130  {
131  reset( rhs.get() );
132  return *this;
133  }
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:76
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:86
template<class TYPE>
TYPE*& SmartIF< TYPE >::pRef ( )
inline

Get reference to the pointer.

Definition at line 79 of file SmartIF.h.

79 { return m_interface; }
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22
template<class TYPE>
void SmartIF< TYPE >::reset ( TYPE *  ptr = nullptr)
inline

Set the internal pointer to the passed one disposing of the old one.

Version for pointers of the same type of the managed ones (no call to queryInterface needed).

Definition at line 86 of file SmartIF.h.

86  {
87  if ( ptr == m_interface ) return;
88  if ( m_interface ) m_interface->release();
89  m_interface = ptr;
90  if ( m_interface ) m_interface->addRef();
91  }
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22
template<class TYPE>
template<class OTHER >
void SmartIF< TYPE >::reset ( OTHER *  ptr)
inline

Set the internal pointer to the passed one disposing of the old one.

Version for pointers of types inheriting from IInterface.

Definition at line 95 of file SmartIF.h.

95  {
96  if ( static_cast<IInterface*>( ptr ) == static_cast<IInterface*>( m_interface ) ) return;
97  if ( m_interface ) m_interface->release();
98  if ( ptr ) {
99  ptr->queryInterface( TYPE::interfaceID(), pp_cast<void>( &m_interface ) ).ignore();
100  } else {
101  m_interface = nullptr;
102  }
103  }
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:22

Member Data Documentation

template<class TYPE>
TYPE* SmartIF< TYPE >::m_interface = nullptr
private

Pointer to the instance.

Definition at line 22 of file SmartIF.h.


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