Class ShortArraySection

    • Constructor Detail

      • ShortArraySection

        public ShortArraySection​(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.
      • ShortArraySection

        public ShortArraySection​(TransmissionMetrics aTransmissionMetrics,
                                 short... aValue)
        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.
        aValue - The payload to be contained by the ShortArraySection.
      • ShortArraySection

        public ShortArraySection​(TransmissionMetrics aTransmissionMetrics,
                                 Short... aValue)
        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.
        aValue - The payload to be contained by the ShortArraySection.
      • ShortArraySection

        public ShortArraySection​(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.
      • ShortArraySection

        public ShortArraySection​(String aAlias,
                                 TransmissionMetrics aTransmissionMetrics,
                                 short... aValue)
        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.
        aValue - The payload to be contained by the ShortArraySection.
      • ShortArraySection

        public ShortArraySection​(String aAlias,
                                 TransmissionMetrics aTransmissionMetrics,
                                 Short... aValue)
        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.
        aValue - The payload to be contained by the ShortArraySection.
      • ShortArraySection

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

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

        public ShortArraySection​(org.refcodes.numerical.Endianess aEndianess,
                                 Short... aValue)
        Constructs a ShortArraySection with the given short array payload and the given Endianess for the representation of the ShortArraySection's value.
        Parameters:
        aEndianess - The Endianess to be used for payload values.
        aValue - The payload to be contained by the ShortArraySection.
      • ShortArraySection

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

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

        public ShortArraySection​(String aAlias,
                                 org.refcodes.numerical.Endianess aEndianess,
                                 Short... aValue)
        Constructs a ShortArraySection with the given short array payload and the given Endianess for the representation of the ShortArraySection's value.
        Parameters:
        aAlias - The alias which identifies the content of this segment.
        aEndianess - The Endianess to be used for payload values.
        aValue - The payload to be contained by the ShortArraySection.
    • Method Detail

      • 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).
      • withPayload

        public ShortArraySection withPayload​(short[] aValue)
        Specified by:
        withPayload in interface org.refcodes.mixin.PayloadAccessor.PayloadBuilder<short[],​PayloadTransmission<short[]>>
      • setPayload

        public void setPayload​(Short[] aPayload)
        Convenience method to convert the array of wrapper types into its counterpart with primitive types before invoking AbstractPayloadSection.setPayload(Object).
        Parameters:
        aPayload - The payload with the wrapper types.
      • withPayload

        public ShortArraySection withPayload​(Short[] aPayload)
        Convenience method to convert the array of wrapper types into its counterpart with primitive types before invoking withPayload(short[]).
        Parameters:
        aPayload - The payload with the wrapper types.
        Returns:
        This instance as of the builder pattern.