com.prosysopc.ua.stack.encoding.binary

Class BinaryEncoder

java.lang.Object

com.prosysopc.ua.stack.encoding.AbstactEncoder

com.prosysopc.ua.stack.encoding.binary.BinaryEncoder

All Implemented Interfaces:

IEncoder

public class BinaryEncoder
extends AbstactEncoder
implements IEncoder

Encodes built-in types, Enumerations, Structures and Messages. An EncoderContext must be set before use.

See Also:

the decoder equivalent of this class.

Field Summary

Fields inherited from class com.prosysopc.ua.stack.encoding.AbstactEncoder

ctx

Constructor Summary

Constructors

Constructor and Description
BinaryEncoder(EncoderContext encoderContext, byte[] buffer) Creates BinaryEncoder with the given EncoderContext that writes to the given buffer.
BinaryEncoder(EncoderContext encoderContext, byte[] buffer, int offset, int length) Creates BinaryEncoder with the given EncoderContext that writes to the given buffer starting from the given offset and only writing up-to the given length.
BinaryEncoder(EncoderContext encoderContext, ByteBuffer buf) Creates BinaryEncoder with the given EncoderContext that writes to the given buffer.
BinaryEncoder(EncoderContext encoderContext, IBinaryWriteable out) Creates BinaryEncoder with the given EncoderContext that writes to the given stream.
BinaryEncoder(EncoderContext encoderContext, OutputStream os) Creates BinaryEncoder with the given EncoderContext that writes to the given stream.

Method Summary

Modifier and Type	Method and Description
List<Locale>	getLocales() The current Locale preferences.
IBinaryWriteable	getOutput() Returns the output being written.
IBinaryWriteable	getWriteable() Returns the output being written.
void	put(String fieldName, Object value, UaNodeId dataTypeId, int dimensions) Encodes the given field.

Methods inherited from class com.prosysopc.ua.stack.encoding.AbstactEncoder

getEncoderContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.prosysopc.ua.stack.encoding.IEncoder

getEncoderContext, putBoolean, putBooleanArray, putBooleanArray, putByte, putByteArray, putByteArray, putByteString, putByteStringArray, putByteStringArray, putDataValue, putDataValueArray, putDataValueArray, putDateTime, putDateTimeArray, putDateTimeArray, putDiagnosticInfo, putDiagnosticInfoArray, putDiagnosticInfoArray, putDouble, putDouble, putDoubleArray, putDoubleArray, putExpandedNodeId, putExpandedNodeIdArray, putExpandedNodeIdArray, putExtensionObject, putExtensionObjectArray, putExtensionObjectArray, putFloat, putFloat, putFloatArray, putFloatArray, putGuid, putGuidArray, putGuidArray, putInt16, putInt16, putInt16Array, putInt16Array, putInt32, putInt32, putInt32Array, putInt32Array, putInt32Array, putInt64, putInt64, putInt64Array, putInt64Array, putLocalizedText, putLocalizedTextArray, putLocalizedTextArray, putNodeId, putNodeIdArray, putNodeIdArray, putQualifiedName, putQualifiedNameArray, putQualifiedNameArray, putSByte, putSByte, putSByte, putSByteArray, putSByteArray, putStatusCode, putStatusCodeArray, putStatusCodeArray, putString, putStringArray, putStringArray, putUInt16, putUInt16Array, putUInt16Array, putUInt32, putUInt32Array, putUInt32Array, putUInt64, putUInt64Array, putUInt64Array, putVariant, putVariantArray, putXmlElement, putXmlElementArray, putXmlElementArray

Constructor Detail

BinaryEncoder

public BinaryEncoder(EncoderContext encoderContext,
                     byte[] buffer)

Creates BinaryEncoder with the given EncoderContext that writes to the given buffer.

BinaryEncoder

public BinaryEncoder(EncoderContext encoderContext,
                     byte[] buffer,
                     int offset,
                     int length)

Creates BinaryEncoder with the given EncoderContext that writes to the given buffer starting from the given offset and only writing up-to the given length.

BinaryEncoder

public BinaryEncoder(EncoderContext encoderContext,
                     ByteBuffer buf)

Creates BinaryEncoder with the given EncoderContext that writes to the given buffer.

BinaryEncoder

public BinaryEncoder(EncoderContext encoderContext,
                     IBinaryWriteable out)

Creates BinaryEncoder with the given EncoderContext that writes to the given stream.

BinaryEncoder

public BinaryEncoder(EncoderContext encoderContext,
                     OutputStream os)

Creates BinaryEncoder with the given EncoderContext that writes to the given stream.

Method Detail

getLocales

public List<Locale> getLocales()

Description copied from interface: IEncoder

The current Locale preferences. When encoding localized data, the first index is preferred, then second etc., until there is a direct match. If there are no direct matches (or this list is empty), one of the values or an "invariant locale" (i.e. typically the one for locale==null case) value is returned. Note! this is only used in the server side, in the client side there is only a single locale at a time (when encoding messages to be sent to the server), while the server will encode the messages based on the client's localization preferences.

Specified by:

getLocales in interface IEncoder

getOutput

public IBinaryWriteable getOutput()

Returns the output being written.

getWriteable

public IBinaryWriteable getWriteable()

Returns the output being written.

put

public void put(String fieldName,
                Object value,
                UaNodeId dataTypeId,
                int dimensions)
         throws EncodingException

Description copied from interface: IEncoder

Encodes the given field.

Specified by:

put in interface IEncoder

Parameters:

fieldName - the name of the field (not used in all encodings e.g. Binary encodings do not typically use a name, but JSON does).

value - the value for the field, possibly null.

dataTypeId - the OPC UA DataType of the field, not null.

dimensions - the dimensions of the field, 0 if scalar, 1 if 1-dim array, etc.).

Throws:

EncodingException - in case the value cannot be encoded. Possible errors are e.g. giving wrong DataType for a given value, giving wrong dimensions or giving values that are too large for limits of the IEncoder.getEncoderContext().