java.lang.Object
org.refcodes.serial.AbstractPayloadSection<float[]>
org.refcodes.serial.FloatArraySection
- 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
,PayloadSection<float[]>
,PayloadTransmission<float[]>
,Section
,Section.SectionMixin
,Transmission
,Transmission.TransmissionMixin
public class FloatArraySection
extends AbstractPayloadSection<float[]>
implements PayloadSection<float[]>
The
FloatArraySection
is an implementation of a Section
carrying a float array 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.Section
Section.SectionMixin
Nested classes/interfaces inherited from interface org.refcodes.serial.Transmission
Transmission.TransmissionMixin
-
Field Summary
Fields inherited from class org.refcodes.serial.AbstractPayloadSection
_alias, _payload
-
Constructor Summary
ConstructorDescriptionConstructs an emptyFloatArraySection
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value.FloatArraySection
(float... aValue) Constructs aFloatArraySection
with the given float array payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value.FloatArraySection
(Float... aValue) Constructs aFloatArraySection
with the given float array payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value.FloatArraySection
(String aAlias) Constructs an emptyFloatArraySection
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value.FloatArraySection
(String aAlias, float... aValue) Constructs aFloatArraySection
with the given float array payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value.FloatArraySection
(String aAlias, Float... aValue) Constructs aFloatArraySection
with the given float array payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value.FloatArraySection
(String aAlias, org.refcodes.numerical.Endianess aEndianess) Constructs an emptyFloatArraySection
with the givenEndianess
.FloatArraySection
(String aAlias, org.refcodes.numerical.Endianess aEndianess, float... aValue) Constructs aFloatArraySection
with the given float array payload andEndianess
for the representation of theSection
's value.FloatArraySection
(String aAlias, org.refcodes.numerical.Endianess aEndianess, Float... aValue) Constructs aFloatArraySection
with the given float array payload andEndianess
for the representation of theSection
's value.FloatArraySection
(String aAlias, TransmissionMetrics aTransmissionMetrics) Constructs an according instance from the given configuration.FloatArraySection
(String aAlias, TransmissionMetrics aTransmissionMetrics, float... aValue) Constructs an according instance from the given configuration.FloatArraySection
(String aAlias, TransmissionMetrics aTransmissionMetrics, Float... aValue) Constructs an according instance from the given configuration.FloatArraySection
(org.refcodes.numerical.Endianess aEndianess) Constructs an emptyFloatArraySection
with the givenEndianess
.FloatArraySection
(org.refcodes.numerical.Endianess aEndianess, float... aValue) Constructs aFloatArraySection
with the given float array payload andEndianess
for the representation of theSection
's value.FloatArraySection
(org.refcodes.numerical.Endianess aEndianess, Float... aValue) Constructs aFloatArraySection
with the given float array payload andEndianess
for the representation of theSection
's value.FloatArraySection
(TransmissionMetrics aTransmissionMetrics) Constructs an according instance from the given configuration.FloatArraySection
(TransmissionMetrics aTransmissionMetrics, float... aValue) Constructs an according instance from the given configuration.FloatArraySection
(TransmissionMetrics aTransmissionMetrics, Float... aValue) Constructs an according instance from the given configuration. -
Method Summary
Modifier and TypeMethodDescriptionvoid
fromTransmission
(Sequence aSequence, int aOffset, int aLength) (Re-)initializes this instance with the the givenSequence
data.int
Determines the overall length of thisTransmission
.void
setPayload
(Float[] aPayload) Convenience method to convert the array of wrapper types into its counterpart with primitive types before invokingAbstractPayloadSection.setPayload(Object)
.toSchema()
Provides theSequence
representation of thisTransmission
.toString()
withPayload
(float[] aValue) withPayload
(Float[] aPayload) Convenience method to convert the array of wrapper types into its counterpart with primitive types before invokingwithPayload(float[])
.Methods inherited from class org.refcodes.serial.AbstractPayloadSection
equals, getAlias, getPayload, hashCode, setPayload, toSimpleTypeMap
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.refcodes.mixin.AliasAccessor
getAlias
Methods inherited from interface org.refcodes.mixin.PayloadAccessor
getPayload, getPayloadOr
Methods inherited from interface org.refcodes.mixin.PayloadAccessor.PayloadMutator
setPayload
Methods inherited from interface org.refcodes.mixin.PayloadAccessor.PayloadProperty
letPayload
Methods inherited from interface org.refcodes.serial.Section
fromTransmission, fromTransmission, fromTransmission, receiveFrom, receiveFrom
Methods inherited from interface org.refcodes.serial.Section.SectionMixin
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:
-
-
Constructor Details
-
FloatArraySection
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.
-
FloatArraySection
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.aValue
- The payload to be contained by theFloatArraySection
.
-
FloatArraySection
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.aValue
- The payload to be contained by theFloatArraySection
.
-
FloatArraySection
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.
-
FloatArraySection
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.aValue
- The payload to be contained by theFloatArraySection
.
-
FloatArraySection
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.aValue
- The payload to be contained by theFloatArraySection
.
-
FloatArraySection
public FloatArraySection()Constructs an emptyFloatArraySection
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value. -
FloatArraySection
public FloatArraySection(org.refcodes.numerical.Endianess aEndianess) Constructs an emptyFloatArraySection
with the givenEndianess
.- Parameters:
aEndianess
- TheEndianess
to be used for payload values.
-
FloatArraySection
public FloatArraySection(float... aValue) Constructs aFloatArraySection
with the given float array payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value.- Parameters:
aValue
- The payload to be contained by theSection
.
-
FloatArraySection
Constructs aFloatArraySection
with the given float array payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value.- Parameters:
aValue
- The payload to be contained by theSection
.
-
FloatArraySection
public FloatArraySection(org.refcodes.numerical.Endianess aEndianess, float... aValue) Constructs aFloatArraySection
with the given float array payload andEndianess
for the representation of theSection
's value.- Parameters:
aEndianess
- TheEndianess
to be used for payload values.aValue
- The payload to be contained by theSection
.
-
FloatArraySection
Constructs aFloatArraySection
with the given float array payload andEndianess
for the representation of theSection
's value.- Parameters:
aEndianess
- TheEndianess
to be used for payload values.aValue
- The payload to be contained by theSection
.
-
FloatArraySection
Constructs an emptyFloatArraySection
with aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.
-
FloatArraySection
Constructs an emptyFloatArraySection
with the givenEndianess
.- Parameters:
aAlias
- The alias which identifies the content of this segment.aEndianess
- TheEndianess
to be used for payload values.
-
FloatArraySection
Constructs aFloatArraySection
with the given float array payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.aValue
- The payload to be contained by theSection
.
-
FloatArraySection
Constructs aFloatArraySection
with the given float array payload and aTransmissionMetrics.DEFAULT_ENDIANESS
endian representation of theSection
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.aValue
- The payload to be contained by theSection
.
-
FloatArraySection
public FloatArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, float... aValue) Constructs aFloatArraySection
with the given float array payload andEndianess
for the representation of theSection
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.aEndianess
- TheEndianess
to be used for payload values.aValue
- The payload to be contained by theSection
.
-
FloatArraySection
public FloatArraySection(String aAlias, org.refcodes.numerical.Endianess aEndianess, Float... aValue) Constructs aFloatArraySection
with the given float array payload andEndianess
for the representation of theSection
's value.- Parameters:
aAlias
- The alias which identifies the content of this segment.aEndianess
- TheEndianess
to be used for payload values.aValue
- The payload to be contained by theSection
.
-
-
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
public void fromTransmission(Sequence aSequence, int aOffset, int aLength) throws TransmissionException (Re-)initializes this instance with the the givenSequence
data.- Specified by:
fromTransmission
in interfaceSection
- Parameters:
aSequence
- TheSequence
data from which to (re-)initialize this instance.aOffset
- The offset where to start processing the providedSequence
.aLength
- The length of data assigned by theSequence
.- 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
- Specified by:
toSchema
in interfaceorg.refcodes.mixin.Schemable
- Specified by:
toSchema
in interfaceTransmission
-
toString
- Overrides:
toString
in classAbstractPayloadSection<float[]>
-
withPayload
- Specified by:
withPayload
in interfaceorg.refcodes.mixin.PayloadAccessor.PayloadBuilder<float[],
PayloadTransmission<float[]>>
-
setPayload
Convenience method to convert the array of wrapper types into its counterpart with primitive types before invokingAbstractPayloadSection.setPayload(Object)
.- Parameters:
aPayload
- The payload with the wrapper types.
-
withPayload
Convenience method to convert the array of wrapper types into its counterpart with primitive types before invokingwithPayload(float[])
.- Parameters:
aPayload
- The payload with the wrapper types.- Returns:
- This instance as of the builder pattern.
-