UaExtensionObject Class Reference

#include <uaextensionobject.h>

List of all members.

Public Types
enum	ExtensionObjectEncoding { None = 0, Binary = 1, Xml = 2, EncodeableObject = 3 }
	Definition of the ExtensionObjectEncoding Enumeration. More...
Public Member Functions
	UaExtensionObject ()
	UaExtensionObject (const UaExtensionObject &other)
	UaExtensionObject (const OpcUa_ExtensionObject &other)
	UaExtensionObject (const UaArgument &other)
	UaExtensionObject (const UaRange &other)
	UaExtensionObject (const UaEUInformation &other)
	UaExtensionObject (const UaBuildInfo &other)
	UaExtensionObject (const UaServerStatusDataType &other)
	~UaExtensionObject ()
void	clear ()
UaExtensionObject &	operator= (const UaExtensionObject &other)
	operator const OpcUa_ExtensionObject * () const
OpcUa_ExtensionObject *	copy () const
void	copyTo (OpcUa_ExtensionObject *pDst) const
void	detach ()
UaString	toString () const
OpcUa_StatusCode	toArgument (UaArgument &val) const
OpcUa_StatusCode	toRange (UaRange &val) const
OpcUa_StatusCode	toEUInformation (UaEUInformation &val) const
OpcUa_StatusCode	toBuildInfo (UaBuildInfo &val) const
OpcUa_StatusCode	toServerStatusDataType (UaServerStatusDataType &val) const
ExtensionObjectEncoding	encoding () const
const OpcUa_Void *	object () const
const OpcUa_EncodeableType *	objectType () const
const OpcUa_ByteString *	binary () const
const OpcUa_XmlElement *	xml () const
Static Public Member Functions
static OpcUa_ExtensionObject *	clone (const OpcUa_ExtensionObject &source)
static void	cloneTo (const OpcUa_ExtensionObject &source, OpcUa_ExtensionObject &copy)

---

Detailed Description

UaExtensionObject Derived from OpcUa_ExtensionObject.

---

Member Enumeration Documentation

enum UaExtensionObject::ExtensionObjectEncoding

Definition of the ExtensionObjectEncoding Enumeration.

Enumerator:

None	None
Binary	Binary
Xml	Xml
EncodeableObject	EncodableObject

---

Constructor & Destructor Documentation

UaExtensionObject::UaExtensionObject

(

)

construction

UaExtensionObject::UaExtensionObject

(

const UaExtensionObject &

other

)

construction

Parameters:

other

the UaExtensionObject.

UaExtensionObject::UaExtensionObject

(

const OpcUa_ExtensionObject &

other

)

construction

Parameters:

other

the OpcUa_ExtensionObject.

UaExtensionObject::UaExtensionObject

(

const UaArgument &

other

)

construction

Parameters:

other

the UaArgument.

UaExtensionObject::UaExtensionObject

(

const UaRange &

other

)

construction

Parameters:

other

the UaRange.

UaExtensionObject::UaExtensionObject

(

const UaEUInformation &

other

)

construction

Parameters:

other

the UaEUInformation.

UaExtensionObject::UaExtensionObject

(

const UaBuildInfo &

other

)

construction

Parameters:

other

the UaBuildInfo.

UaExtensionObject::UaExtensionObject

(

const UaServerStatusDataType &

other

)

construction

Parameters:

other

the UaServerStatusDataType.

UaExtensionObject::~UaExtensionObject

(

)

destruction

---

Member Function Documentation

void UaExtensionObject::clear

(

)

Clear the data of the UaExtensionObject.

UaExtensionObject & UaExtensionObject::operator=

(

const UaExtensionObject &

other

)

Assignment operator.

Parameters:

other

the UaExtensionObject to assign.

Returns:

Assignment operator.

UaExtensionObject::operator const OpcUa_ExtensionObject *

(

)

const

Return internal OpcUa_ExtensionObject structure.

Returns:

internal OpcUa_ExtensionObject structure.

OpcUa_ExtensionObject * UaExtensionObject::copy

(

)

const

Copy UaExtensionObject data to a newly allocated OpcUa_ExtensionObject.

Returns:

a newly allocated OpcUa_ExtensionObject.

void UaExtensionObject::copyTo

(

OpcUa_ExtensionObject *

pDst

)

const

Copy UaExtensionObject data to an exisitng OpcUa_ExtensionObject structure.

Parameters:

pDst

the destination of this operation.

OpcUa_ExtensionObject * UaExtensionObject::clone

(

const OpcUa_ExtensionObject &

source

)

[static]

Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes..

Parameters:

source

Source to clone.

Returns:

new copy.

void UaExtensionObject::cloneTo	(	const OpcUa_ExtensionObject &	source,
		OpcUa_ExtensionObject &	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.

void UaExtensionObject::detach

(

)

Reset OpcUa_ExtensionObject structure without clearing the data.

UaString UaExtensionObject::toString

(

)

const

Converts the UaExtensionObject into a UaString.

Returns:

the converted UaExtensionObject.

OpcUa_StatusCode UaExtensionObject::toArgument

(

UaArgument &

val

)

const

Set a UaArgument to an argument.

Parameters:

val

a value as UaLocalizedText.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaExtensionObject::toRange

(

UaRange &

val

)

const

Convert a value to Range.

Parameters:

val

a value as UaLocalizedText.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaExtensionObject::toEUInformation

(

UaEUInformation &

val

)

const

Convert a value to EUInformation.

Parameters:

val

a value as UaLocalizedText.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaExtensionObject::toBuildInfo

(

UaBuildInfo &

val

)

const

Convert a value to BuildInfo.

Parameters:

val

a value as UaLocalizedText.

Returns:

the OPC UA Status code.

OpcUa_StatusCode UaExtensionObject::toServerStatusDataType

(

UaServerStatusDataType &

val

)

const

Convert a value to ServerStatusDataType.

Parameters:

val

a value as UaLocalizedText.

Returns:

the OPC UA Status code.

ExtensionObjectEncoding UaExtensionObject::encoding

(

)

const [inline]

Returns the encoding of the extension object. Based on the return value of this method, the extension object contains an object as structure, a binary encoded object or a XML encoded object.

const OpcUa_Void* UaExtensionObject::object

(

)

const [inline]

Returns a pointer to the object as structure

const OpcUa_EncodeableType* UaExtensionObject::objectType

(

)

const [inline]

Returns the encodeable type of the object as structure

const OpcUa_ByteString* UaExtensionObject::binary

(

)

const [inline]

Returns the binary encoded object

const OpcUa_XmlElement* UaExtensionObject::xml

(

)

const [inline]

Returns the XML encoded object

---

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

• src/uabase/uabasecpp/uaextensionobject.h
• src/uabase/uabasecpp/uaextensionobject.cpp