OdRxValue Class

API Reference > OdRx Classes > OdRxValue Class

OdRxValue Class

Class Hierarchy

Syntax

C++

class OdRxValue;

RxValue.h

Generic variant type. Can contain any C++ type. Contained type is described by OdRxValueType.

	Name	Description
	~OdRxValue	Default destructor for objects of the OdRxValue class.
	OdRxValue	This is the overview for the OdRxValue constructor overload.

OdRxValue Methods

	Name	Description
	empty	Returns canonical empty value.
	getEnumTag	Get the corresponding descriptor, if this value contains an enumeration item.
	isEmpty	Checks if the value is empty.
	isVaries	Returns true if the value is undefined. This is represented by assigning special singleton value "varies".
	ODA_ASSUME	each OdRxValue instance is 32 bytes long (on both 32 and 64 bit)
	ODRX_DECLARE_VALUE_TYPE	This is the overview for the ODRX_DECLARE_VALUE_TYPE method overload.
	OdRxValue::OdRxValue	This is the overview for the OdRxValue::OdRxValue method overload.
	rxenum_cast	Constant correct safe cast for enumerations. Returns non-null only if ValueType is contained in this value.
	rxvalue_cast	This is the overview for the rxvalue_cast method overload.
	serializeIn	Read value from the byte array.
	serializeOut	Store value in the byte array.
	toString	Convert value to string.
	type	Get metaclass describing C++ type of the stored value.
	typePath	Retreives an ANSI string in format of path that elaborates the sense of value of the value type. Can be interpreted additionally when working with RxValue.
	unbox	Unwraps RxValue contained in OdRxBoxedValue.
	varies	Returns singleton, representing undefined value.

OdRxValue Nested Types

Name	Description
OdRxBoxedValuePtr	Smart pointer to objects of the OdRxBoxedValue class.

OdRxValue Operators

	Name	Description
	!=	Negative comparison operator.
	<<	Assignment operator. Assigns a value from a C++ variable to this value.
	=	This is the overview for the = operator overload.
	==	Comparison operator.
	>>	Output this value into the C++ variable. Unlike rxvalue_cast<> takes into account type propagations supported by type().toValueType or OdRxValueType::Desc::value().fromValueType.

OdRxValue Structures

	Name	Description
	OdRxValueType::Desc<const char*>	OdRxValueType specialization for 'const char*' value type.
	OdRxValueType::Desc<const OdChar*>	This is class OdRxValue::OdRxValueType::Desc<const OdChar*>.
	OdRxValueType::Desc<OdRxClass*>	OdRxValueType specialization for 'OdRxClass*' value type.

Copyright © 2002–2020. Open Design Alliance. All rights reserved.

Send feedback about this topic