Class used for deserializing a UaByteString. More...

#include <uabinarydecoder.h>

Public Member Functions
UaStatus	create (const UaByteString &bsValue)
	Initializes the UaBinaryDecoder. More...

UaStatus	create (const UaByteString &bsValue, const UaStringArray &namespaceTable)
	Initializes a UaBinaryDecoder. More...

void	clear ()
	Clears all ressources of the UaBinaryDecoder. More...

OpcUa_StatusCode	getPosition (OpcUa_UInt32 &postion)
	Returns the current position in the data stream to decode.

OpcUa_StatusCode	setPosition (OpcUa_UInt32 postion)
	Sets the current position in the data stream to decode.

virtual void	pushNamespace (const UaString &sNamespace)
	Pushes a namespace to the namespace stack. More...

virtual void	popNamespace ()
	Pops a namespace from the namespace stack. More...

virtual OpcUa_StatusCode	readBoolean (const UaString &sFieldName, OpcUa_Boolean &rValue)
	Reads a Boolean value. More...

virtual OpcUa_StatusCode	readByteString (const UaString &sFieldName, UaByteString &rValue)
	Reads a ByteString value. More...

virtual OpcUa_StatusCode	readDataValue (const UaString &sFieldName, UaDataValue &rValue)
	Reads a DataValue value. More...

virtual OpcUa_StatusCode	readDateTime (const UaString &sFieldName, UaDateTime &rValue)
	Reads a DateTime value. More...

virtual OpcUa_StatusCode	readDiagnosticInfo (const UaString &sFieldName, UaDiagnosticInfo &rValue)
	Reads a DiagnosticInfo value. More...

virtual OpcUa_StatusCode	readExpandedNodeId (const UaString &sFieldName, UaExpandedNodeId &rValue)
	Reads an ExpandedNodeId value. More...

virtual OpcUa_StatusCode	readGuid (const UaString &sFieldName, UaGuid &rValue)
	Reads a Guid value. More...

virtual OpcUa_StatusCode	readLocalizedText (const UaString &sFieldName, UaLocalizedText &rValue)
	Reads a LocalizedText value. More...

virtual OpcUa_StatusCode	readNodeId (const UaString &sFieldName, UaNodeId &rValue)
	Reads a NodeId value. More...

virtual OpcUa_StatusCode	readDouble (const UaString &sFieldName, OpcUa_Double &rValue)
	Reads a Double value. More...

virtual OpcUa_StatusCode	readFloat (const UaString &sFieldName, OpcUa_Float &rValue)
	Reads a Float value. More...

virtual OpcUa_StatusCode	readInt16 (const UaString &sFieldName, OpcUa_Int16 &rValue)
	Reads an Int16 value. More...

virtual OpcUa_StatusCode	readInt32 (const UaString &sFieldName, OpcUa_Int32 &rValue)
	Reads an Int32 value. More...

virtual OpcUa_StatusCode	readInt64 (const UaString &sFieldName, OpcUa_Int64 &rValue)
	Reads an Int64 value. More...

virtual OpcUa_StatusCode	readSByte (const UaString &sFieldName, OpcUa_SByte &rValue)
	Reads a SByte value. More...

virtual OpcUa_StatusCode	readByte (const UaString &sFieldName, OpcUa_Byte &rValue)
	Reads a Byte value. More...

virtual OpcUa_StatusCode	readUInt16 (const UaString &sFieldName, OpcUa_UInt16 &rValue)
	Reads an UInt16 value. More...

virtual OpcUa_StatusCode	readUInt32 (const UaString &sFieldName, OpcUa_UInt32 &rValue)
	Reads an UInt32 value. More...

virtual OpcUa_StatusCode	readUInt64 (const UaString &sFieldName, OpcUa_UInt64 &rValue)
	Reads an UInt64 value. More...

virtual OpcUa_StatusCode	readQualifiedName (const UaString &sFieldName, UaQualifiedName &rValue)
	Reads a QualifiedName value. More...

