Asposecpplib
System::BoxedEnum< E, UT > Class Template Reference

Represents boxed enumeration 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::BoxedValue< UT >.

Public Member Functions

 BoxedEnum (E e)
 Constructs an instance that represents the specified enumeration value. More...
 
bool IsBoxedEnum () override
 Determines whether the current object represents a boxed value of enum type. More...
 
uint64_t GetUnsignedLongLongValue () override
 Converts the value of the boxed enumeration constant to 64-bit integer value. More...
 
System::String ToString () ASPOSE_CONST override
 Converts boxed value represented by the current object to string. More...
 
- Public Member Functions inherited from System::BoxedValue< UT >
 BoxedValue (const UT &value)
 Constructs an object that represents the specified value boxed. More...
 
const UT & unbox () const
 Unboxes the value represented by the current object. More...
 
bool is () const
 Determines if the type of the boxed value represented by the current object is V. More...
 
bool Equals (ptr obj) override
 Determines the equality of the boxed values represented by the current and specified objects. More...
 
int GetHashCode () const override
 Returns a hash code for the current object. More...
 
String ToString () ASPOSE_CONST override
 Converts boxed value represented by current object to string. More...
 
bool IsBoxedEnum () override
 Determines if current object represents a boxed value of enum type. More...
 
uint64_t GetUnsignedLongLongValue () override
 Always returns 0. More...
 
TypeCode GetTypeCode () const override
 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 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...
 

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...
 
- Static Public Member Functions inherited from System::BoxedValueBase
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...
 

Detailed Description

template<typename E, typename UT = typename std::underlying_type<E>::type>
class System::BoxedEnum< E, UT >

Represents boxed enumeration 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.

Template Parameters
EType of the enumeration value
UTThe underlying type of enumeration E

Constructor & Destructor Documentation

◆ BoxedEnum()

template<typename E , typename UT = typename std::underlying_type<E>::type>
System::BoxedEnum< E, UT >::BoxedEnum ( e)
inline

Constructs an instance that represents the specified enumeration value.

Parameters
eEnumeration value to be boxed and represented by the constructed instance.

Member Function Documentation

◆ GetUnsignedLongLongValue()

template<typename E , typename UT = typename std::underlying_type<E>::type>
uint64_t System::BoxedEnum< E, UT >::GetUnsignedLongLongValue ( )
inlineoverridevirtual

Converts the value of the boxed enumeration constant to 64-bit integer value.

Returns
64-bit integer value equivalent to the value of enumeration constant represented by the current object

Implements System::BoxedValueBase.

◆ IsBoxedEnum()

template<typename E , typename UT = typename std::underlying_type<E>::type>
bool System::BoxedEnum< E, UT >::IsBoxedEnum ( )
inlineoverridevirtual

Determines whether the current object represents a boxed value of enum type.

Returns
Always true

Implements System::BoxedValueBase.

◆ ToString()

template<typename E , typename UT = typename std::underlying_type<E>::type>
System::String System::BoxedEnum< E, UT >::ToString ( )
inlineoverridevirtual

Converts boxed value represented by the current object to string.

Returns
String representation of the boxed value

Reimplemented from System::Object.