kanzi::OptionalHandleWrapper< Derived, T > Class Template Reference

Creates a wrapper around an OptionalHandle class. More...

#include <kanzi/core/util/handle.hpp>

Inheritance diagram for kanzi::OptionalHandleWrapper< Derived, T >:

Public Types
using	NativeHandleType
	Alias for the underlying native handle type.

Public Member Functions
const T *	operator-> () const noexcept
	Provides access to T through const pointer.
T *	operator-> () noexcept
	Provides access to T through pointer.
template<typename... Args>
	OptionalHandleWrapper (Args &&... args) noexcept
	Constructor.

Static Public Member Functions
template<typename... Args, typename = enable_if_t<s_hasCreateMethodV<T, tuple<Args...>>>>
static Derived	create (Args &&... args) noexcept
	Creates an optional handle by calling static "create" method provided by T.

Detailed Description

template<typename Derived, typename T>
class kanzi::OptionalHandleWrapper< Derived, T >

Creates a wrapper around an OptionalHandle class.

See also

For examples, see OptionalHandle.

Template Parameters

Derived	Derived class (CRTP pattern).
T	Class derived from OptionalHandle that includes domain-specific methods.

Since

Kanzi 4.0.0

Member Typedef Documentation

NativeHandleType

template<typename Derived , typename T >

using kanzi::OptionalHandleWrapper< Derived, T >::NativeHandleType

Alias for the underlying native handle type.

Constructor & Destructor Documentation

OptionalHandleWrapper()

template<typename Derived , typename T >

template<typename... Args>

kanzi::OptionalHandleWrapper< Derived, T >::OptionalHandleWrapper ( Args &&... args )

inlineexplicitnoexcept

Constructor.

Member Function Documentation

create()

template<typename Derived , typename T >

template<typename... Args, typename = enable_if_t<s_hasCreateMethodV<T, tuple<Args...>>>>

static Derived kanzi::OptionalHandleWrapper< Derived, T >::create ( Args &&... args )

inlinestaticnoexcept

Creates an optional handle by calling static "create" method provided by T.

Only available if T provides "create" method.

Template Parameters

Args	Argument types.

Parameters

args	Arguments to pass for handle creation.

Returns

OptionalHandleWrapper based on provided T class.

operator->() [1/2]

template<typename Derived , typename T >

T * kanzi::OptionalHandleWrapper< Derived, T >::operator-> ( )

inlinenoexcept

Provides access to T through pointer.

operator->() [2/2]

template<typename Derived , typename T >

const T * kanzi::OptionalHandleWrapper< Derived, T >::operator-> ( ) const

inlinenoexcept

Provides access to T through const pointer.

---

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

• kanzi/core/util/handle.hpp