thepeg is hosted by Hepforge, IPPP Durham
ThePEG 2.3.0
ThePEG::Pointer::TransientConstRCPtr< T > Class Template Reference

TransientConstRCPtr is a simple wrapper around a bare const pointer which can be assigned to and from an RCPtr and ConstRCPtr without problem. More...

#include <RCPtr.h>

Public Types

typedef void iterator_category
 Template argument typedef.
 
typedef void difference_type
 Template argument typedef.
 
typedef T * pointer
 Template argument typedef.
 
typedef const T * const_pointer
 Template argument typedef.
 
typedef T & reference
 Template argument typedef.
 
typedef const T & const_reference
 Template argument typedef.
 
typedef T value_type
 Template argument typedef.
 

Public Member Functions

 TransientConstRCPtr ()
 Constructor for null pointer.
 
 TransientConstRCPtr (decltype(nullptr))
 Constructor for nullptr.
 
 TransientConstRCPtr (const TransientConstRCPtr &p)
 Copy constructor.
 
template<typename UPtr >
 TransientConstRCPtr (const UPtr &u)
 Copyconstructor for class UPtr which has operator-> defined resulting in a value implicitly convertible to const T *.
 
 TransientConstRCPtr (const_pointer p)
 Construction from real pointer.
 
 ~TransientConstRCPtr ()
 Destructor.
 
TransientConstRCPtroperator= (const TransientConstRCPtr &p)
 Assignment.
 
template<typename UPtr >
TransientConstRCPtroperator= (const UPtr &u)
 Assignment from class UPtr which has operator-> defined resulting in a value implicitly convertible to const T *.
 
template<typename UPtr >
TransientConstRCPtrassignDynamic (const UPtr &u)
 Assignment from class UPtr which has operator-> defined resulting in a value which can be cast dynamically to const T *.
 
bool operator== (const TransientConstRCPtr &p) const
 Test for equality of the underlying pointers.
 
bool operator!= (const TransientConstRCPtr &p) const
 Test for inequality of the underlying pointers.
 
bool operator== (const_pointer p) const
 Test for equality of the underlying pointers.
 
bool operator!= (const_pointer p) const
 Test for inequality of the underlying pointers.
 
template<typename UPtr >
bool operator== (const UPtr &u) const
 Test for equality of the underlying pointers.
 
template<typename UPtr >
bool operator!= (const UPtr &u) const
 Test for inequality of the underlying pointers.
 
bool operator< (const TransientConstRCPtr &p) const
 Test for ordering.
 
bool operator< (const_pointer p) const
 Test for ordering.
 
bool operator! () const
 Returns true if the underlying pointer is null.
 
 operator const T * () const
 Returns (not) the underlying pointer.
 
const_pointer operator-> () const
 Member access.
 
const_reference operator* () const
 Dereferencing.
 

Private Attributes

const_pointer ptr
 The actual pointer.
 

Detailed Description

template<typename T>
class ThePEG::Pointer::TransientConstRCPtr< T >

TransientConstRCPtr is a simple wrapper around a bare const pointer which can be assigned to and from an RCPtr and ConstRCPtr without problem.

See also
RCPtr
ConstRCPtr

Definition at line 696 of file RCPtr.h.

Member Typedef Documentation

◆ const_pointer

template<typename T >
typedef const T* ThePEG::Pointer::TransientConstRCPtr< T >::const_pointer

Template argument typedef.

Definition at line 707 of file RCPtr.h.

◆ const_reference

template<typename T >
typedef const T& ThePEG::Pointer::TransientConstRCPtr< T >::const_reference

Template argument typedef.

Definition at line 711 of file RCPtr.h.

◆ difference_type

template<typename T >
typedef void ThePEG::Pointer::TransientConstRCPtr< T >::difference_type

Template argument typedef.

Definition at line 703 of file RCPtr.h.

◆ iterator_category

template<typename T >
typedef void ThePEG::Pointer::TransientConstRCPtr< T >::iterator_category

Template argument typedef.

Definition at line 701 of file RCPtr.h.

◆ pointer

template<typename T >
typedef T* ThePEG::Pointer::TransientConstRCPtr< T >::pointer

Template argument typedef.

Definition at line 705 of file RCPtr.h.

◆ reference

template<typename T >
typedef T& ThePEG::Pointer::TransientConstRCPtr< T >::reference

Template argument typedef.

Definition at line 709 of file RCPtr.h.

◆ value_type

template<typename T >
typedef T ThePEG::Pointer::TransientConstRCPtr< T >::value_type

Template argument typedef.

Definition at line 713 of file RCPtr.h.

Constructor & Destructor Documentation

◆ TransientConstRCPtr() [1/5]

template<typename T >
ThePEG::Pointer::TransientConstRCPtr< T >::TransientConstRCPtr ( )
inline

Constructor for null pointer.

Definition at line 720 of file RCPtr.h.

◆ TransientConstRCPtr() [2/5]

