UaVariant Class Reference [UA Base Library Classes]

Portable Ua Variant class. Converts Variant into all datatypes. The UaVariant class acts like a union for the most common Ua data types. More...

#include <uavariant.h>

List of all members.

Public Member Functions
	UaVariant ()
	UaVariant (const UaVariant &)
	UaVariant (const OpcUa_Variant &)
	UaVariant (OpcUa_Variant *pValue, OpcUa_Boolean detachValue=OpcUa_False)
	UaVariant (const UaString &)
	UaVariant (const UaNodeId &)
	UaVariant (const UaQualifiedName &)
	UaVariant (const UaLocalizedText &)
	UaVariant (OpcUa_Double)
	UaVariant (OpcUa_Float)
	UaVariant (OpcUa_Int32)
	UaVariant (OpcUa_Int16)
	UaVariant (OpcUa_UInt32)
	UaVariant (OpcUa_UInt16)
	UaVariant (OpcUa_Boolean)
	~UaVariant ()
void	clear ()
OpcUa_Boolean	isEmpty () const
OpcUa_Byte	arrayType () const
OpcUa_Boolean	isArray () const
OpcUa_Int32	arraySize () const
OpcUa_Boolean	isMatrix () const
OpcUa_Int32	dimensionSize () const
void	arrayDimensions (UaUInt32Array &arrayDimensions) const
OpcUa_BuiltInType	type () const
UaNodeId	dataType () const
OpcUa_StatusCode	changeType (OpcUa_BuiltInType, OpcUa_Boolean toArray)
OpcUa_StatusCode	getIndexRange (const UaNumericRange &indexRange, UaVariant &value) const
OpcUa_StatusCode	applyIndexRange (const UaNumericRange &indexRange, const UaVariant &value)
	UaVariant (const VARIANT &)
UaVariant &	operator= (const VARIANT &)
	operator VARIANT () const
UaVariant &	operator= (const OpcUa_Variant &)
UaVariant &	operator= (const UaVariant &)
UaVariant &	operator= (double)
UaVariant &	operator= (const UaString &)
bool	operator== (const UaVariant &) const
bool	operator!= (const UaVariant &) const
bool	operator> (const UaVariant &) const
bool	operator< (const UaVariant &) const
bool	operator>= (const UaVariant &) const
bool	operator<= (const UaVariant &) const
OpcUa_Variant	operator[] (const OpcUa_UInt32 index) const
	operator const OpcUa_Variant * () const
