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

Inherits System::BoxedValue< UT >.

Public Member Functions

 BoxedEnum (E e)
 
bool IsBoxedEnum () override
 
uint64_t GetUnsignedLongLongValue () override
 
System::String ToString () ASPOSE_CONST override
 
- Public Member Functions inherited from System::BoxedValue< UT >
 BoxedValue (const UT &value)
 
const UT & unbox () const
 
bool is () const
 
bool Equals (ptr obj) override
 
int GetHashCode () const override
 Returns a hash code for the current object. More...
 
String ToString () ASPOSE_CONST override
 
bool IsBoxedEnum () override
 
uint64_t GetUnsignedLongLongValue () override
 Always returns 0. More...
 
TypeCode GetTypeCode () const override
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

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 SharedPtr< ObjectParse (const TypeInfo &type, const String &str, bool ignoreCase)
 
static SharedPtr< ObjectParse (const TypeInfo &type, const String &str)
 
- 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.