UaBinaryEncoder Class Reference

Class used to serialize Data to a UaByteString. More...

#include <uabinaryencoder.h>

Inherits UaAbstractEncoder.

Public Member Functions
	UaBinaryEncoder ()
	Construction. More...
UaStatus	create (OpcUa_UInt32 blockSize=0)
	Initializes the UaBinaryEncoder. More...
UaStatus	create (const UaStringArray &namespaceTable, OpcUa_UInt32 blockSize=0)
	Initializes the UaBinaryEncoder. More...
void	clear ()
	Frees the stack resources.
UaStatus	getBuffer (UaByteString &buffer)
	Retrieve the internal buffer with the encoded data. 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	writeBoolean (const UaString &sFieldName, OpcUa_Boolean value)
	Writes a Boolean value. More...
virtual OpcUa_StatusCode	writeByteString (const UaString &sFieldName, const UaByteString &value)
	Writes a ByteString value. More...
virtual OpcUa_StatusCode	writeDataValue (const UaString &sFieldName, const UaDataValue &value)
	Writes a DataValue value. More...
virtual OpcUa_StatusCode	writeDateTime (const UaString &sFieldName, const UaDateTime &value)
	Writes a DateTime value. More...
virtual OpcUa_StatusCode	writeDiagnosticInfo (const UaString &sFieldName, const UaDiagnosticInfo &value)
	Writes a DiagnosticInfo value. More...
virtual OpcUa_StatusCode	writeExpandedNodeId (const UaString &sFieldName, const UaExpandedNodeId &value)
	Writes an ExpandedNodeId value. More...
virtual OpcUa_StatusCode	writeGuid (const UaString &sFieldName, const UaGuid &value)
	Writes a Guid value. More...
virtual OpcUa_StatusCode	writeLocalizedText (const UaString &sFieldName, const UaLocalizedText &value)
	Writes a LocalizedText value. More...
virtual OpcUa_StatusCode	writeNodeId (const UaString &sFieldName, const UaNodeId &value)
	Writes a NodeId value. More...
virtual OpcUa_StatusCode	writeDouble (const UaString &sFieldName, OpcUa_Double value)
	Writes a Double value. More...
virtual OpcUa_StatusCode	writeFloat (const UaString &sFieldName, OpcUa_Float value)
	Writes a Float value. More...
virtual OpcUa_StatusCode	writeInt16 (const UaString &sFieldName, OpcUa_Int16 value)
	Writes an Int16 value. More...
virtual OpcUa_StatusCode	writeInt32 (const UaString &sFieldName, OpcUa_Int32 value)
	Writes an Int32 value. More...
virtual OpcUa_StatusCode	writeInt64 (const UaString &sFieldName, OpcUa_Int64 value)
	Writes an Int64 value. More...
virtual OpcUa_StatusCode	writeSByte (const UaString &sFieldName, OpcUa_SByte value)
	Writes an SByte value. More...
virtual OpcUa_StatusCode	writeByte (const UaString &sFieldName, OpcUa_Byte value)
	Writes a Byte value. More...
virtual OpcUa_StatusCode	writeUInt16 (const UaString &sFieldName, OpcUa_UInt16 value)
	Writes a UInt16 value. More...
virtual OpcUa_StatusCode	writeUInt32 (const UaString &sFieldName, OpcUa_UInt32 value)
	Writes a UInt32 value. More...
virtual OpcUa_StatusCode	writeUInt64 (const UaString &sFieldName, OpcUa_UInt64 valueu)
	Writes a UInt64 value. More...
virtual OpcUa_StatusCode	writeQualifiedName (const UaString &sFieldName, const UaQualifiedName &value)
	Writes a QualifiedName value. More...
virtual OpcUa_StatusCode	writeStatusCode (const UaString &sFieldName, const UaStatusCode &value)
	Writes a StatusCode value. More...
virtual OpcUa_StatusCode	writeString (const UaString &sFieldName, const UaString &value)
	Writes a Boolean value. More...
virtual OpcUa_StatusCode	writeVariant (const UaString &sFieldName, const UaVariant &value)
	Writes a Variant value. More...
virtual OpcUa_StatusCode	writeExtensionObject (const UaString &sFieldName, const UaExtensionObject &value)
	Writes an ExtensionObject value. More...
virtual OpcUa_StatusCode	writeGenericValue (const UaString &sFieldName, const UaGenericStructureValue &value)
	Writes a GenericValue value. More...
virtual OpcUa_StatusCode	writeGenericUnion (const UaString &sFieldName, const UaGenericUnionValue &value)
	Writes a GenericUnion value. More...
virtual OpcUa_StatusCode	writeGenericOptionSet (const UaString &sFieldName, const UaGenericOptionSetValue &value)
	Writes a GenericOptionSet value. More...