void	detach ()
void	attach (const OpcUa_Variant *pSrc)
OpcUa_Variant *	copy () const
void	copyTo (OpcUa_Variant *pDst) const
void	setBool (OpcUa_Boolean val)
void	setSByte (OpcUa_SByte val)
void	setInt16 (OpcUa_Int16 val)
void	setInt32 (OpcUa_Int32 val)
void	setInt64 (OpcUa_Int64 val)
void	setByte (OpcUa_Byte val)
void	setUInt16 (OpcUa_UInt16 val)
void	setUInt32 (OpcUa_UInt32 val)
void	setUInt64 (OpcUa_UInt64 val)
void	setFloat (OpcUa_Float val)
void	setDouble (OpcUa_Double val)
void	setString (const UaString &val)
void	setDateTime (const UaDateTime &val)
void	setGuid (const UaGuid &val)
void	setByteString (UaByteString &val, OpcUa_Boolean bDetach)
void	setXmlElement (const UaString &val)
void	setXmlElement (UaByteString &val, OpcUa_Boolean bDetach)
void	setNodeId (const UaNodeId &val)
void	setExpandedNodeId (const UaExpandedNodeId &val)
void	setStatusCode (OpcUa_StatusCode val)
void	setQualifiedName (const UaQualifiedName &val)
void	setLocalizedText (const UaLocalizedText &val)
void	setExtensionObject (UaExtensionObject &val, OpcUa_Boolean bDetach)
void	setDataValue (UaDataValue *pVal, OpcUa_Boolean bDetach)
void	setBoolArray (UaBoolArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setByteArray (UaByteArray &val)
void	setSByteArray (UaSByteArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setInt16Array (UaInt16Array &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setUInt16Array (UaUInt16Array &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setInt32Array (UaInt32Array &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setUInt32Array (UaUInt32Array &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setInt64Array (UaInt64Array &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setUInt64Array (UaUInt64Array &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setFloatArray (UaFloatArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setDoubleArray (UaDoubleArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setStringArray (UaStringArray &val, OpcUa_Boolean bDetach)
void	setStringArray (const UaStringArray &val)
void	setDateTimeArray (UaDateTimeArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setGuidArray (UaGuidArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setByteStringArray (UaByteStringArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setByteStringArray (const UaByteStringArray &val)
void	setXmlElementArray (UaByteStringArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setXmlElementArray (const UaByteStringArray &val)
void	setNodeIdArray (UaNodeIdArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setExpandedNodeIdArray (UaExpandedNodeIdArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setStatusCodeArray (UaStatusCodeArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setQualifiedNameArray (UaQualifiedNameArray &val, OpcUa_Boolean bDetach)
void	setQualifiedNameArray (const UaQualifiedNameArray &val)
void	setLocalizedTextArray (UaLocalizedTextArray &val, OpcUa_Boolean bDetach)
void	setLocalizedTextArray (const UaLocalizedTextArray &val)
void	setExtensionObjectArray (UaExtensionObjectArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setVariantArray (UaVariantArray &val, OpcUa_Boolean bDetach=OpcUa_False)
void	setVariantArray (const UaVariantArray &val)
OpcUa_StatusCode	toBool (OpcUa_Boolean &val) const
OpcUa_StatusCode	toSByte (OpcUa_SByte &val) const
OpcUa_StatusCode	toInt16 (OpcUa_Int16 &val) const
OpcUa_StatusCode	toInt32 (OpcUa_Int32 &val) const
OpcUa_StatusCode	toInt64 (OpcUa_Int64 &val) const
OpcUa_StatusCode	toByte (OpcUa_Byte &val) const
OpcUa_StatusCode	toUInt16 (OpcUa_UInt16 &val) const
OpcUa_StatusCode	toUInt32 (OpcUa_UInt32 &val) const
OpcUa_StatusCode	toUInt64 (OpcUa_UInt64 &val) const
OpcUa_StatusCode	toFloat (OpcUa_Float &val) const
OpcUa_StatusCode	toDouble (OpcUa_Double &val) const
OpcUa_StatusCode	toDateTime (UaDateTime &val) const
OpcUa_StatusCode	toGuid (UaGuid &val) const
OpcUa_StatusCode	toByteString (UaByteString &val) const
OpcUa_StatusCode	toXmlElement (UaByteString &val) const
OpcUa_StatusCode	toNodeId (UaNodeId &val) const
OpcUa_StatusCode	toExpandedNodeId (UaExpandedNodeId &val) const
OpcUa_StatusCode	toStatusCode (OpcUa_StatusCode &val) const
OpcUa_StatusCode	toQualifiedName (UaQualifiedName &val) const
OpcUa_StatusCode	toLocalizedText (UaLocalizedText &val) const
OpcUa_StatusCode	toExtensionObject (UaExtensionObject &val) const
OpcUa_StatusCode	toDataValue (UaDataValue *pVal) const
OpcUa_StatusCode	toBoolArray (UaBoolArray &val) const
OpcUa_StatusCode	toByteArray (UaByteArray &val) const
OpcUa_StatusCode	toSByteArray (UaSByteArray &val) const
OpcUa_StatusCode	toInt16Array (UaInt16Array &val) const
OpcUa_StatusCode	toUInt16Array (UaUInt16Array &val) const
OpcUa_StatusCode	toInt32Array (UaInt32Array &val) const
OpcUa_StatusCode	toUInt32Array (UaUInt32Array &val) const
OpcUa_StatusCode	toInt64Array (UaInt64Array &val) const
OpcUa_StatusCode	toUInt64Array (UaUInt64Array &val) const
OpcUa_StatusCode	toFloatArray (UaFloatArray &val) const
OpcUa_StatusCode	toDoubleArray (UaDoubleArray &val) const
OpcUa_StatusCode	toStringArray (UaStringArray &val) const
OpcUa_StatusCode	toDateTimeArray (UaDateTimeArray &val) const
OpcUa_StatusCode	toGuidArray (UaGuidArray &val) const
OpcUa_StatusCode	toByteStringArray (UaByteStringArray &val) const
OpcUa_StatusCode	toXmlElementArray (UaByteStringArray &val) const
OpcUa_StatusCode	toNodeIdArray (UaNodeIdArray &val) const
OpcUa_StatusCode	toExpandedNodeIdArray (UaExpandedNodeIdArray &val) const
OpcUa_StatusCode	toStatusCodeArray (UaStatusCodeArray &val) const
OpcUa_StatusCode	toQualifiedNameArray (UaQualifiedNameArray &val) const
OpcUa_StatusCode	toLocalizedTextArray (UaLocalizedTextArray &val) const
OpcUa_StatusCode	toExtensionObjectArray (UaExtensionObjectArray &val) const
OpcUa_StatusCode	toVariantArray (UaVariantArray &val) const
UaString	toString () const
UaString	toFullString () const
Static Public Member Functions
static OpcUa_StatusCode	VartypeToUaType (VARTYPE vt, OpcUa_BuiltInType &ut, OpcUa_Boolean &isArray)
static OpcUa_StatusCode	UaTypeToVartype (OpcUa_BuiltInType ut, OpcUa_Boolean isArray, VARTYPE &vt)
static bool	compare (const OpcUa_Variant &, const OpcUa_Variant &)
static void	adjustTypes (UaVariant &, UaVariant &)
static OpcUa_Variant *	clone (const OpcUa_Variant &source)
static void	cloneTo (const OpcUa_Variant &source, OpcUa_Variant &copy)

---

Detailed Description

Portable Ua Variant class. Converts Variant into all datatypes. The UaVariant class acts like a union for the most common Ua data types.

UaVariant

---

Constructor & Destructor Documentation

UaVariant::UaVariant

(

)

Constructs an empty variant.

UaVariant::UaVariant

(

const UaVariant &

vVal )

Constructs a variant initialized with the passed variant value.

Parameters:

[in]

vVal

The value as UaVariant

UaVariant::UaVariant

(

const OpcUa_Variant &

vVal )

Constructs a variant initialized with the passed variant value.

Parameters:

[in]

vVal

The value as OpcUa_Variant

UaVariant::UaVariant	(	OpcUa_Variant *	pValue,
		OpcUa_Boolean	detachValue = OpcUa_False
	)

Constructs a variant initialized with the passed variant value. This version allows to detach the variant value from the passed structure to avoid copying of variants containing a lot of data like arrays or strings.

Parameters:

[in]	pValue	The value as OpcUa_Variant
[in]	detachValue	Flag indicating if the passed variant should be detached

UaVariant::UaVariant

(

const UaString &

val )

Constructs a variant initialized with the passed string value.

Parameters:

[in]

val

The value as UaString

UaVariant::UaVariant

(

const UaNodeId &

val )

Constructs a variant initialized with the passed string value.

Parameters:

[in]

val

The value as UaNodeId

UaVariant::UaVariant

(

const UaQualifiedName &

val )

Constructs a variant initialized with the passed string value.

Parameters:

[in]

val

The value as UaQualifiedName

UaVariant::UaVariant

(

const UaLocalizedText &

val )

Constructs a variant initialized with the passed string value.

Parameters:

[in]

val

The value as UaLocalizedText

UaVariant::UaVariant

(

OpcUa_Double

dblVal )

Constructs a variant initialized with the passed double value.

Parameters:

[in]

dblVal

The value as OpcUa_Double

UaVariant::UaVariant

(

OpcUa_Float

fltVal )

Constructs a variant initialized with the passed float value.

Parameters:

[in]

fltVal

The value as OpcUa_Float

UaVariant::UaVariant

(

OpcUa_Int32

iVal )

Constructs a variant initialized with the passed Int32 value.

Parameters:

[in]

iVal

The value as OpcUa_Int32

UaVariant::UaVariant

(

OpcUa_Int16

iVal )

Constructs a variant initialized with the passed Int16 value.

Parameters:

[in]

iVal

The value as OpcUa_Int16

UaVariant::UaVariant

(

OpcUa_UInt32

iVal )

Constructs a variant initialized with the passed UInt32 value.

Parameters:

[in]

iVal

The value as OpcUa_UInt32

UaVariant::UaVariant

(

OpcUa_UInt16

iVal )

Constructs a variant initialized with the passed UInt16 value.

Parameters:

[in]

iVal

The value as OpcUa_UInt16

UaVariant::UaVariant

(

OpcUa_Boolean

bVal )

Constructs a variant initialized with the passed bool value.

Parameters:

[in]

bVal

The value as OpcUa_Boolean

UaVariant::~UaVariant

(

)

destruction

UaVariant::UaVariant

(

const VARIANT &

copy )

Constructs a UaVariant with the passed Windows VARIANT value

---

Member Function Documentation

void UaVariant::adjustTypes	(	UaVariant &	value1,
		UaVariant &	value2
	)		[static]

Adjust types to prepare comparison of values independent of the variant type. Adjustment is only implemented for Number data types. The data type is adjusted to Double, UInt64 or Int64 depending on the passed data types.

OpcUa_StatusCode UaVariant::applyIndexRange	(	const UaNumericRange &	indexRange,
		const UaVariant &	value
	)

Applies an index range to this variant. Returns error if the index range could not be applied.

Parameters:

[in]	indexRange	The index range to apply
[in]	value	The value to apply with index range

void UaVariant::arrayDimensions

(

UaUInt32Array &

arrayDimensions )

const

Writes the size of each dimension to an UaUInt32Array

Parameters:

arrayDimensions

The array to write to

OpcUa_Int32 UaVariant::arraySize

(

)

const

Get the actual array size.

Returns:

the actual array size.

OpcUa_Byte UaVariant::arrayType

(

)

const

Get the actual array type. Possible values are
OpcUa_VariantArrayType_Scalar 0x00
OpcUa_VariantArrayType_Array 0x01
OpcUa_VariantArrayType_Matrix 0x02

Returns:

the actual array type.

void UaVariant::attach

(

const OpcUa_Variant *

vVal )

Attach the internal variant data of the passed variant to the own variant.

Parameters:

vVal	a value as OpcUa_Variant.

OpcUa_StatusCode UaVariant::changeType	(	OpcUa_BuiltInType	type,
		OpcUa_Boolean	toArray
	)

Change the type of a parameter.

Parameters:

type	the type to change.
toArray	true if set to array false if not.

Returns:

the OPC UA Status code.

void UaVariant::clear

(

)

Clear the data of the UaVariant.

OpcUa_Variant * UaVariant::clone

(

const OpcUa_Variant &

source )

[static]

Copy UaVariant data to a newly allocated UaVariant.

Parameters:

source

the source of this operation.

Returns:

a newly allocated OpcUa_Variant.

void UaVariant::cloneTo	(	const OpcUa_Variant &	source,
		OpcUa_Variant &	copy
	)		[static]

Copy OpcUa_VariableTypeAttributes data to an exisitng OpcUa_VariableTypeAttributes structure.

Parameters:

source	Source OpcUa_VariableTypeAttributes to clone.
copy	New copy of source OpcUa_VariableTypeAttributes.

bool UaVariant::compare	(	const OpcUa_Variant &	Val1,
		const OpcUa_Variant &	Val2
	)		[static]

Compares two variant values.

Parameters:

Val1	First value as OpcUa_Variant.
Val2	Second value as OpcUa_Variant.

Returns:

true if equal false if not.

OpcUa_Variant * UaVariant::copy

(

)

const

Copy UaVariant data to a newly allocated OpcUa_Variant.

Returns:

data to a newly allocated OpcUa_Variant.

void UaVariant::copyTo

(

OpcUa_Variant *

pDst )

const

Copy UaArgument data to an exisitng OpcUa_Argument structure.

Parameters:

pDst	the destination of this operation.

UaNodeId UaVariant::dataType

(

)

const

Get the DataType for the DataVariable.

Returns:

the DataType for the DataVariable.

void UaVariant::detach

(

)

Reset UaVariant structure without clearing the data.

OpcUa_Int32 UaVariant::dimensionSize

(

)

const

Get the size of the dimensions.

Returns:

the size of the dimensions.

OpcUa_StatusCode UaVariant::getIndexRange	(	const UaNumericRange &	indexRange,
		UaVariant &	value
	)		const

Applies an index range to the variant value and returns the subset of the data selected by the index range or an error if the index range is invalid for the value of the variant.

Returns:

Status code

Parameters:

[in]	indexRange	The index range to apply
[out]	value	The result value after applying the index range

OpcUa_Boolean UaVariant::isArray

(

)

const

Check wether the var is an array or not.

Returns:

true if it is an array false if not.

OpcUa_Boolean UaVariant::isEmpty

(

)

const

Checks wether the variant is empty or not.

Returns:

true if empty false if not.

OpcUa_Boolean UaVariant::isMatrix

(

)

const

Check if there is a matrix.

Returns:

true if there is a matrix false if not.

UaVariant::operator const OpcUa_Variant *

(

)

const

Get a reference to a value.

Returns:

reference to a value.

UaVariant::operator VARIANT

(

)

const

Converts a UaVariant value to a Windows Variant value. The caller is responsible for clearing the Windows VARIANT with VariantClear()

Returns:

The Windows variant value

bool UaVariant::operator!=

(

const UaVariant &

vVal )

const

Returns true if this variant is not equal to variant other; otherwise returns false.

See also:

operator==

bool UaVariant::operator<

(

const UaVariant &

other )

const

Returns true if this variant is less than variant other; otherwise returns false. Returns false if the data type of the two variants are different. Returns false if the value is not scalar.

bool UaVariant::operator<=

(

const UaVariant &

other )

const

Returns true if this variant is less than or equal to variant other; otherwise returns false. Returns false if the data type of the two variants are different. Returns false if the value is not scalar.

UaVariant & UaVariant::operator=

(

const OpcUa_Variant &

vVal )

Assigns the content of a OpcUa_Variant variant strucutre to this variant and clears the old value.

UaVariant & UaVariant::operator=

(

const UaVariant &

other )

Assigns another variant to this variant and clears the old value.

UaVariant & UaVariant::operator=

(

double

dblVal )

Assigns a double value to this variant and clears the old value.

UaVariant & UaVariant::operator=

(

const UaString &

strVal )

Assigns a string to this variant and clears the old value.

UaVariant & UaVariant::operator=

(

const VARIANT &

copy )

Implements the operator = for assigning a Windows VARIANT value to the UaVariant.

bool UaVariant::operator==

(

const UaVariant &

other )

const

Returns true if this variant is equal to variant other; otherwise returns false. Return false if the data type of the two variants are different.

bool UaVariant::operator>

(

const UaVariant &

other )

const

Returns true if this variant is greater than variant other; otherwise returns false. Returns false if the data type of the two variants are different. Returns false if the value is not scalar.

bool UaVariant::operator>=

(

const UaVariant &

other )

const

Returns true if this variant is greater than or equal to variant other; otherwise returns false. Returns false if the data type of the two variants are different. Returns false if the value is not scalar.

OpcUa_Variant UaVariant::operator[]

(

const OpcUa_UInt32

index )

const

Returns the array element for the given index. This method works also for scalar ByteString values.

Parameters:

index

Array in idnex.

Returns:

Array element.

void UaVariant::setBool

(

OpcUa_Boolean

val )

Sets a boolean value

Parameters:

[in]

val

The new boolean value

void UaVariant::setBoolArray	(	UaBoolArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaBoolArray.

Parameters:

val	a value as UaBoolArray.
bDetach	true if detach false if not.

void UaVariant::setByte

(

OpcUa_Byte

val )

Sets a value to OpcUa_Byte.

Parameters:

val	a value as OpcUa_Byte.

void UaVariant::setByteArray

(

UaByteArray &

val )

Sets a value to UaByteArray.

Parameters:

val	a value as UaByteArray.

void UaVariant::setByteString	(	UaByteString &	val,
		OpcUa_Boolean	bDetach
	)

Sets a ByteString value to the Variant.

Parameters:

val	a value as UaByteString.
bDetach	true if detach false if not.

void UaVariant::setByteStringArray	(	UaByteStringArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaByteStringArray.

Parameters:

val	a value as UaByteStringArray.
bDetach	true if detach false if not.

void UaVariant::setByteStringArray

(

const UaByteStringArray &

val )

Sets a value to UaByteStringArray.

Parameters:

val	a value as UaByteStringArray.

void UaVariant::setDataValue	(	UaDataValue *	pVal,
		OpcUa_Boolean	bDetach
	)

Sets a UaDataValue value to the variant.

The method signature is different to the other setter methods to allow forward declaration or UaDataValue in this class to avoid cross include headers with UaDataValue since it uses UaVariant.

Parameters:

pVal	Pointer to the UaDataValue to set. The UaDataValue will be changed if the detach flag is set.
bDetach	The detach flag indicates if a shallow copy of the data should be created. In this case the data is detached from the UaDataValue.

void UaVariant::setDateTime

(

const UaDateTime &

val )

Sets a value to UaDateTime.

Parameters:

val	a value as UaDateTime.

void UaVariant::setDateTimeArray	(	UaDateTimeArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaDateTimeArray.

Parameters:

val	a value as UaDateTimeArray.
bDetach	true if detach false if not.

void UaVariant::setDouble

(

OpcUa_Double

val )

Sets a value to OpcUa_Double.

Parameters:

val	a value as OpcUa_Double.

void UaVariant::setDoubleArray	(	UaDoubleArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaDoubleArray.

Parameters:

val	a value as UaDoubleArray.
bDetach	true if detach false if not.

void UaVariant::setExpandedNodeId

(

const UaExpandedNodeId &

val )

Sets a UaExpandedNodeId value to the variant.

Parameters:

val	a value as UaExpandedNodeId.

void UaVariant::setExpandedNodeIdArray	(	UaExpandedNodeIdArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a OpcUa_ExpandedNodeId array to the variant.

Parameters:

val	a value as UaExpandedNodeIdArray.
bDetach	true if detach false if not.

void UaVariant::setExtensionObject	(	UaExtensionObject &	val,
		OpcUa_Boolean	bDetach
	)

Sets a ExtensionObject value to the variant.

Parameters:

val	a value as UaExtensionObject.
bDetach	true if detach false if not.

void UaVariant::setExtensionObjectArray	(	UaExtensionObjectArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaExtensionObjectArray.

Parameters:

val	a value as UaExtensionObjectArray.
bDetach	true if detach false if not.

void UaVariant::setFloat

(

OpcUa_Float

val )

Sets a value to OpcUa_Float.

Parameters:

val	a value as OpcUa_Float.

void UaVariant::setFloatArray	(	UaFloatArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaFloatArray.

Parameters:

val	a value as UaFloatArray.
bDetach	true if detach false if not.

void UaVariant::setGuid

(

const UaGuid &

val )

Sets a value to UaGuid.

Parameters:

val	a value as UaGuid.

void UaVariant::setGuidArray	(	UaGuidArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaGuidArray.

Parameters:

val	a value as UaGuidArray.
bDetach	true if detach false if not.

void UaVariant::setInt16

(

OpcUa_Int16

val )

Sets a value to OpcUa_Int16.

Parameters:

val	a value as OpcUa_Int16.

void UaVariant::setInt16Array	(	UaInt16Array &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaInt16Array.

Parameters:

val	a value as UaInt16Array.
bDetach	true if detach false if not.

void UaVariant::setInt32

(

OpcUa_Int32

val )

Sets a value to OpcUa_Int32.

Parameters:

val	a value as OpcUa_Int32.

void UaVariant::setInt32Array	(	UaInt32Array &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaInt32Array.

Parameters:

val	a value as UaInt32Array.
bDetach	true if detach false if not.

void UaVariant::setInt64

(

OpcUa_Int64

val )

Sets a value to OpcUa_Int64.

Parameters:

val	a value as OpcUa_Int64.

void UaVariant::setInt64Array	(	UaInt64Array &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaInt64Array.

Parameters:

val	a value as UaInt64Array.
bDetach	true if detach false if not.

void UaVariant::setLocalizedText

(

const UaLocalizedText &

val )

Sets a value to UaLocalizedText.

Parameters:

val	a value as UaLocalizedText.

void UaVariant::setLocalizedTextArray	(	UaLocalizedTextArray &	val,
		OpcUa_Boolean	bDetach
	)

Sets a value to UaLocalizedTextArray.

Parameters:

val	a value as UaLocalizedTextArray.
bDetach	true if detach false if not.

void UaVariant::setLocalizedTextArray

(

const UaLocalizedTextArray &

val )

Sets a value to UaLocalizedTextArray.

Parameters:

val	a value as UaLocalizedTextArray.

void UaVariant::setNodeId

(

const UaNodeId &

val )

Sets a value to UaNodeId.

Parameters:

val	a value as UaNodeId.

void UaVariant::setNodeIdArray	(	UaNodeIdArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a OpcUa_NodeId array to the variant.

Parameters:

val	a value as UaNodeIdArray.
bDetach	true if detach false if not.

void UaVariant::setQualifiedName

(

const UaQualifiedName &

val )

Sets a value to UaQualifiedName.

Parameters:

val	a value as UaQualifiedName.

void UaVariant::setQualifiedNameArray	(	UaQualifiedNameArray &	val,
		OpcUa_Boolean	bDetach
	)

Sets a value to UaQualifiedNameArray.

Parameters:

val	a value as UaQualifiedNameArray.
bDetach	true if detach false if not.

void UaVariant::setQualifiedNameArray

(

const UaQualifiedNameArray &

val )

Sets a value to QualifiedNameArray.

Parameters:

val	a value as UaQualifiedNameArray.

void UaVariant::setSByte

(

OpcUa_SByte

val )

Sets a value to OpcUa_SByte.

Parameters:

val	a value as OpcUa_SByte.

void UaVariant::setSByteArray	(	UaSByteArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaSByteArray.

Parameters:

val	a value as UaSByteArray.
bDetach	true if detach false if not.

void UaVariant::setStatusCode

(

OpcUa_StatusCode

val )

Sets a OpcUa_StatusCode value to the Variant.

Parameters:

val	a value as OpcUa_StatusCode.

void UaVariant::setStatusCodeArray	(	UaStatusCodeArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a OpcUa_StatusCode array to the variant.

Parameters:

val	a value as UaStatusCodeArray.
bDetach	true if detach false if not.

void UaVariant::setString

(

const UaString &

val )

Sets a String value to the Variant.

Parameters:

val	a value as UaString.

void UaVariant::setStringArray	(	UaStringArray &	val,
		OpcUa_Boolean	bDetach
	)

Sets a value to UaStringArray.

Parameters:

val	a value as UaStringArray.
bDetach	true if detach false if not.

void UaVariant::setStringArray

(

const UaStringArray &

val )

Sets a value to UaStringArray.

Parameters:

val	a value as UaStringArray.

void UaVariant::setUInt16

(

OpcUa_UInt16

val )

Sets a value to OpcUa_UInt16.

Parameters:

val	a value as OpcUa_UInt16.

void UaVariant::setUInt16Array	(	UaUInt16Array &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaInt16Array.

Parameters:

val	a value as UaInt16Array.
bDetach	true if detach false if not.

void UaVariant::setUInt32

(

OpcUa_UInt32

val )

Sets a OpcUa_UInt32 value to the Variant.

Parameters:

val	a value as OpcUa_UInt32.

void UaVariant::setUInt32Array	(	UaUInt32Array &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaUInt32Array.

Parameters:

val	a value as UaUInt32Array.
bDetach	true if detach false if not.

void UaVariant::setUInt64

(

OpcUa_UInt64

val )

Sets a value to OpcUa_UInt64.

Parameters:

val	a value as OpcUa_UInt64.

void UaVariant::setUInt64Array	(	UaUInt64Array &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaUInt64Array.

Parameters:

val	a value as UaUInt64Array.
bDetach	true if detach false if not.

void UaVariant::setVariantArray	(	UaVariantArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaVariantArray.

Parameters:

val	a value as UaVariantArray.
bDetach	true if detach false if not.

void UaVariant::setVariantArray

(

const UaVariantArray &

val )

Sets a value to UaVariantArray.

Parameters:

val	a value as UaVariantArray.

void UaVariant::setXmlElement

(

const UaString &

val )

Sets a XmlElement value to the Variant.

Parameters:

val	a value as UaString.

void UaVariant::setXmlElement	(	UaByteString &	val,
		OpcUa_Boolean	bDetach
	)

Sets a XmlElement value to the Variant.

Parameters:

val	a value as UaByteString.
bDetach	true if detach false if not.

void UaVariant::setXmlElementArray	(	UaByteStringArray &	val,
		OpcUa_Boolean	bDetach = OpcUa_False
	)

Sets a value to UaXmlElementArray.

See also:

setByteStringArray

Parameters:

val	a value as UaByteStringArray.
bDetach	true if detach false if not.

void UaVariant::setXmlElementArray

(

const UaByteStringArray &

val )

Sets a value to XmlElementArray.

See also:

setByteStringArray

Parameters:

val	a value as UaByteStringArray.

OpcUa_StatusCode UaVariant::toBool

(

OpcUa_Boolean &

val )

const

Converts the UaVariant into a OpcUa_Boolean.

Parameters:

val	a value as OpcUa_Boolean.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toBoolArray

(

UaBoolArray &

val )

const

Converts the UaVariant into a UaBoolArray.

Parameters:

val	a value as UaBoolArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toByte

(

OpcUa_Byte &

val )

const

Converts the UaVariant into a OpcUa_Byte.

Parameters:

val	a value as OpcUa_Byte.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toByteArray

(

UaByteArray &

val )

const

Converts the UaVariant into a UaByteArray.

Parameters:

val	a value as UaByteArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toByteString

(

UaByteString &

val )

const

Converts the UaVariant into a UaByteString.

Parameters:

val	a value as UaByteString.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toByteStringArray

(

UaByteStringArray &

val )

const

Converts the UaVariant into a UaByteStringArray.

Parameters:

val	a value as UaByteStringArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toDataValue

(

UaDataValue *

pVal )

const

Converts the UaVariant into a UaDataValue.

The method signature is different to the other setter methods to allow forward declaration or UaDataValue in this class to avoid cross include headers with UaDataValue since it uses UaVariant.

Parameters:

pVal	a value as UaDataValue.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toDateTime

(

UaDateTime &

val )

const

Converts the UaVariant into a UaDateTime.

Parameters:

val	a value as UaDateTime.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toDateTimeArray

(

UaDateTimeArray &

val )

const

Converts the UaVariant into a UaDateTimeArray.

Parameters:

val	a value as UaDateTimeArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toDouble

(

OpcUa_Double &

val )

const

Converts the UaVariant into a OpcUa_Double.

Parameters:

val	a value as OpcUa_Double.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toDoubleArray

(

UaDoubleArray &

val )

const

Converts the UaVariant into a UaDoubleArray.

Parameters:

val	a value as UaDoubleArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toExpandedNodeId

(

UaExpandedNodeId &

val )

const

Converts the UaVariant into a UaExpandedNodeId.

Parameters:

val	a value as UaExpandedNodeId.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toExpandedNodeIdArray

(

UaExpandedNodeIdArray &

val )

const

Converts the UaVariant into a UaExpandedNodeIdArray.

Parameters:

val	a value as UaExpandedNodeIdArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toExtensionObject

(

UaExtensionObject &

val )

const

Converts the UaVariant into a UaExtensionObject.

Parameters:

val	a value as UaExtensionObject.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toExtensionObjectArray

(

UaExtensionObjectArray &

val )

const

Converts the UaVariant into an array of OpcUa_ExtensionObject.

Parameters:

val	a value as UaExtensionObjectArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toFloat

(

OpcUa_Float &

val )

const

Converts the UaVariant into a OpcUa_Float.

Parameters:

val	a value as OpcUa_Float.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toFloatArray

(

UaFloatArray &

val )

const

Converts the UaVariant into a UaFloatArray.

Parameters:

val	a value as UaFloatArray.

Returns:

the OPC UA Status code.

UaString UaVariant::toFullString

(

)

const

Converts the UaVariant into a UaString containing all information about the value. This function returns the full information of the types NodeId, ExpandedNodeId, QualifiedName and LocalizedText. All other types will return the same string as toString().

Returns:

the UaVariant as string.

OpcUa_StatusCode UaVariant::toGuid

(

UaGuid &

val )

const

Converts the UaVariant into a UaGuid.

Parameters:

val	a value as UaGuid.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toGuidArray

(

UaGuidArray &

val )

const

Converts the UaVariant into a UaGuidArray.

Parameters:

val	a value as UaGuidArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toInt16

(

OpcUa_Int16 &

val )

const

Converts the UaVariant into a OpcUa_Int16.

Parameters:

val	a value as OpcUa_Int16.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toInt16Array

(

UaInt16Array &

val )

const

Converts the UaVariant into a UaInt16Array.

Parameters:

val	a value as UaInt16Array.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toInt32

(

OpcUa_Int32 &

val )

const

Converts the UaVariant into a OpcUa_Int32.

Parameters:

val	a value as OpcUa_Int32.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toInt32Array

(

UaInt32Array &

val )

const

Converts the UaVariant into a UaInt32Array.

Parameters:

val	a value as UaInt32Array.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toInt64

(

OpcUa_Int64 &

val )

const

Converts the UaVariant into a OpcUa_Int64.

Parameters:

val	a value as OpcUa_Int64.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toInt64Array

(

UaInt64Array &

val )

const

Converts the UaVariant into a UaInt64Array.

Parameters:

val	a value as UaInt64Array.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toLocalizedText

(

UaLocalizedText &

val )

const

Converts the UaVariant into a UaLocalizedText.

Parameters:

val	a value as UaLocalizedText.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toLocalizedTextArray

(

UaLocalizedTextArray &

val )

const

Converts the UaVariant into an array of OpcUa_LocalizedText.

Parameters:

val	a value as UaLocalizedTextArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toNodeId

(

UaNodeId &

val )

const

Converts the UaVariant into a UaNodeId.

Parameters:

val	a value as UaNodeId.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toNodeIdArray

(

UaNodeIdArray &

val )

const

Converts the UaVariant into a toNodeIdArray.

Parameters:

val	a value as UaNodeIdArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toQualifiedName

(

UaQualifiedName &

val )

const

Converts the UaVariant into a UaQualifiedName.

Parameters:

val	a value as UaQualifiedName.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toQualifiedNameArray

(

UaQualifiedNameArray &

val )

const

Converts the UaVariant into a UaQualifiedNameArray.

Parameters:

val	a value as UaQualifiedNameArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toSByte

(

OpcUa_SByte &

val )

const

Converts the UaVariant into a OpcUa_SByte.

Parameters:

val	a value as OpcUa_SByte.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toSByteArray

(

UaSByteArray &

val )

const

Converts the UaVariant into a UaSByteArray.

Parameters:

val	a value as UaSByteArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toStatusCode

(

OpcUa_StatusCode &

val )

const

Converts the UaVariant into a OpcUa_StatusCode.

Parameters:

val	a value as OpcUa_StatusCode.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toStatusCodeArray

(

UaStatusCodeArray &

val )

const

Converts the UaVariant into a UaStatusCodeArray.

Parameters:

val	a value as UaStatusCodeArray.

Returns:

the OPC UA Status code.

UaString UaVariant::toString

(

)

const

Converts the UaVariant into a UaString.

Returns:

the UaVariant as string.

OpcUa_StatusCode UaVariant::toStringArray

(

UaStringArray &

val )

const

Converts the UaVariant into a UaStringArray.

Parameters:

val	a value as UaStringArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toUInt16

(

OpcUa_UInt16 &

val )

const

Converts the UaVariant into a OpcUa_UInt16.

Parameters:

val	a value as OpcUa_UInt16.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toUInt16Array

(

UaUInt16Array &

val )

const

Converts the UaVariant into a UaUInt16Array.

Parameters:

val	a value as UaUInt16Array.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toUInt32

(

OpcUa_UInt32 &

val )

const

Converts the UaVariant into a OpcUa_UInt32.

Parameters:

val	a value as OpcUa_UInt32.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toUInt32Array

(

UaUInt32Array &

val )

const

Converts the UaVariant into a UaUInt32Array.

Parameters:

val	a value as UaUInt32Array.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toUInt64

(

OpcUa_UInt64 &

val )

const

Converts the UaVariant into a OpcUa_UInt64.

Parameters:

val	a value as OpcUa_UInt64.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toUInt64Array

(

UaUInt64Array &

val )

const

Converts the UaVariant into a UaUInt64Array.

Parameters:

val	a value as UaUInt64Array.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toVariantArray

(

UaVariantArray &

val )

const

Converts the UaVariant into an array of OpcUa_Variant.

Parameters:

val	a value as UaVariantArray.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toXmlElement

(

UaByteString &

val )

const

Converts the UaVariant into a UaByteString containing the XML element.

Parameters:

val	a value as UaByteString.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaVariant::toXmlElementArray

(

UaByteStringArray &

val )

const

Converts the UaVariant into a UaByteStringArray.

Parameters:

val	a value as UaByteStringArray.

Returns:

the OPC UA Status code.

OpcUa_BuiltInType UaVariant::type

(

)

const

Get the type of the variable.

Returns:

the type of the variable.

OpcUa_StatusCode UaVariant::UaTypeToVartype	(	OpcUa_BuiltInType	uaType,
		OpcUa_Boolean	isArray,
		VARTYPE &	vt
	)		[static]

Converts a UA built in type into a Windows VARTYPE.

Returns:

UA status code indicating the result of the conversion.

Parameters:

[in]	uaType	The OPC UA built in type
[in]	isArray	Flag indicating if the value is an array
[out]	vt	The resulting Windows variant type

OpcUa_StatusCode UaVariant::VartypeToUaType	(	VARTYPE	vt,
		OpcUa_BuiltInType &	ut,
		OpcUa_Boolean &	isArray
	)		[static]

Converts a Windows VARTYPE into a UA built in type.

Returns:

UA status code indicating the result of the conversion.

Parameters:

[in]	vt	The Windows variant type
[out]	ut	The resulting OPC UA built in type
[out]	isArray	Flag indicating if the value is an array

---

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

• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uavariant.h
• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uavariant.cpp