Start » Filter Reference » System » Binary Data » WriteRealToBuffer

WriteRealToBuffer

Basic

Module: FoundationLite

Converts real value into specified binary representation and writes it to a byte buffer.

Name Type Range Description
Input value
 inBuffer ByteBuffer Initial buffer to be expanded
Input value
 inOffset Integer* 0 - Write destination position
Input value
 inValue Real Value to be written
Input value
 inFormat RealBinaryFormat Binary serialization format of floating point data
Output value
 outBuffer ByteBuffer Resulting data

Description

This filter is intended for generating a raw binary data in the ByteBuffer by writing a properly serialized floating point value 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.

Real value is converted into a binary representation according to the inFormat input value:

  • SinglePrecision_32Bit_LittleEndian - single precision floating point value, 4 bytes long with little-endian byte order.
  • DoublePrecision_64Bit_LittleEndian - double precision floating point value, 8 bytes long with little-endian byte order.
  • SinglePrecision_32Bit_BigEndian - single precision floating point value, 4 bytes long with big-endian byte order.
  • DoublePrecision_64Bit_BigEndian - double precision floating point value, 8 bytes long with big-endian byte order.

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 Not supported floating point binary format.
IoError Resulting 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