CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
OdRxBoxedValue Class Referenceabstract

#include <RxValue.h>

Inheritance diagram for OdRxBoxedValue:
OdRxObject OdStaticRxObject< OdRxBoxedValue > OdRxBoxedValueOnStack

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxBoxedValue)
 
virtual const OdRxValuevalue () const =0
 
virtual OdRxValuevalue ()=0
 
virtual OdRxObjectPtr clone () const ODRX_OVERRIDE
 
virtual void copyFrom (const OdRxObject *other) ODRX_OVERRIDE
 
virtual bool isEqualTo (const OdRxObject *other) const ODRX_OVERRIDE
 
virtual OdRx::Ordering comparedTo (const OdRxObject *other) const ODRX_OVERRIDE
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Static Public Member Functions

static OdRxBoxedValuePtr newBoxedValueOnHeap (const OdRxValue &value)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

<group OdRx_Classes>

Base class for wrapping OdRxValue in OdRxObject.

Definition at line 689 of file RxValue.h.

Member Function Documentation

◆ clone()

virtual OdRxObjectPtr OdRxBoxedValue::clone ( ) const
virtual

Clones this value.

Returns
Reference to the cloned object.

Reimplemented from OdRxObject.

◆ comparedTo()

virtual OdRx::Ordering OdRxBoxedValue::comparedTo ( const OdRxObject other) const
virtual

Establishes an order relation with another value.

Returns
OdRx::Ordering::kLessThan if this object is less than the specified object; OdRx::Ordering::kEqual if this object is equal to the specified object; OdRx::Ordering::kGreaterThan if this object is greater than the specified object; OdRx::Ordering::kNotOrderable if these objects cannot be ordered.

Reimplemented from OdRxObject.

◆ copyFrom()

virtual void OdRxBoxedValue::copyFrom ( const OdRxObject other)
virtual

Copies contents from another value.

Parameters
other[in] Object to copy value from.

Reimplemented from OdRxObject.

◆ isEqualTo()

virtual bool OdRxBoxedValue::isEqualTo ( const OdRxObject other) const
virtual

Compares this value with another value.

Parameters
other[in] Object which to compare this value with.
Returns
true if values of both objects are equal; false otherwise.

Reimplemented from OdRxObject.

◆ newBoxedValueOnHeap()

static OdRxBoxedValuePtr OdRxBoxedValue::newBoxedValueOnHeap ( const OdRxValue value)
static

Creates a new boxed value on the heap. Returns a reference-counted smart pointer.

Parameters
value[in] Object of the OdRxValue to be wrapped.
Returns
Reference-counted smart pointer to the created OdRxBoxedValue object.

◆ ODRX_DECLARE_MEMBERS()

OdRxBoxedValue::ODRX_DECLARE_MEMBERS ( OdRxBoxedValue  )

◆ value() [1/2]

virtual const OdRxValue * OdRxBoxedValue::value ( ) const
pure virtual

Returns contained OdRxValue.

Returns
Contained OdRxValue.

Implemented in OdRxBoxedValueOnStack.

◆ value() [2/2]

virtual OdRxValue * OdRxBoxedValue::value ( )
pure virtual

Returns contained OdRxValue.

Returns
Contained OdRxValue.

Implemented in OdRxBoxedValueOnStack.


The documentation for this class was generated from the following file: