Interface Union

  • All Superinterfaces:
    Composite, DataType
    All Known Implementing Classes:

    public interface Union
    extends Composite
    The union interface.

    NOTE: The use of bitfields within all unions assumes a default packing where bit allocation always starts with byte-0 of the union. Bit allocation order is dictated by data organization endianess (byte-0 msb allocated first for big-endian, while byte-0 lsb allocated first for little-endian).

    • Method Detail

      • insertBitField

        DataTypeComponent insertBitField​(int ordinal,
                                         DataType baseDataType,
                                         int bitSize,
                                         java.lang.String componentName,
                                         java.lang.String comment)
                                  throws InvalidDataTypeException,
        Inserts a new bitfield at the specified ordinal position in this union. For both aligned and unaligned unions the bitfield starts with bit-0 (lsb) of the first byte for little-endian, and with bit-7 (msb) of the first byte for big-endian. This is the default behavior for most compilers. Insertion behavior may not work as expected if packing rules differ from this.
        ordinal - the ordinal where the new datatype is to be inserted.
        baseDataType - the bitfield base datatype (certain restrictions apply).
        bitSize - the declared bitfield size in bits. The effective bit size may be adjusted based upon the specified baseDataType.
        componentName - the field name to associate with this component.
        comment - the comment to associate with this component.
        the bitfield component created whose associated data type will be BitFieldDataType.
        InvalidDataTypeException - if the specified baseDataType is not a valid base type for bitfields.
        java.lang.ArrayIndexOutOfBoundsException - if ordinal is less than 0 or greater than the current number of components.