virtual OpcUa_StatusCode	writeXmlElement (const UaString &sFieldName, const UaByteString &value)
	Writes an XmlElement value. More...
virtual OpcUa_StatusCode	writeBooleanArray (const UaString &sFieldName, const UaBooleanArray &value)
	Writes an array of Boolean values. More...
virtual OpcUa_StatusCode	writeByteStringArray (const UaString &sFieldName, const UaByteStringArray &value)
	Writes an array of ByteString values. More...
virtual OpcUa_StatusCode	writeDataValueArray (const UaString &sFieldName, const UaDataValues &value)
	Writes an array of DataValue values. More...
virtual OpcUa_StatusCode	writeDateTimeArray (const UaString &sFieldName, const UaDateTimeArray &value)
	Writes an array of DateTime values. More...
virtual OpcUa_StatusCode	writeDiagnosticInfoArray (const UaString &sFieldName, const UaDiagnosticInfos &value)
	Writes an array of DiagnosticInfo values. More...
virtual OpcUa_StatusCode	writeExpandedNodeIdArray (const UaString &sFieldName, const UaExpandedNodeIdArray &value)
	Writes an array of ExpandedNodeId values. More...
virtual OpcUa_StatusCode	writeGuidArray (const UaString &sFieldName, const UaGuidArray &value)
	Writes an array of Guid values. More...
virtual OpcUa_StatusCode	writeLocalizedTextArray (const UaString &sFieldName, const UaLocalizedTextArray &value)
	Writes an array of LocalizedText values. More...
virtual OpcUa_StatusCode	writeNodeIdArray (const UaString &sFieldName, const UaNodeIdArray &value)
	Writes an array of NodeId values. More...
virtual OpcUa_StatusCode	writeDoubleArray (const UaString &sFieldName, const UaDoubleArray &value)
	Writes an array of Double values. More...
virtual OpcUa_StatusCode	writeFloatArray (const UaString &sFieldName, const UaFloatArray &value)
	Writes an array of Float values. More...
virtual OpcUa_StatusCode	writeInt16Array (const UaString &sFieldName, const UaInt16Array &value)
	Writes an array of Int16 values. More...
virtual OpcUa_StatusCode	writeInt32Array (const UaString &sFieldName, const UaInt32Array &value)
	Writes an array of Int32 values. More...
virtual OpcUa_StatusCode	writeInt64Array (const UaString &sFieldName, const UaInt64Array &value)
	Writes an array of Int64 values. More...
virtual OpcUa_StatusCode	writeSByteArray (const UaString &sFieldName, const UaSByteArray &value)
	Writes an array of SByte values. More...
virtual OpcUa_StatusCode	writeByteArray (const UaString &sFieldName, const UaByteArray &value)
	Writes an array of Byte values. More...
virtual OpcUa_StatusCode	writeUInt16Array (const UaString &sFieldName, const UaUInt16Array &value)
	Writes an array of UInt16 values. More...
virtual OpcUa_StatusCode	writeUInt32Array (const UaString &sFieldName, const UaUInt32Array &value)
	Writes an array of UInt32 values. More...
virtual OpcUa_StatusCode	writeUInt64Array (const UaString &sFieldName, const UaUInt64Array &value)
	Writes an array of UInt64 values. More...
virtual OpcUa_StatusCode	writeQualifiedNameArray (const UaString &sFieldName, const UaQualifiedNameArray &value)
	Writes an array of QualifiedName values. More...
virtual OpcUa_StatusCode	writeStatusCodeArray (const UaString &sFieldName, const UaStatusCodeArray &value)
	Writes an array of StatusCode values. More...
virtual OpcUa_StatusCode	writeStringArray (const UaString &sFieldName, const UaStringArray &value)
	Writes an array of String values. More...
virtual OpcUa_StatusCode	writeVariantArray (const UaString &sFieldName, const UaVariantArray &value)
	Writes an array of Variant values. More...
virtual OpcUa_StatusCode	writeExtensionObjectArray (const UaString &sFieldName, const UaExtensionObjectArray &value)
	Writes an array of ExtensionObject values. More...
virtual OpcUa_StatusCode	writeGenericValueArray (const UaString &sFieldName, const std::vector< UaGenericStructureValue > &value)
	Deprecated: Writes an array of GenericValue values. More...
virtual OpcUa_StatusCode	writeGenericValueArray (const UaString &sFieldName, const UaGenericStructureArray &value)
	Writes an array of GenericValue values. More...
virtual OpcUa_StatusCode	writeGenericUnionArray (const UaString &sFieldName, const UaGenericUnionArray &value)
	Writes an array of GenericUnion values. More...
virtual OpcUa_StatusCode	writeGenericOptionSetArray (const UaString &sFieldName, const UaGenericOptionSetArray &value)
	Writes an array of GenericOptionSet values. More...