virtual OpcUa_StatusCode	readStatusCode (const UaString &sFieldName, UaStatusCode &rValue)
	Reads a StatusCode value. More...

virtual OpcUa_StatusCode	readString (const UaString &sFieldName, UaString &rValue)
	Reads a String value. More...

virtual OpcUa_StatusCode	readVariant (const UaString &sFieldName, UaVariant &rValue)
	Reads a Variant value. More...

virtual OpcUa_StatusCode	readExtensionObject (const UaString &sFieldName, UaExtensionObject &rValue)
	Reads an ExtensionObject value. More...

virtual OpcUa_StatusCode	readGenericValue (const UaString &sFieldName, UaGenericStructureValue &rValue)
	Reads a GenericValue value. More...

virtual OpcUa_StatusCode	readGenericUnion (const UaString &sFieldName, UaGenericUnionValue &rValue)
	Reads a GenericUnion value. More...

virtual OpcUa_StatusCode	readGenericOptionSet (const UaString &sFieldName, UaGenericOptionSetValue &rValue)
	Reads a GenericOptionSet value. More...

virtual OpcUa_StatusCode	readXmlElement (const UaString &sFieldName, UaByteString &rValue)
	Reads an XmlElement value. More...

virtual OpcUa_StatusCode	readBooleanArray (const UaString &sFieldName, UaBooleanArray &rValue)
	Reads an array of Boolean values. More...

virtual OpcUa_StatusCode	readByteStringArray (const UaString &sFieldName, UaByteStringArray &rValue)
	Reads an array of ByteString values. More...

virtual OpcUa_StatusCode	readDataValueArray (const UaString &sFieldName, UaDataValues &rValue)
	Reads an array of DataValue values. More...

virtual OpcUa_StatusCode	readDateTimeArray (const UaString &sFieldName, UaDateTimeArray &rValue)
	Reads an array of DateTime values. More...

virtual OpcUa_StatusCode	readDiagnosticInfoArray (const UaString &sFieldName, UaDiagnosticInfos &rValue)
	Reads an array of DiagnosticInfo values. More...

virtual OpcUa_StatusCode	readExpandedNodeIdArray (const UaString &sFieldName, UaExpandedNodeIdArray &rValue)
	Reads an array of NodeId values. More...

virtual OpcUa_StatusCode	readGuidArray (const UaString &sFieldName, UaGuidArray &rValue)
	Reads an array of Guid values. More...

virtual OpcUa_StatusCode	readLocalizedTextArray (const UaString &sFieldName, UaLocalizedTextArray &rValue)
	Reads an array of LocalizedText values. More...

virtual OpcUa_StatusCode	readNodeIdArray (const UaString &sFieldName, UaNodeIdArray &rValue)
	Reads an array of NodeId values. More...

virtual OpcUa_StatusCode	readDoubleArray (const UaString &sFieldName, UaDoubleArray &rValue)
	Reads an array of Double values. More...

virtual OpcUa_StatusCode	readFloatArray (const UaString &sFieldName, UaFloatArray &rValue)
	Reads an array of Float values. More...

virtual OpcUa_StatusCode	readInt16Array (const UaString &sFieldName, UaInt16Array &rValue)
	Reads an array of Int16 values. More...

virtual OpcUa_StatusCode	readInt32Array (const UaString &sFieldName, UaInt32Array &rValue)
	Reads an array of Int32 values. More...

virtual OpcUa_StatusCode	readInt64Array (const UaString &sFieldName, UaInt64Array &rValue)
	Reads an array of Int64 values. More...

virtual OpcUa_StatusCode	readSByteArray (const UaString &sFieldName, UaSByteArray &rValue)
	Reads an array of SByte values. More...

virtual OpcUa_StatusCode	readByteArray (const UaString &sFieldName, UaByteArray &rValue)
	Reads an array of Byte values. More...

virtual OpcUa_StatusCode	readUInt16Array (const UaString &sFieldName, UaUInt16Array &rValue)
	Reads an array of UInt16 values. More...

virtual OpcUa_StatusCode	readUInt32Array (const UaString &sFieldName, UaUInt32Array &rValue)
	Reads an array of UInt32 values. More...