template<typename T >
ThePEG::Pointer::TransientConstRCPtr< T >::TransientConstRCPtr ( decltype(nullptr)  )
inline

Constructor for nullptr.

Definition at line 725 of file RCPtr.h.

◆ TransientConstRCPtr() [3/5]

template<typename T >
ThePEG::Pointer::TransientConstRCPtr< T >::TransientConstRCPtr ( const TransientConstRCPtr< T > &  p)
inline

Copy constructor.

Definition at line 730 of file RCPtr.h.

◆ TransientConstRCPtr() [4/5]

template<typename T >
template<typename UPtr >
ThePEG::Pointer::TransientConstRCPtr< T >::TransientConstRCPtr ( const UPtr &  u)
inline

Copyconstructor for class UPtr which has operator-> defined resulting in a value implicitly convertible to const T *.

Definition at line 737 of file RCPtr.h.

◆ TransientConstRCPtr() [5/5]

template<typename T >
ThePEG::Pointer::TransientConstRCPtr< T >::TransientConstRCPtr ( const_pointer  p)
inlineexplicit

Construction from real pointer.

Definition at line 742 of file RCPtr.h.

◆ ~TransientConstRCPtr()

template<typename T >
ThePEG::Pointer::TransientConstRCPtr< T >::~TransientConstRCPtr ( )
inline

Destructor.

Does not delete the object pointed to.

Definition at line 747 of file RCPtr.h.

Member Function Documentation

◆ assignDynamic()

template<typename T >
template<typename UPtr >
TransientConstRCPtr & ThePEG::Pointer::TransientConstRCPtr< T >::assignDynamic ( const UPtr &  u)
inline

Assignment from class UPtr which has operator-> defined resulting in a value which can be cast dynamically to const T *.

Definition at line 772 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator const T *()

template<typename T >
ThePEG::Pointer::TransientConstRCPtr< T >::operator const T * ( ) const
inline

Returns (not) the underlying pointer.

Definition at line 834 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator!()

template<typename T >
bool ThePEG::Pointer::TransientConstRCPtr< T >::operator! ( ) const
inline

Returns true if the underlying pointer is null.

Definition at line 829 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator!=() [1/3]

template<typename T >
bool ThePEG::Pointer::TransientConstRCPtr< T >::operator!= ( const TransientConstRCPtr< T > &  p) const
inline

Test for inequality of the underlying pointers.

Definition at line 785 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator!=() [2/3]

template<typename T >
template<typename UPtr >
bool ThePEG::Pointer::TransientConstRCPtr< T >::operator!= ( const UPtr &  u) const
inline

Test for inequality of the underlying pointers.

Definition at line 808 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator!=() [3/3]

template<typename T >
bool ThePEG::Pointer::TransientConstRCPtr< T >::operator!= ( const_pointer  p) const
inline

Test for inequality of the underlying pointers.

Definition at line 796 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator*()

template<typename T >
const_reference ThePEG::Pointer::TransientConstRCPtr< T >::operator* ( ) const
inline

Dereferencing.

Definition at line 844 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator->()

template<typename T >
const_pointer ThePEG::Pointer::TransientConstRCPtr< T >::operator-> ( ) const
inline

Member access.

Definition at line 839 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator<() [1/2]

template<typename T >
bool ThePEG::Pointer::TransientConstRCPtr< T >::operator< ( const TransientConstRCPtr< T > &  p) const
inline

Test for ordering.

Definition at line 813 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator<() [2/2]

template<typename T >
bool ThePEG::Pointer::TransientConstRCPtr< T >::operator< ( const_pointer  p) const
inline

Test for ordering.

Definition at line 821 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator=() [1/2]

template<typename T >
TransientConstRCPtr & ThePEG::Pointer::TransientConstRCPtr< T >::operator= ( const TransientConstRCPtr< T > &  p)
inline

Assignment.

Definition at line 752 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator=() [2/2]

template<typename T >
template<typename UPtr >
TransientConstRCPtr & ThePEG::Pointer::TransientConstRCPtr< T >::operator= ( const UPtr &  u)
inline

Assignment from class UPtr which has operator-> defined resulting in a value implicitly convertible to const T *.

Definition at line 762 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator==() [1/3]

template<typename T >
bool ThePEG::Pointer::TransientConstRCPtr< T >::operator== ( const TransientConstRCPtr< T > &  p) const
inline

Test for equality of the underlying pointers.

Definition at line 780 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator==() [2/3]

template<typename T >
template<typename UPtr >
bool ThePEG::Pointer::TransientConstRCPtr< T >::operator== ( const UPtr &  u) const
inline

Test for equality of the underlying pointers.

Definition at line 802 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

◆ operator==() [3/3]

template<typename T >
bool ThePEG::Pointer::TransientConstRCPtr< T >::operator== ( const_pointer  p) const
inline

Test for equality of the underlying pointers.

Definition at line 790 of file RCPtr.h.

References ThePEG::Pointer::TransientConstRCPtr< T >::ptr.

Member Data Documentation

◆ ptr


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