System::Collections::Generic::ListPtr< T > Class Template Reference

Inherits System::SmartPtr< T >.

Public Member Functions

 ListPtr ()
 Initializes null-pointer. More...
 
 ListPtr (const SharedPtr< List< T > > &obj)
 
std::vector< T >::reference operator[] (int idx)
 
std::vector< T >::const_reference operator[] (int idx) const
 
- Public Member Functions inherited from System::SmartPtr< T >
 SmartPtr (SmartPtrMode mode)
 Creates SmartPtr object of required mode. More...
 
 SmartPtr (std::nullptr_t=nullptr, SmartPtrMode mode=SmartPtrMode::Shared)
 Creates null-pointer SmartPtr object of required mode. More...
 
 SmartPtr (Pointee_ *object, SmartPtrMode mode=SmartPtrMode::Shared)
 Creates SmartPtr pointing to specified object, or converts raw pointer to SmartPtr. More...
 
 SmartPtr (const SmartPtr_ &ptr, SmartPtrMode mode=SmartPtrMode::Shared)
 Copy constructs SmartPtr object. Both pointers point to the same object afterwards. More...
 
template<class Q , typename = typename std::enable_if<std::is_convertible<Q*, Pointee_*>::value>::type>
 SmartPtr (const SmartPtr< Q > &x, SmartPtrMode mode=SmartPtrMode::Shared)
 Copy constructs SmartPtr object. Both pointers point to the same object afterwards. Performs type conversion if allowed. More...
 
 SmartPtr (SmartPtr_ &&x, SmartPtrMode mode=SmartPtrMode::Shared) noexcept
 Move constructs SmartPtr object. Effectively, swaps two pointers, if they are both of same mode. x may be unusable after call. More...
 
template<typename Y >
 SmartPtr (const SmartPtr< Array< Y >> &src, SmartPtrMode mode=SmartPtrMode::Shared)
 Converts type of referenced array by creating a new array of different type. Useful if in C# there is an array type cast which is unsupported in C++. More...
 
template<typename Y , typename = typename std::enable_if<std::is_same<Y, EmptyArrayInitializer>::value, void>::type>
 SmartPtr (const Y &)
 Initializes empty array. Used to port some C# code constructs. More...
 
template<typename P >
 SmartPtr (const SmartPtr< P > &ptr, Pointee_ *p, SmartPtrMode mode=SmartPtrMode::Shared)
 Constructs a SmartPtr which shares ownership information with the initial value of ptr, but holds an unrelated and unmanaged pointer p. More...
 
 ~SmartPtr ()
 Destroys SmartPtr object. If required, decreases pointed object's reference counter and deletes object. More...
 
SmartPtr_operator= (SmartPtr_ &&x) noexcept
 Move-assigns SmartPtr object. x becomes unusable. More...
 
SmartPtr_operator= (const SmartPtr_ &x)
 Copy-assigns SmartPtr object. More...
 
template<typename Q >
SmartPtr_operator= (const SmartPtr< Q > &x)
 Copy-assigns SmartPtr object. Does required type conversions. More...
 
SmartPtr_operator= (Pointee_ *p)
 Assigns raw pointer to SmartPtr object. More...
 
SmartPtr_operator= (std::nullptr_t)
 Sets pointer value to nullptr. More...
 
Pointee_operator-> () const
 Allows to access members of referenced object. More...
 
bool operator== (std::nullptr_t) const
 Checks if pointer points to nullptr. More...
 
Pointee_get () const
 Gets pointed object. More...
 
Pointee_get_shared () const
 Gets pointed object, but asserts that pointer is in shared mode. More...
 
void reset (Pointee_ *ptr)
 Sets pointed object. More...
 
void reset ()
 Makes pointer pointing to nullptr. More...
 
SmartPtrMode get_Mode () const
 Gets pointer mode. More...
 
bool IsShared () const
 Checks if pointer is in shared mode. More...
 
bool IsWeak () const
 Checks if pointer is in weak mode. More...
 
void set_Mode (SmartPtrMode mode)
 Sets pointer mode. May alter referenced object's reference counts. More...
 
