Asposecpplib
System::BoxedValueBase Class Referenceabstract

A base class that defines an interface and implements some fundamental methods of a descendant class that represents a boxed value. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Object.

Inherited by System::BoxedValue< UT >, and System::BoxedValue< T >.

Public Member Functions

virtual ASPOSECPP_SHARED_API bool IsBoxedEnum ()=0
 Determines if current object represents a boxed value of enum type. More...
 
virtual ASPOSECPP_SHARED_API uint64_t GetUnsignedLongLongValue ()=0
 Converts the boxed represented by the current object to 64-bit integer value. More...
 
virtual ASPOSECPP_SHARED_API TypeCode GetTypeCode () const =0
 Returns the value representing the type of the boxed value represented by the current object. 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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...
 

Static Public Member Functions

static ASPOSECPP_SHARED_API SharedPtr< ObjectParse (const TypeInfo &type, const String &str, bool ignoreCase)
 Boxes the value of enumeration constant of the specified enumeration with the specified name. A parameter specifies if the case should be ignored when interpreting the string specifying the name of the enumeration constant. More...
 
static ASPOSECPP_SHARED_API SharedPtr< ObjectParse (const TypeInfo &type, const String &str)
 Boxes the value of enumeration constant of the specified enumeration with the specified name. 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 

Detailed Description

A base class that defines an interface and implements some fundamental methods of a descendant class that represents a boxed value. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Function Documentation

◆ GetTypeCode()

virtual ASPOSECPP_SHARED_API TypeCode System::BoxedValueBase::GetTypeCode ( ) const
pure virtual

Returns the value representing the type of the boxed value represented by the current object.

Returns
Value of TypeCode enum representing the type of the boxed value represented by the current object

Implemented in System::BoxedValue< T >, and System::BoxedValue< UT >.

◆ GetUnsignedLongLongValue()

virtual ASPOSECPP_SHARED_API uint64_t System::BoxedValueBase::GetUnsignedLongLongValue ( )
pure virtual

Converts the boxed represented by the current object to 64-bit integer value.

Returns
64-bit integer value equivalent to the boxed value represented by the current object

Implemented in System::BoxedValue< T >, System::BoxedValue< UT >, and System::BoxedEnum< E, UT >.

◆ IsBoxedEnum()

virtual ASPOSECPP_SHARED_API bool System::BoxedValueBase::IsBoxedEnum ( )
pure virtual

Determines if current object represents a boxed value of enum type.

Returns
True if current object represents a boxed value of enum type, otherwise - false

Implemented in System::BoxedValue< T >, System::BoxedValue< UT >, and System::BoxedEnum< E, UT >.

◆ Parse() [1/2]

static ASPOSECPP_SHARED_API SharedPtr<Object> System::BoxedValueBase::Parse ( const TypeInfo type,
const String str,
bool  ignoreCase 
)
static

Boxes the value of enumeration constant of the specified enumeration with the specified name. A parameter specifies if the case should be ignored when interpreting the string specifying the name of the enumeration constant.

Parameters
typeSpecifies the type of the enumeration
strThe name of the enumeration constant, value of which is to be boxed
ignoreCaseSpecifies if case should be ignored when interpreting the string representing the name of the enumeration constant
Returns
A shared pointer to the object representing boxed value of the specified enumeration constant
Exceptions
InvalidEnumArgumentExceptionIf the specified enumeration constant was not found in the specified enumeration

◆ Parse() [2/2]

static ASPOSECPP_SHARED_API SharedPtr<Object> System::BoxedValueBase::Parse ( const TypeInfo type,
const String str 
)
static

Boxes the value of enumeration constant of the specified enumeration with the specified name.

Parameters
typeSpecifies the type of the enumeration
strThe name of the enumeration constant, value of which is to be boxed
Returns
A shared pointer to the object representing boxed value of the specified enumeration constant
Exceptions
InvalidEnumArgumentExceptionIf the specified enumeration constant was not found in the specified enumeration