- 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.Schemable<SerialSchema>
,PayloadSegment<Float>
,PayloadTransmission<Float>
,Segment
,Segment.SegmentMixin
,Transmission
,Transmission.TransmissionMixin
The
FloatSegment
is an implementation of a Segment
carrying
in float value as payload.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor
org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty
Nested classes/interfaces inherited from interface org.refcodes.mixin.LengthAccessor
org.refcodes.mixin.LengthAccessor.LengthBuilder<B extends org.refcodes.mixin.LengthAccessor.LengthBuilder<B>>, org.refcodes.mixin.LengthAccessor.LengthMutator, org.refcodes.mixin.LengthAccessor.LengthProperty
Nested classes/interfaces inherited from interface org.refcodes.mixin.PayloadAccessor
org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P extends Object,
B extends org.refcodes.mixin.PayloadAccessor.PayloadBuilder<P, B>>, org.refcodes.mixin.PayloadAccessor.PayloadMutator<P extends Object>, org.refcodes.mixin.PayloadAccessor.PayloadProperty<P extends Object> Nested classes/interfaces inherited from interface org.refcodes.serial.Segment
Segment.SegmentMixin
Nested classes/interfaces inherited from interface org.refcodes.serial.Transmission
Transmission.TransmissionMixin
-
Field Summary
Fields inherited from class org.refcodes.serial.AbstractPayloadSegment
_alias, _payload
-
Constructor Summary
ConstructorDescriptionConstructs an emptyFloatSegment
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theFloatSegment
's value.FloatSegment
(Float aValue) Constructs aFloatSegment
with the given float value (payload) and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theFloatSegment
's value.FloatSegment
(Float aValue, org.refcodes.numerical.Endianess aEndianess) Constructs aFloatSegment
with the given float value (payload) and the givenEndianess
for the representation of theFloatSegment
's value.FloatSegment
(Float aValue, TransmissionMetrics aTransmissionMetrics) Constructs an according instance from the given configuration.FloatSegment
(String aAlias) Constructs an emptyFloatSegment
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theFloatSegment
's value.FloatSegment
(String aAlias, Float aValue) Constructs aFloatSegment
with the given float value (payload) and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theFloatSegment
's value.FloatSegment
(String aAlias, Float aValue, org.refcodes.numerical.Endianess aEndianess) Constructs aFloatSegment
with the given float value (payload) and the givenEndianess
for the representation of theFloatSegment
's value.FloatSegment
(String aAlias, Float aValue, TransmissionMetrics aTransmissionMetrics) Constructs an according instance from the given configuration.FloatSegment
(String aAlias, org.refcodes.numerical.Endianess aEndianess) Constructs an emptyFloatSegment
with the givenEndianess
.FloatSegment
(String aAlias, TransmissionMetrics aTransmissionMetrics) Constructs an according instance from the given configuration.FloatSegment
(org.refcodes.numerical.Endianess aEndianess) Constructs an emptyFloatSegment
with the givenEndianess
.FloatSegment
(TransmissionMetrics aTransmissionMetrics) Constructs an according instance from the given configuration. -
Method Summary
Modifier and TypeMethodDescriptionint
fromTransmission
(Sequence aSequence, int aOffset) (Re-)initializes this instance with the the givenSequence
data.int
Determines the overall length of thisTransmission
.toSchema()
Retrieves theSerialSchema
representing theTransmission
.Provides theSequence
representation of thisTransmission
.withPayload
(Float aValue) Methods inherited from class org.refcodes.serial.AbstractPayloadSegment
equals, getAlias, getPayload, hashCode, setPayload, toSimpleTypeMap, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.refcodes.mixin.PayloadAccessor
getPayloadOr
Methods inherited from interface org.refcodes.mixin.PayloadAccessor.PayloadProperty
letPayload
Methods inherited from interface org.refcodes.serial.Segment
fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom
Methods inherited from interface org.refcodes.serial.Segment.SegmentMixin
receiveFrom
Methods inherited from interface org.refcodes.serial.Transmission
toSimpleTypeMap, transmitTo, transmitTo
Methods inherited from interface org.refcodes.serial.Transmission.TransmissionMixin
transmitTo
-
Field Details
-
ENDIANESS
- See Also:
-
BYTES
public static final int BYTES- See Also:
-
-
Constructor Details
-
FloatSegment
Constructs an according instance from the given configuration. The configuration attributes are taken from theTransmissionMetrics
configuration object, though only those attributes are supported which are also supported by the other constructors!- Parameters:
aTransmissionMetrics
- TheTransmissionMetrics
to be used for configuring this instance.
-
FloatSegment
Constructs an according instance from the given configuration. The configuration attributes are taken from theTransmissionMetrics
configuration object, though only those attributes are supported which are also supported by the other constructors!- Parameters:
aValue
- The payload to be contained by theDoubleArraySection
.aTransmissionMetrics
- TheTransmissionMetrics
to be used for configuring this instance.
-
FloatSegment
Constructs an according instance from the given configuration. The configuration attributes are taken from theTransmissionMetrics
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
- TheTransmissionMetrics
to be used for configuring this instance.
-
FloatSegment
Constructs an according instance from the given configuration. The configuration attributes are taken from theTransmissionMetrics
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 theDoubleArraySection
.aTransmissionMetrics
- TheTransmissionMetrics
to be used for configuring this instance.
-
FloatSegment
public FloatSegment()Constructs an emptyFloatSegment
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theFloatSegment
's value. -
FloatSegment
public FloatSegment(org.refcodes.numerical.Endianess aEndianess) Constructs an emptyFloatSegment
with the givenEndianess
.- Parameters:
aEndianess
- TheEndianess
to be used for payload values.
-
FloatSegment
Constructs aFloatSegment
with the given float value (payload) and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theFloatSegment
's value.- Parameters:
aValue
- The value (payload) to be contained by theFloatSegment
.
-
FloatSegment
Constructs aFloatSegment
with the given float value (payload) and the givenEndianess
for the representation of theFloatSegment
's value.- Parameters:
aValue
- The value (payload) to be contained by theFloatSegment
.aEndianess
- TheEndianess
to be used for payload values.
-
FloatSegment
Constructs an emptyFloatSegment
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theFloatSegment
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.
-
FloatSegment
Constructs an emptyFloatSegment
with the givenEndianess
.- Parameters:
aAlias
- The alias which identifies the content of this segment.aEndianess
- TheEndianess
to be used for payload values.
-
FloatSegment
Constructs aFloatSegment
with the given float value (payload) and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theFloatSegment
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.aValue
- The value (payload) to be contained by theFloatSegment
.
-
FloatSegment
Constructs aFloatSegment
with the given float value (payload) and the givenEndianess
for the representation of theFloatSegment
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.aValue
- The value (payload) to be contained by theFloatSegment
.aEndianess
- TheEndianess
to be used for payload values.
-
-
Method Details
-
toSequence
Provides theSequence
representation of thisTransmission
. In case of nestedTransmission
instances, allSequence
representations from all sub-segments are accumulated to the result as well. Caution, the Transmission (or its nestedTransmission
instances) may be backed by the returnedSequence
.- Specified by:
toSequence
in interfaceTransmission
- Returns:
- The according instance's
Sequence
.
-
fromTransmission
(Re-)initializes this instance with the the givenSequence
data.- Specified by:
fromTransmission
in interfaceSegment
- Parameters:
aSequence
- TheSequence
data from which to (re-)initialize this instance.aOffset
- The offset where to start processing the providedSequence
.- Returns:
- The index after the last offset into the given
Sequence
processed by this method. - Throws:
TransmissionException
- thrown in case a givenSequence
cannot be processed.
-
getLength
public int getLength()Determines the overall length of thisTransmission
. In case of nestedTransmission
instances, all length values from all sub-segments are accumulated to the result as well.- Specified by:
getLength
in interfaceorg.refcodes.mixin.LengthAccessor
- Specified by:
getLength
in interfaceTransmission
- Returns:
- The (overall) length of the
Transmission
(including any sub-segments).
-
toSchema
Retrieves theSerialSchema
representing theTransmission
. Retrieving aSerialSchema
is useful when analyzing and debugging data structures such as aAllocSectionDecoratorSegment
instance to help document, learn and verify on the structure (as well as the content) of that veryAllocSectionDecoratorSegment
.- Specified by:
toSchema
in interfaceorg.refcodes.mixin.Schemable<SerialSchema>
- Specified by:
toSchema
in interfaceTransmission
- Returns:
- The
SerialSchema
representation of the implementing type for debugging and verification (or documentation) purposes.
-
withPayload
- Specified by:
withPayload
in interfaceorg.refcodes.mixin.PayloadAccessor.PayloadBuilder<Float,
PayloadTransmission<Float>>
-