UA Server SDK C++ Bundle  1.3.3.206
 All Data Structures Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
UaExtensionObject Class Reference

UaExtensionObject Derived from OpcUa_ExtensionObject. More...

#include <uaextensionobject.h>

Inherits OpcUa_ExtensionObject.

Public Types

enum  ExtensionObjectEncoding { None = 0, Binary = 1, Xml = 2, EncodeableObject = 3 }
 Definition of the ExtensionObjectEncoding Enumeration. More...
 

Public Member Functions

 UaExtensionObject ()
 Constructs an empty extension object.
 
 UaExtensionObject (const UaExtensionObject &other)
 Constructs an extension object with the other extension object.
 
 UaExtensionObject (const OpcUa_ExtensionObject &other)
 Constructs an extension object with the other extension object.
 
 UaExtensionObject (const UaArgument &other)
 Constructs an extension object with an Argument structure.
 
 UaExtensionObject (const UaRange &other)
 Constructs an extension object with a Range structure.
 
 UaExtensionObject (const UaEUInformation &other)
 Constructs an extension object with an EUInformation structure.
 
 UaExtensionObject (const UaModelChangeStructureDataType &other)
 Constructs an extension object with an ModelChangeStructureDataType structure.
 
 UaExtensionObject (const UaBuildInfo &other)
 Constructs an extension object with a BuildInfo structure.
 
 UaExtensionObject (const UaServerStatusDataType &other)
 Constructs an extension object with a ServerStatusDataType structure.
 
 UaExtensionObject (const UaRedundantServerDataType &other)
 Constructs an extension object with a RedundantServerDataType structure.
 
 UaExtensionObject (const UaAnnotation &other)
 Constructs an extension object with an Annotation structure.
 
 ~UaExtensionObject ()
 destruction
 
void clear ()
 Clear the data of the UaExtensionObject. More...
 
UaExtensionObjectoperator= (const UaExtensionObject &other)
 Assignment operator. More...
 
 operator const OpcUa_ExtensionObject * () const
 Return internal OpcUa_ExtensionObject structure. More...
 
OpcUa_ExtensionObject * copy () const
 Copy UaExtensionObject data to a newly allocated OpcUa_ExtensionObject. More...
 
void copyTo (OpcUa_ExtensionObject *pDst) const
 Copy UaExtensionObject data to an existing OpcUa_ExtensionObject structure. More...
 
void detach ()
 Reset OpcUa_ExtensionObject structure without clearing the data. More...
 
UaString toString () const
 Converts the UaExtensionObject into a UaString. More...
 
OpcUa_StatusCode toArgument (UaArgument &val) const
 Set a UaArgument to an argument. More...
 
OpcUa_StatusCode toRange (UaRange &val) const
 Convert a value to Range. More...
 
OpcUa_StatusCode toEUInformation (UaEUInformation &val) const
 Convert a value to EUInformation. More...
 
OpcUa_StatusCode toModelChangeStructureDataType (UaModelChangeStructureDataType &val) const
 Convert a value to ModelChangeStructureDataType. More...
 
OpcUa_StatusCode toBuildInfo (UaBuildInfo &val) const
 Convert a value to BuildInfo. More...
 
OpcUa_StatusCode toServerStatusDataType (UaServerStatusDataType &val) const
 Convert a value to ServerStatusDataType. More...
 
OpcUa_StatusCode toAnnotation (UaAnnotation &val) const
 Convert a value to Annotation. More...
 
ExtensionObjectEncoding encoding () const
 Returns the encoding of the extension object. More...
 
const OpcUa_Void * object () const
 Returns a pointer to the object as structure.
 
const OpcUa_EncodeableType * objectType () const
 Returns the encodeable type of the object as structure.
 
const OpcUa_ByteString * binary () const
 Returns the binary encoded object.
 
const OpcUa_XmlElement * xml () const
 Returns the XML encoded object.
 

Static Public Member Functions

static OpcUa_ExtensionObject * clone (const OpcUa_ExtensionObject &source)
 Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes. More...
 
static void cloneTo (const OpcUa_ExtensionObject &source, OpcUa_ExtensionObject &copy)
 Copy OpcUa_VariableTypeAttributes data to an existing OpcUa_VariableTypeAttributes structure. More...
 

Detailed Description

UaExtensionObject Derived from OpcUa_ExtensionObject.

Member Enumeration Documentation

Definition of the ExtensionObjectEncoding Enumeration.

Enumerator
None 

None

Binary 

Binary

Xml 

Xml

EncodeableObject 

EncodableObject

Member Function Documentation

void UaExtensionObject::clear ( )

Clear the data of the UaExtensionObject.

OpcUa_ExtensionObject * UaExtensionObject::clone ( const OpcUa_ExtensionObject &  source)
static

Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes.

Parameters
sourceSource to clone.
Returns
new copy.
void UaExtensionObject::cloneTo ( const OpcUa_ExtensionObject &  source,
OpcUa_ExtensionObject &  copy 
)
static

Copy OpcUa_VariableTypeAttributes data to an existing OpcUa_VariableTypeAttributes structure.

Parameters
sourceSource OpcUa_VariableTypeAttributes to clone.
copyNew copy of source OpcUa_VariableTypeAttributes.
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 existing OpcUa_ExtensionObject structure.

Parameters
pDstthe destination of this operation.
void UaExtensionObject::detach ( )

Reset OpcUa_ExtensionObject structure without clearing the data.

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.

UaExtensionObject::operator const OpcUa_ExtensionObject * ( ) const

Return internal OpcUa_ExtensionObject structure.

Returns
internal OpcUa_ExtensionObject structure.
UaExtensionObject & UaExtensionObject::operator= ( const UaExtensionObject other)

Assignment operator.

Parameters
otherthe UaExtensionObject to assign.
Returns
Assignment operator.
OpcUa_StatusCode UaExtensionObject::toAnnotation ( UaAnnotation val) const

Convert a value to Annotation.

Parameters
vala value as UaLocalizedText.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaExtensionObject::toArgument ( UaArgument val) const

Set a UaArgument to an argument.

Parameters
vala value as UaArgument.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaExtensionObject::toBuildInfo ( UaBuildInfo val) const

Convert a value to BuildInfo.

Parameters
vala value as UaLocalizedText.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaExtensionObject::toEUInformation ( UaEUInformation val) const

Convert a value to EUInformation.

Parameters
vala value as UaEUInformation.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaExtensionObject::toModelChangeStructureDataType ( UaModelChangeStructureDataType val) const

Convert a value to ModelChangeStructureDataType.

Parameters
vala value as UaModelChangeStructureDataType.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaExtensionObject::toRange ( UaRange val) const

Convert a value to Range.

Parameters
vala value as UaRange.
Returns
the OPC UA Status code.
OpcUa_StatusCode UaExtensionObject::toServerStatusDataType ( UaServerStatusDataType val) const

Convert a value to ServerStatusDataType.

Parameters
vala value as UaLocalizedText.
Returns
the OPC UA Status code.
UaString UaExtensionObject::toString ( ) const

Converts the UaExtensionObject into a UaString.

Returns
the converted UaExtensionObject.

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