Arp::PimplPtr< T, Copyable > Class Template Reference

Small wrapper class to ensure const correctness using PImpl pattern. More...

#include <PimplPtr.hxx>

Public Types
using	Impl = T
using	ImplPtr = std::unique_ptr< Impl >

Public Member Functions
template<class ... Args>
ARP_CXX_SYMBOL_EXPORT	PimplPtr (Args &&... args)
	Constructs an PImpl instance using the supplied arguments.
	PimplPtr (const PimplPtr &arg)=delete
	Copy constructor.
ARP_CXX_SYMBOL_EXPORT	PimplPtr (PimplPtr &&arg) noexcept
	Move constructor. More...
PimplPtr &	operator= (const PimplPtr &arg)=delete
	Assignment operator.
ARP_CXX_SYMBOL_EXPORT PimplPtr &	operator= (PimplPtr &&arg) noexcept
	Assignment move operator. More...
ARP_CXX_SYMBOL_EXPORT	~PimplPtr (void)
	Destructs this instance and frees all resources. More...
ARP_CXX_SYMBOL_EXPORT Impl *	operator-> (void)
	Gets the pointer to the Impl instance for none const objects. More...
ARP_CXX_SYMBOL_EXPORT const Impl *	operator-> (void) const
	Gets the pointer to the const Impl instance for const objects.
ARP_CXX_SYMBOL_EXPORT Impl &	operator* (void)
	Gets the reference to the Impl instance for none const objects. More...
ARP_CXX_SYMBOL_EXPORT const Impl &	operator* (void) const
	Gets the reference to the const Impl instance for const objects.
ARP_CXX_SYMBOL_EXPORT	operator bool (void) const noexcept
	Checks if the pointer points to a valid object
template<class ... Args>
	PimplPtr (Args &&...args)
	Variadic constructor.

Detailed Description

template<class T, bool Copyable = false>
class Arp::PimplPtr< T, Copyable >

Small wrapper class to ensure const correctness using PImpl pattern.

Constructor & Destructor Documentation

PimplPtr()

template<class T , bool Copyable>

Arp::PimplPtr< T, Copyable >::PimplPtr ( PimplPtr< T, Copyable > &&  arg )

inlinedefaultnoexcept

Move constructor.

Default move constructor.

~PimplPtr()

template<class T , bool Copyable>

Arp::PimplPtr< T, Copyable >::~PimplPtr ( void  )

inlinedefault

Destructs this instance and frees all resources.

Default destructor.

Member Function Documentation

operator*()

template<class T , bool Copyable>

const T & Arp::PimplPtr< T, Copyable >::operator* ( void  )

inline

Gets the reference to the Impl instance for none const objects.

Indirect operator to access pointee.

operator->()

template<class T , bool Copyable>

const T * Arp::PimplPtr< T, Copyable >::operator-> ( void  )

inline

Gets the pointer to the Impl instance for none const objects.

Arrow operator to access pointee.

operator=()

template<class T , bool Copyable>

PimplPtr< T, Copyable > & Arp::PimplPtr< T, Copyable >::operator= ( PimplPtr< T, Copyable > &&  arg )

inlinedefaultnoexcept

Assignment move operator.

Default assignment move operator.

---

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

• Arp/System/Core/PimplPtr.hxx
• Arp/System/Core/PimplPtr.inl