virtual OpcUa_StatusCode	readUInt64Array (const UaString &sFieldName, UaUInt64Array &rValue)
	Reads an array of UInt64 values. More...

virtual OpcUa_StatusCode	readQualifiedNameArray (const UaString &sFieldName, UaQualifiedNameArray &rValue)
	Reads an array of QualifiedName values. More...

virtual OpcUa_StatusCode	readStatusCodeArray (const UaString &sFieldName, UaStatusCodeArray &rValue)
	Reads an array of StatusCode values. More...

virtual OpcUa_StatusCode	readStringArray (const UaString &sFieldName, UaStringArray &rValue)
	Reads an array of String values. More...

virtual OpcUa_StatusCode	readVariantArray (const UaString &sFieldName, UaVariantArray &rValue)
	Reads an array of Variant values. More...

virtual OpcUa_StatusCode	readExtensionObjectArray (const UaString &sFieldName, UaExtensionObjectArray &rValue)
	Reads an array of ExtensionObject values. More...

virtual OpcUa_StatusCode	readGenericValueArray (const UaString &sFieldName, std::vector< UaGenericStructureValue > &rValue, UaStructureDefinition structureDefinition)
	Deprecated: Reads an array of GenericValue values. More...

virtual OpcUa_StatusCode	readGenericValueArray (const UaString &sFieldName, UaGenericStructureArray &rValue)
	Reads an array of GenericValue values. More...

virtual OpcUa_StatusCode	readGenericUnionArray (const UaString &sFieldName, UaGenericUnionArray &rValue)
	Reads an array of GenericUnion values. More...

virtual OpcUa_StatusCode	readGenericOptionSetArray (const UaString &sFieldName, UaGenericOptionSetArray &rValue)
	Reads an array of GenericOptionSet values. More...

virtual OpcUa_StatusCode	readXmlElementArray (const UaString &sFieldName, UaByteStringArray &rValue)
	Reads an array of XmlElement values. More...

virtual UaEncoderType	decoderType () const
	Returns the type of the decoder - Binary or Xml.

Detailed Description

Class used for deserializing a UaByteString.

This class is typically used to deserialze Data to a UaGenericStructureValue or UaGenericUnionValue.

Member Function Documentation

void UaBinaryDecoder::clear ( )

Clears all ressources of the UaBinaryDecoder.

Is called by the destructor of this class.

UaStatus UaBinaryDecoder::create ( const UaByteString & bsValue )

Initializes the UaBinaryDecoder.

Uses the NamespaceTable from the UaStack.

Parameters

bsValue The UaByteString containing the serialized data. Use this overload when calling this method on the UA Server side.

UaStatus UaBinaryDecoder::create	(	const UaByteString &	bsValue,
		const UaStringArray &	namespaceTable
	)

Initializes a UaBinaryDecoder.

Uses the NamespaceTable provided as argument.

Parameters

bsValue	The UaByteString containing the serialized data.
namespaceTable	The NamespaceTable containing the serialized data. Use this overload when calling this method on the UA Client side. Pass in the NamespaceTable provided by UaClientSdk::UaSession.

void UaBinaryDecoder::popNamespace ( )

virtual

Pops a namespace from the namespace stack.

Has to be called after reading a structured or an enumerated DataType.

Implements UaAbstractDecoder.

void UaBinaryDecoder::pushNamespace ( const UaString & sNamespace )

virtual

Pushes a namespace to the namespace stack.

The NamespaceUri of a structured or an enumerated DataType has to be pushed before reading it.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readBoolean	(	const UaString &	sFieldName,
		OpcUa_Boolean &	rValue
	)

virtual

Reads a Boolean value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readBooleanArray	(	const UaString &	sFieldName,
		UaBooleanArray &	rValue
	)

virtual

Reads an array of Boolean values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readByte	(	const UaString &	sFieldName,
		OpcUa_Byte &	rValue
	)

virtual

Reads a Byte value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readByteArray	(	const UaString &	sFieldName,
		UaByteArray &	rValue
	)

