System::WeakReference Class Reference

Represents a weak reference, which references an object while still allowing that object to be deleted. More...

Inherits System::Object.

Public Member Functions

 WeakReference ()
 Default constructor. More...
 
 WeakReference (std::nullptr_t)
 Constructor from nullptr. More...
 
 WeakReference (const SmartPtr< Object > &data)
 Initializes a new instance of the WeakReference class, referencing the specified object. More...
 
 WeakReference (const SmartPtr< Object > &data, bool trackResurrection)
 Initializes a new instance of the WeakReference class, referencing the specified object. More...
 
const WeakPtr< Object > & get_Target () const
 Gets the object (the target) referenced by the current WeakReference object. More...
 
void set_Target (const SmartPtr< Object > &data)
 Sets the object (the target) referenced by the current WeakReference object. More...
 
bool get_IsAlive () const
 Gets an indication whether the object referenced by the current WeakReference object has been deleted. More...
 
void reset ()
 
bool operator== (std::nullptr_t) const
 Checks if referenced object is null. More...
 
bool operator!= (std::nullptr_t) const
 Checks if referenced object is not null. More...
 
bool operator== (const WeakReference &other) const
 Compares referenced object to another instance WeakReference class. More...
 
bool operator!= (const WeakReference &other) const
 Compares referenced object to another instance WeakReference class. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents a weak reference, which references an object while still allowing that object to be deleted.

Constructor & Destructor Documentation

◆ WeakReference() [1/4]

System::WeakReference::WeakReference ( )
inline

Default constructor.

◆ WeakReference() [2/4]

System::WeakReference::WeakReference ( std::nullptr_t  )
inline

Constructor from nullptr.

◆ WeakReference() [3/4]

System::WeakReference::WeakReference ( const SmartPtr< Object > &  data)
inline

Initializes a new instance of the WeakReference class, referencing the specified object.

◆ WeakReference() [4/4]

System::WeakReference::WeakReference ( const SmartPtr< Object > &  data,
bool  trackResurrection 
)
inline

Initializes a new instance of the WeakReference class, referencing the specified object.

Parameters
dataObject to store.
trackResurrectionIgnored.

Member Function Documentation

◆ get_IsAlive()

bool System::WeakReference::get_IsAlive ( ) const
inline

Gets an indication whether the object referenced by the current WeakReference object has been deleted.

◆ get_Target()

const WeakPtr<Object>& System::WeakReference::get_Target ( ) const
inline

Gets the object (the target) referenced by the current WeakReference object.

◆ operator!=() [1/2]

bool System::WeakReference::operator!= ( std::nullptr_t  ) const
inline

Checks if referenced object is not null.

Returns
True if referenced object is not null, false otherwise.

◆ operator!=() [2/2]

bool System::WeakReference::operator!= ( const WeakReference other) const
inline

Compares referenced object to another instance WeakReference class.

Parameters
otherObject compare to.
Returns
True if compared objects reference different objects, false if objects are same.

◆ operator==() [1/2]

bool System::WeakReference::operator== ( std::nullptr_t  ) const
inline

Checks if referenced object is null.

Returns
True if referenced object is null, false otherwise.

◆ operator==() [2/2]

bool System::WeakReference::operator== ( const WeakReference other) const
inline

Compares referenced object to another instance WeakReference class.

Parameters
otherObject compare to.
Returns
True if compared objects reference the same object, false otherwise.

◆ reset()

void System::WeakReference::reset ( )
inline

◆ set_Target()

void System::WeakReference::set_Target ( const SmartPtr< Object > &  data)
inline

Sets the object (the target) referenced by the current WeakReference object.