Pointee_operator* () const
 Gets reference to pointed object. Asserts that pointer is not null. More...
 
 operator bool () const noexcept
 Checks if pointer is not null. More...
 
bool operator! () const noexcept
 Checks if pointer is null. More...
 
template<class Y >
bool operator< (Y *p) const
 Provides less-compare semantics for SmartPtr class. More...
 
template<class Y >
bool operator< (SmartPtr< Y > const &x) const
 Provides less-compare semantics for SmartPtr class. More...
 
template<class Y >
SmartPtr< Y > static_pointer_cast () const
 Casts pointer to different type using static_cast on pointed object. More...
 
template<class Y >
SmartPtr< Y > dynamic_pointer_cast () const
 Casts pointer to different type using dynamic_cast on pointed object. More...
 
template<class Y >
SmartPtr< Y > const_pointer_cast () const
 Casts pointer to different type using const_cast on pointed object. More...
 
bool Is (const System::TypeInfo &target) const
 Checks if pointed object is of specific type or its child type. Follows C# 'is' semantics. More...
 
ObjectGetObjectOrNull () const
 Gets pointed object (if any) or nullptr. Same as get(). More...
 
SmartPtr< ObjectToObjectPtr () const
 Converts any pointer type to pointer to Object. Doesn't require Pointee_ type to be complete. More...
 
Pointee_GetPointer () const
 Gets pointed object (if any) or nullptr. Same as get(). More...
 
int get_shared_count () const
 Gets number of shared pointers existing to referenced object, including current one. Asserts current pointer being in shared mode. More...
 
void SetContainedTemplateWeakPtr (unsigned int argument) const
 Calls SetTemplateWeakPtr() method on pointed object (if any). More...
 
template<typename Q = T>
auto begin () noexcept -> decltype(std::declval< Q >().begin())
 Accessor for begin() method of an underling collection. Only compiles if SmartPtr_ is specialization type with begin() method. More...
 
template<typename Q = T>
auto end () noexcept -> decltype(std::declval< Q >().end())
 Accessor for end() method of an underling collection. Only compiles if SmartPtr_ is specialization type with end() method. More...
 
template<typename Q = T>
auto begin () const noexcept -> decltype(std::declval< const Q >().begin())
 Accessor for begin() method of an underling collection. Only compiles if SmartPtr_ is specialization type with begin() method. More...
 
template<typename Q = T>
auto end () const noexcept -> decltype(std::declval< const Q >().end())
 Accessor for end() method of an underling collection. Only compiles if SmartPtr_ is specialization type with end() method. More...
 
int GetHashCode () const
 Calls GetHashCode() on pointed object. More...
 
T * GetObjectNotNull () const
 Gets currently referenced object (if any) or throws. More...
 

Additional Inherited Members

- Public Types inherited from System::SmartPtr< T >
typedef T Pointee_
 Pointed type. More...
 
typedef SmartPtr< T > SmartPtr_
 Specialized smart pointer type. More...
 
typedef System::Details::ArrayTypeResolver< T >::type ArrayType
 Same as Pointee_, if it is a specialization of System::Array, and void otherwise. More...
 
using ValueType = typename System::Details::SelectType< typename System::Details::ArrayTypeResolver< T >::value_type >::type
 Storage type of pointed array. Only meaningful if T is a specialization of System::Array. More...
 
- Static Public Member Functions inherited from System::SmartPtr< T >
static const System::TypeInfoType ()
 Shortcut to get System::TypeInfo object for the Pointee_ type. More...
 
- Public Attributes inherited from System::SmartPtr< T >
template<typename IdxType >
decltype(System::Details::GetByIndex(std::declval< const SmartPtr_ * >(), std::declval< IdxType >()) operator[] )(IdxType idx) const
 Accessor for array elements. Only compiles if SmartPtr_ is specialization of System::Array. More...
 
- Protected Types inherited from System::SmartPtr< T >
typedef Object SharedRefReleaser
 Type to use to release shared pointers. Depends on whether external refcount is on or off. More...
 