virtual

Reads an array of Byte values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readByteString	(	const UaString &	sFieldName,
		UaByteString &	rValue
	)

virtual

Reads a ByteString value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readByteStringArray	(	const UaString &	sFieldName,
		UaByteStringArray &	rValue
	)

virtual

Reads an array of ByteString values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readDataValue	(	const UaString &	sFieldName,
		UaDataValue &	rValue
	)

virtual

Reads a DataValue value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readDataValueArray	(	const UaString &	sFieldName,
		UaDataValues &	rValue
	)

virtual

Reads an array of DataValue values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readDateTime	(	const UaString &	sFieldName,
		UaDateTime &	rValue
	)

virtual

Reads a DateTime value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readDateTimeArray	(	const UaString &	sFieldName,
		UaDateTimeArray &	rValue
	)

virtual

Reads an array of DateTime values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readDiagnosticInfo	(	const UaString &	sFieldName,
		UaDiagnosticInfo &	rValue
	)

virtual

Reads a DiagnosticInfo value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readDiagnosticInfoArray	(	const UaString &	sFieldName,
		UaDiagnosticInfos &	rValue
	)

virtual

Reads an array of DiagnosticInfo values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readDouble	(	const UaString &	sFieldName,
		OpcUa_Double &	rValue
	)

virtual

Reads a Double value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readDoubleArray	(	const UaString &	sFieldName,
		UaDoubleArray &	rValue
	)

virtual

Reads an array of Double values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readExpandedNodeId	(	const UaString &	sFieldName,
		UaExpandedNodeId &	rValue
	)

virtual

Reads an ExpandedNodeId value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readExpandedNodeIdArray	(	const UaString &	sFieldName,
		UaExpandedNodeIdArray &	rValue
	)

virtual

Reads an array of NodeId values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readExtensionObject	(	const UaString &	sFieldName,
		UaExtensionObject &	rValue
	)

virtual

Reads an ExtensionObject value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readExtensionObjectArray	(	const UaString &	sFieldName,
		UaExtensionObjectArray &	rValue
	)

virtual

Reads an array of ExtensionObject values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readFloat	(	const UaString &	sFieldName,
		OpcUa_Float &	rValue
	)

virtual

Reads a Float value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readFloatArray	(	const UaString &	sFieldName,
		UaFloatArray &	rValue
	)

virtual

Reads an array of Float values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readGenericOptionSet	(	const UaString &	sFieldName,
		UaGenericOptionSetValue &	rValue
	)

virtual

Reads a GenericOptionSet value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readGenericOptionSetArray	(	const UaString &	sFieldName,
		UaGenericOptionSetArray &	rValue
	)

virtual

Reads an array of GenericOptionSet values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readGenericUnion	(	const UaString &	sFieldName,
		UaGenericUnionValue &	rValue
	)

virtual

Reads a GenericUnion value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readGenericUnionArray	(	const UaString &	sFieldName,
		UaGenericUnionArray &	rValue
	)

virtual

Reads an array of GenericUnion values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readGenericValue	(	const UaString &	sFieldName,
		UaGenericStructureValue &	rValue
	)

virtual

Reads a GenericValue value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readGenericValueArray	(	const UaString &	sFieldName,
		std::vector< UaGenericStructureValue > &	rValue,
		UaStructureDefinition	structureDefinition
	)

virtual

Deprecated: Reads an array of GenericValue values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readGenericValueArray	(	const UaString &	sFieldName,
		UaGenericStructureArray &	rValue
	)

virtual

Reads an array of GenericValue values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readGuid	(	const UaString &	sFieldName,
		UaGuid &	rValue
	)

virtual

Reads a Guid value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readGuidArray	(	const UaString &	sFieldName,
		UaGuidArray &	rValue
	)

virtual

Reads an array of Guid values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readInt16	(	const UaString &	sFieldName,
		OpcUa_Int16 &	rValue
	)

virtual

Reads an Int16 value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readInt16Array	(	const UaString &	sFieldName,
		UaInt16Array &	rValue
	)