virtual OpcUa_StatusCode	writeXmlElementArray (const UaString &sFieldName, const UaByteStringArray &value)
	Writes an array of XmlElement values. More...
virtual UaEncoderType	encoderType () const
	Returns the type of the encoder - Binary or Xml.

Detailed Description

Class used to serialize Data to a UaByteString.

Constructor & Destructor Documentation

UaBinaryEncoder::UaBinaryEncoder

(

)

Construction.

Before calling write<TypeName> methods, create has to be called.

Member Function Documentation

UaStatus UaBinaryEncoder::create

(

OpcUa_UInt32

blockSize = 0

)

Initializes the UaBinaryEncoder.

Uses the NamespaceTable from the UaStack. Use this overload when calling this method on the UA Server side. To get the encoded buffer call getBuffer before clear.

Parameters

blockSize

The allocation block size.

UaStatus UaBinaryEncoder::create	(	const UaStringArray &	namespaceTable,
		OpcUa_UInt32	blockSize = 0
	)

Initializes the UaBinaryEncoder.

Uses the NamespaceTable provided as argument. Use this overload when calling this method on the UA Client side. Pass in the NamespaceTable provided by UaClientSdk::UaSession. To get the encoded buffer call getBuffer before clear.

Parameters

namespaceTable	The table of namespace URIs used by the server.
blockSize	The allocation block size.

UaStatus UaBinaryEncoder::getBuffer

(

UaByteString &

retbuffer

)

Retrieve the internal buffer with the encoded data.

Parameters

[in]

retbuffer

The UaByteString where to put the encoed data

Returns

The result status of the operation

void UaBinaryEncoder::popNamespace ( )

virtual

Pops a namespace from the namespace stack.

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

Implements UaAbstractEncoder.

void UaBinaryEncoder::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 writing it.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeBoolean ( const UaString &  sFieldName, OpcUa_Boolean  value  )

virtual

Writes a Boolean value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeBooleanArray ( const UaString &  sFieldName, const UaBooleanArray &  value  )

virtual

Writes an array of Boolean values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeByte ( const UaString &  sFieldName, OpcUa_Byte  value  )

virtual

Writes a Byte value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeByteArray ( const UaString &  sFieldName, const UaByteArray &  value  )

virtual

Writes an array of Byte values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeByteString ( const UaString &  sFieldName, const UaByteString &  value  )

virtual

Writes a ByteString value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeByteStringArray ( const UaString &  sFieldName, const UaByteStringArray &  value  )

virtual

Writes an array of ByteString values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeDataValue ( const UaString &  sFieldName, const UaDataValue &  value  )

virtual

Writes a DataValue value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeDataValueArray ( const UaString &  sFieldName, const UaDataValues &  value  )

virtual

Writes an array of DataValue values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeDateTime ( const UaString &  sFieldName, const UaDateTime &  value  )

virtual

Writes a DateTime value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeDateTimeArray ( const UaString &  sFieldName, const UaDateTimeArray &  value  )

virtual

Writes an array of DateTime values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeDiagnosticInfo ( const UaString &  sFieldName, const UaDiagnosticInfo &  value  )

virtual

Writes a DiagnosticInfo value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeDiagnosticInfoArray ( const UaString &  sFieldName, const UaDiagnosticInfos &  value  )

virtual

Writes an array of DiagnosticInfo values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeDouble ( const UaString &  sFieldName, OpcUa_Double  value  )

virtual

Writes a Double value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeDoubleArray ( const UaString &  sFieldName, const UaDoubleArray &  value  )

virtual

Writes an array of Double values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeExpandedNodeId ( const UaString &  sFieldName, const UaExpandedNodeId &  value  )

virtual

Writes an ExpandedNodeId value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeExpandedNodeIdArray ( const UaString &  sFieldName, const UaExpandedNodeIdArray &  value  )

virtual

Writes an array of ExpandedNodeId values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeExtensionObject ( const UaString &  sFieldName, const UaExtensionObject &  value  )

virtual

Writes an ExtensionObject value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeExtensionObjectArray ( const UaString &  sFieldName, const UaExtensionObjectArray &  value  )

virtual

Writes an array of ExtensionObject values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeFloat ( const UaString &  sFieldName, OpcUa_Float  value  )

virtual

Writes a Float value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeFloatArray ( const UaString &  sFieldName, const UaFloatArray &  value  )

virtual

Writes an array of Float values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeGenericOptionSet ( const UaString &  sFieldName, const UaGenericOptionSetValue &  value  )

virtual

Writes a GenericOptionSet value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeGenericOptionSetArray ( const UaString &  sFieldName, const UaGenericOptionSetArray &  value  )

virtual

Writes an array of GenericOptionSet values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeGenericUnion ( const UaString &  sFieldName, const UaGenericUnionValue &  value  )