- Protected Member Functions inherited from System::SmartPtr< T >
void Lock (Pointee_ *object)
 Sets pointee object. Increments shared or weak reference count, depending on pointer mode. More...
 
template<class Q >
void Lock (const SmartPtr< Q > &ptr)
 Sets pointee object. Increments shared or weak reference count, depending on pointer mode. More...
 
template<typename Q >
void LockSharedFromShared (const SmartPtr< Q > &ptr)
 Sets pointee object. Asserts that both current object and ptr are in shared mode. More...
 
template<typename Q >
void LockSharedFromWeak (const SmartPtr< Q > &ptr)
 Sets pointee object. Asserts that current object is in shared mode and ptr is in weak mode. More...
 
template<typename Q >
void LockWeakFromShared (const SmartPtr< Q > &ptr)
 Sets pointee object. Asserts that current object is in weak mode and ptr is in shared mode. More...
 
template<typename Q >
void LockWeakFromWeak (const SmartPtr< Q > &ptr)
 Sets pointee object. Asserts that both current object and ptr are in weak mode. More...
 
void Release ()
 Decrements currently referenced object's shared or weak pointer counter, depending on current pointer mode. More...
 
SharedRefReleaserGetSharedReleaser () const
 Gets object to use to release shared pointer to. More...
 
void ReleaseShared ()
 Decrements currently referenced object's shared pointer counter. More...
 
void ReleaseWeak ()
 Decrements currently referenced object's weak pointer counter. More...
 
void MoveSharedFromWeak (SmartPtr &&x)
 Implements move semantics. Asserts that current object is in shared mode and x is in weak mode. More...
 
void MoveWeakFromShared (SmartPtr &&x)
 Implements move semantics. Asserts that current object is in weak mode and x is in shared mode. More...
 
template<typename Q , typename R = decltype(std::declval<Q*>()->GetHashCode())>
GetHashCodeImpl (Q *) const
 Calls into GetHashCode() method if it is available on Pointee_ type (which is true if it is a complete type). More...
 
int GetHashCodeImpl (void *) const
 Calls GetHashCode() method from Object if it is not available on Pointee_ type (e. g. if it is incomplete). More...
 
template<typename Q >
void Assign (const SmartPtr< Q > &x)
 Copy-assigns SmartPtr object. Does type conversions, if required. More...
 
- Static Protected Member Functions inherited from System::SmartPtr< T >
static void ReleaseShared (SharedRefReleaser *releaser)
 Removes shared pointer of a specific object, possibly deleting it. More...
 
static void ReleaseWeak (System::Detail::SmartPtrCounter *counter)
 Decrements weak pointer counter. More...
 
template<typename X , typename Y >
static void InitArray (SmartPtr< Array< X >> *ptr, const SmartPtr< Array< Y >> &src)
 Performs actual array copying on cast constructor calls. More...
 
- Protected Attributes inherited from System::SmartPtr< T >
class System::SmartPtr::Data m_data
 An instance of Data class. More...
 

Detailed Description

template<typename T>
class System::Collections::Generic::ListPtr< T >

List pointer with access operators. This type is a pointer to manage other object's deletion. It should be allocated on stack and passed to functions either by value or by const reference.

Constructor & Destructor Documentation

◆ ListPtr() [1/2]

template<typename T>
System::Collections::Generic::ListPtr< T >::ListPtr ( )
inline

Initializes null-pointer.

◆ ListPtr() [2/2]

template<typename T>
System::Collections::Generic::ListPtr< T >::ListPtr ( const SharedPtr< List< T > > &  obj)
inline

Initializes pointer to specified list.

Parameters
objList to point to.

Member Function Documentation

◆ operator[]() [1/2]

template<typename T>
std::vector<T>::reference System::Collections::Generic::ListPtr< T >::operator[] ( int  idx)
inline

Accessor.

Parameters
idxIndex to access element from.
Returns
Reference to specified element.

◆ operator[]() [2/2]

template<typename T>
std::vector<T>::const_reference System::Collections::Generic::ListPtr< T >::operator[] ( int  idx) const
inline

Accessor.

Parameters
idxIndex to access element from.
Returns
Const reference to specified element.