implements< Interfaces > Struct Template Reference

Base class used to implement the interfaces. More...

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

Inheritance diagram for implements< Interfaces >:

Collaboration diagram for implements< Interfaces >:

Public Types
using	base_class = implements< Interfaces... >
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
using	iids = typename extend_interfaces_base::ext_iids
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...

Public Member Functions
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	implements ()=default
	Default constructor. More...
	implements (const implements &)
	Copy constructor (zero the reference count) More...
implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...
unsigned long	addRef () const override
	Reference Interface instance More...
unsigned long	release () const override
	Release Interface instance More...
unsigned long	refCount () const override
	Current reference count More...

Protected Member Functions
unsigned long	decRef () const override

Protected Attributes
std::atomic_ulong	m_refCount = { 0 }
	Reference counter More...

Detailed Description

template<typename... Interfaces>
struct implements< Interfaces >

Base class used to implement the interfaces.

Definition at line 20 of file implements.h.

Member Typedef Documentation

base_class

template<typename... Interfaces>

using implements< Interfaces >::base_class = implements<Interfaces...>

Typedef to this class.

Definition at line 22 of file implements.h.

extend_interfaces_base

template<typename... Interfaces>

using implements< Interfaces >::extend_interfaces_base = extend_interfaces<Interfaces...>

Typedef to the base of this class.

Definition at line 24 of file implements.h.

iids

template<typename... Interfaces>

using implements< Interfaces >::iids = typename extend_interfaces_base::ext_iids

Definition at line 25 of file implements.h.

Constructor & Destructor Documentation

implements() [1/2]

template<typename... Interfaces>

implements< Interfaces >::implements ( )

default

Default constructor.

implements() [2/2]

template<typename... Interfaces>

implements< Interfaces >::implements ( const implements< Interfaces > &  )

inline

Copy constructor (zero the reference count)

Definition at line 43 of file implements.h.

: m_refCount{ 0 } {}

Member Function Documentation

addRef()

template<typename... Interfaces>

unsigned long implements< Interfaces >::addRef ( ) const

inlineoverride

Reference Interface instance

Definition at line 49 of file implements.h.

{ return ++m_refCount; }

decRef()

template<typename... Interfaces>

unsigned long implements< Interfaces >::decRef ( ) const

inlineoverrideprotected

Definition at line 63 of file implements.h.

                                        {
    auto count = m_refCount.load();
    // thread-safe decrement, but make sure we don't go below 0
    // (if the last two references are being released at the same time, this guarantees that
    // one decrements m_refCount from 2 to 1 and the other from 1 to 0)
    while ( count > 0 && !m_refCount.compare_exchange_weak( count, count - 1 ) ) { assert( count > 0 ); }
    // when we reach this point, we managed to set m_refCount to "count - 1", so no need to read it again
    return count - 1;
  }

getInterfaceNames()

template<typename... Interfaces>

std::vector<std::string> implements< Interfaces >::getInterfaceNames ( ) const

inlineoverride

Implementation of IInterface::getInterfaceNames.

Definition at line 39 of file implements.h.

{ return Gaudi::getInterfaceNames( iids{} ); }

i_cast()

template<typename... Interfaces>

void const* implements< Interfaces >::i_cast ( const InterfaceID &  tid ) const

inlineoverride

Implementation of IInterface::i_cast.

Definition at line 29 of file implements.h.

{ return Gaudi::iid_cast( tid, iids{}, this ); }

operator=()

template<typename... Interfaces>

implements& implements< Interfaces >::operator= ( const implements< Interfaces > &  )

inline

Assignment operator (do not touch the reference count).

Definition at line 45 of file implements.h.

{ return *this; } // cppcheck-suppress operatorEqVarError

queryInterface()

template<typename... Interfaces>

StatusCode implements< Interfaces >::queryInterface ( const InterfaceID &  ti, void **  pp  )

inlineoverride

Implementation of IInterface::queryInterface.

Definition at line 31 of file implements.h.

                                                                         {
    if ( !pp ) return StatusCode::FAILURE;
    *pp = Gaudi::iid_cast( ti, iids{}, this );
    if ( !*pp ) return StatusCode::FAILURE; /* cast failed */
    this->addRef();
    return StatusCode::SUCCESS;
  }

refCount()

template<typename... Interfaces>

unsigned long implements< Interfaces >::refCount ( ) const

inlineoverride

Current reference count

Definition at line 60 of file implements.h.

{ return m_refCount.load(); }

release()

template<typename... Interfaces>

unsigned long implements< Interfaces >::release ( ) const

inlineoverride

Release Interface instance

Definition at line 51 of file implements.h.

                                         {
    if ( auto count = decRef() ) {
      return count;
    } else {
      delete this;
      return 0;
    }
  }

Member Data Documentation

m_refCount

template<typename... Interfaces>

std::atomic_ulong implements< Interfaces >::m_refCount = { 0 }

mutableprotected

Reference counter

Definition at line 74 of file implements.h.

---

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

• GaudiKernel/include/GaudiKernel/implements.h