| The Gaudi Framework v28r2-patches (bc4ad17a)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Private Attributes | List of all members
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 >:
[legend]

## 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...
SmartIF & | operator= (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...
SmartIF & | operator= (IInterface *ptr)
| Assignment operator from IInterface pointer. More...
SmartIF & | operator= (const SmartIF &rhs)
| Assignment operator. More...
template<class T >
SmartIF & | operator= (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 14 of file IConverter.h.

## Constructor & Destructor Documentation

template<class TYPE>

SmartIF< TYPE >::SmartIF | ( |  | ) |
| inline default

Default constructor.

template<class TYPE>

SmartIF< TYPE >::SmartIF | ( | TYPE * | ptr | ) |
| inline

Standard constructor from pointer.

Definition at line 27 of file SmartIF.h.

27 : m_interface(ptr) {
28 if (m_interface) m_interface->addRef();
29 }
SmartIF::m_interface
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:21
template<class TYPE>
template<class OTHER >

SmartIF< TYPE >::SmartIF | ( | OTHER * | ptr | ) |
| inline

Standard constructor from any (IInterface-derived) pointer.

Definition at line 32 of file SmartIF.h.

32 {
33 if (ptr) reset(ptr);
34 }
SmartIF::reset
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:88
template<class TYPE>

SmartIF< TYPE >::SmartIF | ( | const SmartIF< TYPE > & | rhs | ) |
| inline

Copy constructor.

Definition at line 36 of file SmartIF.h.

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

SmartIF< TYPE >::SmartIF | ( | SmartIF< TYPE > && | rhs | ) |
| inline

Move constructor.

Definition at line 40 of file SmartIF.h.

40 : m_interface( rhs.m_interface ){
41 rhs.m_interface = nullptr;
42 }
SmartIF::m_interface
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:21
template<class TYPE>
template<class T >

SmartIF< TYPE >::SmartIF | ( | const SmartIF< T > & | rhs | ) |
| inline explicit

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 }
SmartIF::get
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:76
SmartIF::reset
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:88
template<class TYPE>

SmartIF< TYPE >::~SmartIF | ( |  | ) |
| inline

Standard Destructor.

Definition at line 58 of file SmartIF.h.

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

## 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 110 of file SmartIF.h.

110 {
111 return SmartIF<IFace>{ *this };
112 }
SmartIF
Small smart pointer class with automatic reference counting for IInterface.
Definition: IConverter.h:14
template<class TYPE>

TYPE* SmartIF< TYPE >::get | ( |  | ) | const
| inline

Get interface pointer.

Definition at line 76 of file SmartIF.h.

76 { return m_interface; }
SmartIF::m_interface
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:21
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; }
SmartIF::m_interface
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:21
template<class TYPE>

SmartIF< TYPE >::operator bool | ( |  | ) | const
| inline explicit

Definition at line 64 of file SmartIF.h.

64 { return isValid(); }
SmartIF::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; }
SmartIF::m_interface
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:21
template<class TYPE>

bool SmartIF< TYPE >::operator! | ( |  | ) | const
| inline

Definition at line 65 of file SmartIF.h.

65 { return !isValid(); }
SmartIF::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; }
SmartIF::m_interface
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:21
template<class TYPE>

TYPE* SmartIF< TYPE >::operator-> | ( |  | ) | const
| inline

Dereference operator.

Definition at line 72 of file SmartIF.h.

72 { return m_interface; }
SmartIF::m_interface
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:21
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();
46 m_interface = rhs.m_interface;
47 rhs.m_interface = nullptr;
48 return *this;
49 }
SmartIF::m_interface
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:21
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 121 of file SmartIF.h.

121 {
122 reset(ptr);
123 return *this;
124 }
SmartIF::reset
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:88
template<class TYPE>

SmartIF& SmartIF< TYPE >::operator= | ( | const SmartIF< TYPE > & | rhs | ) |
| inline

Assignment operator.

Definition at line 126 of file SmartIF.h.

126 {
127 reset(rhs.get());
128 return *this;
129 }
SmartIF::get
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:76
SmartIF::reset
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:88
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 133 of file SmartIF.h.

133 {
134 reset(rhs.get());
135 return *this;
136 }
SmartIF::get
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:76
SmartIF::reset
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:88
template<class TYPE>

TYPE*& SmartIF< TYPE >::pRef | ( |  | ) |
| inline

Get reference to the pointer.

Definition at line 79 of file SmartIF.h.

79 {
80 return m_interface;
81 }
SmartIF::m_interface
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:21
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 88 of file SmartIF.h.

88 {
89 if (ptr == m_interface) return;
90 if (m_interface) m_interface->release();
91 m_interface = ptr;
92 if (m_interface) m_interface->addRef();
93 }
SmartIF::m_interface
TYPE * m_interface
Pointer to the instance.
Definition: SmartIF.h:21
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 97 of file SmartIF.h.

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

## Member Data Documentation

template<class TYPE>

TYPE* SmartIF< TYPE >::m_interface = nullptr
| private

Pointer to the instance.

Definition at line 21 of file SmartIF.h.

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

- GaudiKernel/GaudiKernel/IConverter.h
- GaudiKernel/GaudiKernel/SmartIF.h