virtual

Reads an array of Int16 values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readInt32	(	const UaString &	sFieldName,
		OpcUa_Int32 &	rValue
	)

virtual

Reads an Int32 value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readInt32Array	(	const UaString &	sFieldName,
		UaInt32Array &	rValue
	)

virtual

Reads an array of Int32 values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readInt64	(	const UaString &	sFieldName,
		OpcUa_Int64 &	rValue
	)

virtual

Reads an Int64 value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readInt64Array	(	const UaString &	sFieldName,
		UaInt64Array &	rValue
	)

virtual

Reads an array of Int64 values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readLocalizedText	(	const UaString &	sFieldName,
		UaLocalizedText &	rValue
	)

virtual

Reads a LocalizedText value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readLocalizedTextArray	(	const UaString &	sFieldName,
		UaLocalizedTextArray &	rValue
	)

virtual

Reads an array of LocalizedText values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readNodeId	(	const UaString &	sFieldName,
		UaNodeId &	rValue
	)

virtual

Reads a NodeId value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readNodeIdArray	(	const UaString &	sFieldName,
		UaNodeIdArray &	rValue
	)

virtual

Reads an array of NodeId values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readQualifiedName	(	const UaString &	sFieldName,
		UaQualifiedName &	rValue
	)

virtual

Reads a QualifiedName value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readQualifiedNameArray	(	const UaString &	sFieldName,
		UaQualifiedNameArray &	rValue
	)

virtual

Reads an array of QualifiedName values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readSByte	(	const UaString &	sFieldName,
		OpcUa_SByte &	rValue
	)

virtual

Reads a SByte value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readSByteArray	(	const UaString &	sFieldName,
		UaSByteArray &	rValue
	)

virtual

Reads an array of SByte values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readStatusCode	(	const UaString &	sFieldName,
		UaStatusCode &	rValue
	)

virtual

Reads a StatusCode value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readStatusCodeArray	(	const UaString &	sFieldName,
		UaStatusCodeArray &	rValue
	)

virtual

Reads an array of StatusCode values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readString	(	const UaString &	sFieldName,
		UaString &	rValue
	)

virtual

Reads a String value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readStringArray	(	const UaString &	sFieldName,
		UaStringArray &	rValue
	)

virtual

Reads an array of String values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readUInt16	(	const UaString &	sFieldName,
		OpcUa_UInt16 &	rValue
	)

virtual

Reads an UInt16 value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readUInt16Array	(	const UaString &	sFieldName,
		UaUInt16Array &	rValue
	)

virtual

Reads an array of UInt16 values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readUInt32	(	const UaString &	sFieldName,
		OpcUa_UInt32 &	rValue
	)

virtual

Reads an UInt32 value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readUInt32Array	(	const UaString &	sFieldName,
		UaUInt32Array &	rValue
	)

virtual

Reads an array of UInt32 values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readUInt64	(	const UaString &	sFieldName,
		OpcUa_UInt64 &	rValue
	)

virtual

Reads an UInt64 value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readUInt64Array	(	const UaString &	sFieldName,
		UaUInt64Array &	rValue
	)

virtual

Reads an array of UInt64 values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readVariant	(	const UaString &	sFieldName,
		UaVariant &	rValue
	)

virtual

Reads a Variant value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readVariantArray	(	const UaString &	sFieldName,
		UaVariantArray &	rValue
	)

virtual

Reads an array of Variant values.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readXmlElement	(	const UaString &	sFieldName,
		UaByteString &	rValue
	)

virtual

Reads an XmlElement value.

Implements UaAbstractDecoder.

OpcUa_StatusCode UaBinaryDecoder::readXmlElementArray	(	const UaString &	sFieldName,
		UaByteStringArray &	rValue
	)

virtual

Reads an array of XmlElement values.

Implements UaAbstractDecoder.

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

C:/work/uasdkcpp/src/uabase/uabasecpp/uabinarydecoder.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uabinarydecoder.cpp

Public Member Functions

Detailed Description

Member Function Documentation