util_variant.h File Reference

#include "sopc_types.h"

Go to the source code of this file.

Functions
SOPC_Variant *	util_variant__new_Variant_from_NodeId (SOPC_NodeId *pnid, bool deepCopy)
SOPC_Variant *	util_variant__new_Variant_from_NodeClass (OpcUa_NodeClass ncl)
SOPC_Variant *	util_variant__new_Variant_from_QualifiedName (SOPC_QualifiedName *qn, bool deepCopy)
SOPC_Variant *	util_variant__new_Variant_from_LocalizedText (SOPC_LocalizedText *lt, bool deepCopy)
SOPC_Variant *	util_variant__set_PreferredLocalizedText_from_LocalizedText_Variant (SOPC_Variant **v, char **preferredLocales)
bool	util_variant__copy_PreferredLocalizedText_from_LocalizedText_Variant (SOPC_Variant *dest, const SOPC_Variant *src, char **preferredLocales)
SOPC_Variant *	util_variant__new_Variant_from_Indet (void)
SOPC_Variant *	util_variant__new_Variant_from_Variant (const SOPC_Variant *pvara, bool deepCopy)
SOPC_Variant *	util_variant__new_Variant_from_Bool (bool b)
SOPC_Variant *	util_variant__new_Variant_from_Byte (uint8_t i)
SOPC_Variant *	util_variant__new_Variant_from_uint32 (uint32_t i)
SOPC_Variant *	util_variant__new_Variant_from_int64 (int64_t i)
SOPC_Variant *	util_variant__new_Variant_from_int32 (int32_t i)
SOPC_Variant *	util_variant__new_Variant_from_double (double f)
SOPC_Variant *	util_variant__new_Variant_from_ByteString (SOPC_ByteString *bs, bool deepCopy)
SOPC_Variant *	util_variant__new_Variant_from_ExtensionObject (SOPC_ExtensionObject *extObj, bool deepCopy)
SOPC_ReturnStatus	util_variant__copy_and_apply_locales_and_index_range (SOPC_Variant *destVal, const SOPC_Variant *source, char **preferredLocalesIds, const SOPC_NumericRange *indexRange)

Detailed Description

Utils to produce some Variants from built-in types: int, float, strings...

Function Documentation

util_variant__new_Variant_from_NodeId()

SOPC_Variant * util_variant__new_Variant_from_NodeId	(	SOPC_NodeId *	pnid,
		bool	deepCopy )

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__new_Variant_from_NodeClass()

SOPC_Variant * util_variant__new_Variant_from_NodeClass

(

OpcUa_NodeClass

ncl

)

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__new_Variant_from_QualifiedName()

SOPC_Variant * util_variant__new_Variant_from_QualifiedName	(	SOPC_QualifiedName *	qn,
		bool	deepCopy )

util_variant__new_Variant_from_LocalizedText()

SOPC_Variant * util_variant__new_Variant_from_LocalizedText	(	SOPC_LocalizedText *	lt,
		bool	deepCopy )

util_variant__set_PreferredLocalizedText_from_LocalizedText_Variant()

SOPC_Variant * util_variant__set_PreferredLocalizedText_from_LocalizedText_Variant	(	SOPC_Variant **	v,
		char **	preferredLocales )

The input variant is returned as result or is freed if the output variant is a new structure

util_variant__copy_PreferredLocalizedText_from_LocalizedText_Variant()

bool util_variant__copy_PreferredLocalizedText_from_LocalizedText_Variant	(	SOPC_Variant *	dest,
		const SOPC_Variant *	src,
		char **	preferredLocales )

util_variant__new_Variant_from_Indet()

SOPC_Variant * util_variant__new_Variant_from_Indet

(

void

)

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__new_Variant_from_Variant()

SOPC_Variant * util_variant__new_Variant_from_Variant	(	const SOPC_Variant *	pvara,
		bool	deepCopy )

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__new_Variant_from_Bool()

SOPC_Variant * util_variant__new_Variant_from_Bool

(

bool

b

)

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__new_Variant_from_Byte()

SOPC_Variant * util_variant__new_Variant_from_Byte

(

uint8_t

i

)

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__new_Variant_from_uint32()

SOPC_Variant * util_variant__new_Variant_from_uint32

(

uint32_t

i

)

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__new_Variant_from_int64()

SOPC_Variant * util_variant__new_Variant_from_int64

(

int64_t

i

)

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__new_Variant_from_int32()

SOPC_Variant * util_variant__new_Variant_from_int32

(

int32_t

i

)

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__new_Variant_from_double()

SOPC_Variant * util_variant__new_Variant_from_double

(

double

f

)

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__new_Variant_from_ByteString()

SOPC_Variant * util_variant__new_Variant_from_ByteString	(	SOPC_ByteString *	bs,
		bool	deepCopy )

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__new_Variant_from_ExtensionObject()

SOPC_Variant * util_variant__new_Variant_from_ExtensionObject	(	SOPC_ExtensionObject *	extObj,
		bool	deepCopy )

The returned Variant is allocated and shall be deleted (or freed + cleared) by consumer

util_variant__copy_and_apply_locales_and_index_range()

SOPC_ReturnStatus util_variant__copy_and_apply_locales_and_index_range	(	SOPC_Variant *	destVal,
		const SOPC_Variant *	source,
		char **	preferredLocalesIds,
		const SOPC_NumericRange *	indexRange )

The source variant content is copied into dest applying:

• the preferred LocalIds if defined and source is a LocalizedText value
• the index range if defined and applicable to source value

Note: in case an error occurred, the dest value is cleared abd set to a StatusCode value indicating the error.

The returned status is either SOPC_STATUS_OK when dest value has been set from source value successfully, otherwise the dest value has been set to an OPC UA Bad status indicating the error that occured.