Module org.refcodes.serial
Package org.refcodes.serial

Class FloatSegment

java.lang.Object
org.refcodes.serial.AbstractPayloadSegment<Float>
org.refcodes.serial.FloatSegment
All Implemented Interfaces:
Serializable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.PayloadAccessor<Float>, org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Float,PayloadTransmission<Float>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<Float>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<Float>, org.refcodes.mixin.Resetable, org.refcodes.mixin.Schemable, PayloadSegment<Float>, PayloadTransmission<Float>, Segment, Segment.SegmentMixin, Transmission, Transmission.TransmissionMixin
public class FloatSegment extends AbstractPayloadSegment<Float> implements Segment
The FloatSegment is an implementation of a Segment carrying in float value as payload.
See Also:

  • Field Details

  • Constructor Details

    • FloatSegment

      public FloatSegment(TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

    • FloatSegment

      public FloatSegment(Float aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

    • FloatSegment

      public FloatSegment(String aAlias, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

    • FloatSegment

      public FloatSegment(String aAlias, Float aValue, TransmissionMetrics aTransmissionMetrics)
      Constructs an according instance from the given configuration. The configuration attributes are taken from the TransmissionMetrics configuration object, though only those attributes are supported which are also supported by the other constructors!
      Parameters:
      aAlias - The alias which identifies the content of this instance.
      aValue - The payload to be contained by the DoubleArraySection.
      aTransmissionMetrics - The TransmissionMetrics to be used for configuring this instance.

    • FloatSegment

      public FloatSegment()
      Constructs an empty FloatSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatSegment's value.

    • FloatSegment

      public FloatSegment(org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty FloatSegment with the given Endianess.
      Parameters:
      aEndianess - The Endianess to be used for payload values.

    • FloatSegment

      public FloatSegment(Float aValue)
      Constructs a FloatSegment with the given float value (payload) and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatSegment's value.
      Parameters:
      aValue - The value (payload) to be contained by the FloatSegment.

    • FloatSegment

      public FloatSegment(Float aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a FloatSegment with the given float value (payload) and the given Endianess for the representation of the FloatSegment's value.
      Parameters:
      aValue - The value (payload) to be contained by the FloatSegment.
      aEndianess - The Endianess to be used for payload values.

    • FloatSegment

      public FloatSegment(String aAlias)
      Constructs an empty FloatSegment with a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.

    • FloatSegment

      public FloatSegment(String aAlias, org.refcodes.numerical.Endianess aEndianess)
      Constructs an empty FloatSegment with the given Endianess.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aEndianess - The Endianess to be used for payload values.

    • FloatSegment

      public FloatSegment(String aAlias, Float aValue)
      Constructs a FloatSegment with the given float value (payload) and a TransmissionMetrics.DEFAULT_ENDIANESS endian representation of the FloatSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the FloatSegment.

    • FloatSegment

      public FloatSegment(String aAlias, Float aValue, org.refcodes.numerical.Endianess aEndianess)
      Constructs a FloatSegment with the given float value (payload) and the given Endianess for the representation of the FloatSegment's value.
      Parameters:
      aAlias - The alias which identifies the content of this segment.
      aValue - The value (payload) to be contained by the FloatSegment.
      aEndianess - The Endianess to be used for payload values.

  • Method Details

    • toSequence

      public Sequence toSequence()
      Provides the Sequence representation of this Transmission. In case of nested Transmission instances, all Sequence representations from all sub-segments are accumulated to the result as well. Caution, the Transmission (or its nested Transmission instances) may be backed by the returned Sequence.
      Specified by:
      toSequence in interface Transmission
      Returns:
      The according instance's Sequence.

    • fromTransmission

      public int fromTransmission(Sequence aSequence, int aOffset) throws TransmissionException
      (Re-)initializes this instance with the the given Sequence data.
      Specified by:
      fromTransmission in interface Segment
      Parameters:
      aSequence - The Sequence data from which to (re-)initialize this instance.
      aOffset - The offset where to start processing the provided Sequence.
      Returns:
      The index after the last offset into the given Sequence processed by this method.
      Throws:
      TransmissionException - thrown in case a given Sequence cannot be processed.

    • getLength

      public int getLength()
      Determines the overall length of this Transmission. In case of nested Transmission instances, all length values from all sub-segments are accumulated to the result as well.
      Specified by:
      getLength in interface org.refcodes.mixin.LengthAccessor
      Specified by:
      getLength in interface Transmission
      Returns:
      The (overall) length of the Transmission (including any sub-segments).

    • reset

      public void reset()
      Resets any dynamic data (e.g. values such as payloads or checksums) and must not(!) reset any configurations or settings required to produce the dynamic data (e.g. the TransmissionMetrics).
      Specified by:
      reset in interface org.refcodes.mixin.Resetable
      Specified by:
      reset in interface Transmission
      Overrides:
      reset in class AbstractPayloadSegment<Float>

    • toSchema

      public SerialSchema toSchema()
      Specified by:
      toSchema in interface org.refcodes.mixin.Schemable
      Specified by:
      toSchema in interface Transmission

    • withPayload

      public FloatSegment withPayload(Float aValue)
      Specified by:
      withPayload in interface org.refcodes.mixin.PayloadAccessor.PayloadBuilder<Float,PayloadTransmission<Float>>