virtual

Writes a GenericUnion value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeGenericUnionArray ( const UaString &  sFieldName, const UaGenericUnionArray &  value  )

virtual

Writes an array of GenericUnion values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeGenericValue ( const UaString &  sFieldName, const UaGenericStructureValue &  value  )

virtual

Writes a GenericValue value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeGenericValueArray ( const UaString &  sFieldName, const std::vector< UaGenericStructureValue > &  value  )

virtual

Deprecated: Writes an array of GenericValue values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeGenericValueArray ( const UaString &  sFieldName, const UaGenericStructureArray &  value  )

virtual

Writes an array of GenericValue values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeGuid ( const UaString &  sFieldName, const UaGuid &  value  )

virtual

Writes a Guid value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeGuidArray ( const UaString &  sFieldName, const UaGuidArray &  value  )

virtual

Writes an array of Guid values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeInt16 ( const UaString &  sFieldName, OpcUa_Int16  value  )

virtual

Writes an Int16 value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeInt16Array ( const UaString &  sFieldName, const UaInt16Array &  value  )

virtual

Writes an array of Int16 values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeInt32 ( const UaString &  sFieldName, OpcUa_Int32  value  )

virtual

Writes an Int32 value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeInt32Array ( const UaString &  sFieldName, const UaInt32Array &  value  )

virtual

Writes an array of Int32 values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeInt64 ( const UaString &  sFieldName, OpcUa_Int64  value  )

virtual

Writes an Int64 value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeInt64Array ( const UaString &  sFieldName, const UaInt64Array &  value  )

virtual

Writes an array of Int64 values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeLocalizedText ( const UaString &  sFieldName, const UaLocalizedText &  value  )

virtual

Writes a LocalizedText value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeLocalizedTextArray ( const UaString &  sFieldName, const UaLocalizedTextArray &  value  )

virtual

Writes an array of LocalizedText values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeNodeId ( const UaString &  sFieldName, const UaNodeId &  value  )

virtual

Writes a NodeId value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeNodeIdArray ( const UaString &  sFieldName, const UaNodeIdArray &  value  )

virtual

Writes an array of NodeId values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeQualifiedName ( const UaString &  sFieldName, const UaQualifiedName &  value  )

virtual

Writes a QualifiedName value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeQualifiedNameArray ( const UaString &  sFieldName, const UaQualifiedNameArray &  value  )

virtual

Writes an array of QualifiedName values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeSByte ( const UaString &  sFieldName, OpcUa_SByte  value  )

virtual

Writes an SByte value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeSByteArray ( const UaString &  sFieldName, const UaSByteArray &  value  )

virtual

Writes an array of SByte values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeStatusCode ( const UaString &  sFieldName, const UaStatusCode &  value  )

virtual

Writes a StatusCode value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeStatusCodeArray ( const UaString &  sFieldName, const UaStatusCodeArray &  value  )

virtual

Writes an array of StatusCode values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeString ( const UaString &  sFieldName, const UaString &  value  )

virtual

Writes a Boolean value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeStringArray ( const UaString &  sFieldName, const UaStringArray &  value  )

virtual

Writes an array of String values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeUInt16 ( const UaString &  sFieldName, OpcUa_UInt16  value  )

virtual

Writes a UInt16 value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeUInt16Array ( const UaString &  sFieldName, const UaUInt16Array &  value  )

virtual

Writes an array of UInt16 values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeUInt32 ( const UaString &  sFieldName, OpcUa_UInt32  value  )

virtual

Writes a UInt32 value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeUInt32Array ( const UaString &  sFieldName, const UaUInt32Array &  value  )

virtual

Writes an array of UInt32 values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeUInt64 ( const UaString &  sFieldName, OpcUa_UInt64  valueu  )

virtual

Writes a UInt64 value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeUInt64Array ( const UaString &  sFieldName, const UaUInt64Array &  value  )

virtual

Writes an array of UInt64 values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeVariant ( const UaString &  sFieldName, const UaVariant &  value  )

virtual

Writes a Variant value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeVariantArray ( const UaString &  sFieldName, const UaVariantArray &  value  )

virtual

Writes an array of Variant values.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeXmlElement ( const UaString &  sFieldName, const UaByteString &  value  )

virtual

Writes an XmlElement value.

Implements UaAbstractEncoder.

OpcUa_StatusCode UaBinaryEncoder::writeXmlElementArray ( const UaString &  sFieldName, const UaByteStringArray &  value  )

virtual

Writes an array of XmlElement values.

Implements UaAbstractEncoder.

---

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

• C:/work/uasdkcpp/src/uabase/uabasecpp/uabinaryencoder.h
• C:/work/uasdkcpp/src/uabase/uabasecpp/uabinaryencoder.cpp