com.prosysopc.ua.stack.encoding.binary

Class BinaryDecoder

java.lang.Object

com.prosysopc.ua.stack.encoding.AbstractDecoder

com.prosysopc.ua.stack.encoding.binary.BinaryDecoder

All Implemented Interfaces:

IDecoder

public class BinaryDecoder
extends AbstractDecoder
implements IDecoder

Decodes builtinTypes, structures, enumerations and messages from byte buffer. + Arrays

See Also:

IDecoder, BinaryEncoder

Field Summary

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

ctx

Constructor Summary

Constructors

Constructor and Description
BinaryDecoder(EncoderContext encoderContext, byte[] buf) Constructor for BinaryDecoder.
BinaryDecoder(EncoderContext encoderContext, byte[] buf, int off, int len) Constructor for BinaryDecoder.
BinaryDecoder(EncoderContext encoderContext, ByteBuffer buf) Create byte buffer decoder.
BinaryDecoder(EncoderContext encoderContext, ByteString buf)
BinaryDecoder(EncoderContext encoderContext, ByteString buf, int off, int len)
BinaryDecoder(EncoderContext encoderContext, IBinaryReadable in) Constructor for BinaryDecoder.
BinaryDecoder(EncoderContext encoderContext, InputStream is, int limit) Constructor for BinaryDecoder.

Method Summary

Modifier and Type	Method and Description
<T> T	get(String fieldName, UaNodeId dataTypeId, int dimensions)
int[]	getInt32Array_(String fieldName) getInt32Array_.
IBinaryReadable	getReadable() getReadable.
protected void	onStructureFieldDecode(FieldSpecification field, Object fieldValue) This is intended for internal use, API might change in the future at will.
protected long	remaining() remaining.
com.prosysopc.ua.stack.encoding.binary.BinaryDecoder.ScalarDecoder<?>	tryFindDecoderWithSpecification(UaDataTypeSpecification specification)

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

assertArrayLength, assertByteStringLength, assertStringLength, emptyArrayForClass, 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.IDecoder

getBoolean, getBooleanArray, getByte, getByteArray, getByteString, getByteStringArray, getDataValue, getDataValueArray, getDateTime, getDateTimeArray, getDiagnosticInfo, getDiagnosticInfoArray, getDouble, getDoubleArray, getEncoderContext, getExpandedNodeId, getExpandedNodeIdArray, getExtensionObject, getExtensionObjectArray, getFloat, getFloatArray, getGuid, getGuidArray, getInt16, getInt16Array, getInt32, getInt32Array, getInt64, getInt64Array, getLocalizedText, getLocalizedTextArray, getNodeId, getNodeIdArray, getQualifiedName, getQualifiedNameArray, getSByte, getSByteArray, getStatusCode, getStatusCodeArray, getString, getStringArray, getUInt16, getUInt16Array, getUInt32, getUInt32Array, getUInt64, getUInt64Array, getVariant, getVariantArray, getXmlElement, getXmlElementArray

Constructor Detail

BinaryDecoder

public BinaryDecoder(EncoderContext encoderContext,
                     byte[] buf)

Constructor for BinaryDecoder.

Parameters:

buf - an array of byte.

BinaryDecoder

public BinaryDecoder(EncoderContext encoderContext,
                     byte[] buf,
                     int off,
                     int len)

Constructor for BinaryDecoder.

Parameters:

buf - an array of byte.

off - a int.

len - a int.

BinaryDecoder

public BinaryDecoder(EncoderContext encoderContext,
                     ByteBuffer buf)

Create byte buffer decoder. Byte buffer must be in little-endian order.

Parameters:

buf - a ByteBuffer object.

BinaryDecoder

public BinaryDecoder(EncoderContext encoderContext,
                     ByteString buf)

BinaryDecoder

public BinaryDecoder(EncoderContext encoderContext,
                     ByteString buf,
                     int off,
                     int len)

BinaryDecoder

public BinaryDecoder(EncoderContext encoderContext,
                     IBinaryReadable in)

Constructor for BinaryDecoder.

Parameters:

in - a IBinaryReadable object.

BinaryDecoder

public BinaryDecoder(EncoderContext encoderContext,
                     InputStream is,
                     int limit)

Constructor for BinaryDecoder.

Parameters:

is - a InputStream object.

limit - a int.

Method Detail

get

public <T> T get(String fieldName,
                 UaNodeId dataTypeId,
                 int dimensions)
          throws DecodingException

Specified by:

get in interface IDecoder

Throws:

DecodingException

getInt32Array_

public int[] getInt32Array_(String fieldName)
                     throws DecodingException

Description copied from interface: IDecoder

getInt32Array_.

Specified by:

getInt32Array_ in interface IDecoder

Parameters:

fieldName - a String object.

Returns:

an array of int.

Throws:

DecodingException - if any.

getReadable

public IBinaryReadable getReadable()

getReadable.

Returns:

a IBinaryReadable object.

tryFindDecoderWithSpecification

public com.prosysopc.ua.stack.encoding.binary.BinaryDecoder.ScalarDecoder<?> tryFindDecoderWithSpecification(UaDataTypeSpecification specification)
                                                                                                      throws DecodingException

Throws:

DecodingException

onStructureFieldDecode

protected void onStructureFieldDecode(FieldSpecification field,
                                      Object fieldValue)

This is intended for internal use, API might change in the future at will. This method is called whenever a Structure field is decoded. This default implementation does nothing. A subtype can override this to be useful in cases where the decoding fails at some point, but you would need information about earlier fields. This is the case for ServiceResponses, where the header is the first field, but the decoding of the rest can potentially fail. And UABinaryFileDataType does have a header, that defines types for the UABinaryFileDataType.getBody().

remaining

protected long remaining()
                  throws DecodingException

remaining.

Returns:

a long.

Throws:

DecodingException - if any.