Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » Binary Data » WriteIntegerArrayToBuffer

WriteIntegerArrayToBuffer


Module: FoundationLite

Converts an array of integer values into specified binary representation and writes it to a byte buffer.

Name Type Range Description
inBuffer ByteBuffer Initial buffer to be expanded
inOffset Integer* 0 - Write destination position
inArray IntegerArray Values array to be written
inFormat IntegerBinaryFormat Binary serialization format of integer data
outBuffer ByteBuffer Resulting data

Description

This filter is intended for generating a raw binary data in the ByteBuffer by writing a properly serialized array of integer values into it.

Resulting ByteBuffer data on the outBuffer output is created by expanding data from buffer on the inBuffer input. Data is written starting at the position specified by the inOffset input (in bytes). When written data spans beyond the end of the input buffer the resulting buffer length is expanded (event when inOffset points beyond the end of the input buffer). When the inOffset input is set to Auto data is written at the end of the input buffer.

This filter writes multiple consecutive integer values from an array on the inArray input. Every array item integer value is converted into a binary representation according to the inFormat input value:

  • Signed_8Bit - signed two's complement 8-bit integer, 1 byte long.
  • Signed_16Bit_LittleEndian - signed two's complement 16-bit integer, 2 bytes long with little-endian byte order.
  • Signed_32Bit_LittleEndian - signed two's complement 32-bit integer, 4 bytes long with little-endian byte order.
  • Signed_64Bit_LittleEndian - signed two's complement 64-bit integer, 8 bytes long with little-endian byte order.
  • Unsigned_8Bit - unsigned 8-bit integer, 1 byte long.
  • Unsigned_16Bit_LittleEndian - unsigned 16-bit integer, 2 bytes long with little-endian byte order.
  • Unsigned_64Bit_LittleEndian - unsigned 64-bit integer, 8 bytes long with little-endian byte order.
  • Signed_16Bit_BigEndian - signed two's complement 16-bit integer, 2 bytes long with big-endian byte order.
  • Signed_32Bit_BigEndian - signed two's complement 32-bit integer, 4 bytes long with big-endian byte order.
  • Signed_64Bit_BigEndian - signed two's complement 64-bit integer, 8 bytes long with big-endian byte order.
  • Unsigned_16Bit_BigEndian - unsigned 16-bit integer, 2 bytes long with big-endian byte order.
  • Unsigned_32Bit_BigEndian - unsigned 32-bit integer, 4 bytes long with big-endian byte order.
  • Unsigned_64Bit_BigEndian - unsigned 64-bit integer, 8 bytes long with big-endian byte order.

Supported numeric range of stored value also depends on selected format:

  • Signed_8Bit: -128...127
  • Signed_16Bit_: -32768...32767
  • Signed_32Bit_: -2147483648...2147483647
  • Signed_64Bit_: -9223372036854775808...9223372036854775807 *
  • Unsigned_8Bit: 0...255
  • Unsigned_16Bit_: 0...65535
  • Unsigned_32Bit_: 0...4294967295 *
  • Unsigned_64Bit_: 0...18446744073709551615 *

 *) actual achievable range in the application is also limited by the Integer type

When an array item value (which is a signed 32-bit integer) cannot be stored in the selected format (it is out of its range) a DomainError is raised.

This filter can be used as a more convenient and faster alternative to the connection of WriteIntegerToBuffer and WriteBufferArrayToBuffer filters.

Examples

Description of usage of this filter can be found in examples and tutorial: IO Serial Port Communicator.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Input value is out of the valid range for specified integer binary format.
One of the items value in provided array cannot be cast to the type specified by the inFormat input.
DomainError Not supported integer binary format.
IoError Resulting byte buffer size is too large.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of WriteToBuffer filter group.

See Also

  • WriteIntegerToBuffer – Converts integer value into specified binary representation and writes it to a byte buffer.