Package com.opencloud.slee.resources.in.datatypes.cc

Class MSBearerCapability.GSM

  • All Implemented Interfaces:
    DataObject, FastSerializable, Serializable
    Enclosing class:
    MSBearerCapability
    public static final class MSBearerCapability.GSM
extends AbstractLazyEncodedByteArray
implements FastSerializable
    Class GSM represents the case of a MSBearerCapability that is specified in TS 24.008. It represents part of a larger octet string; it is not transmitted on a network by itself.

    The API offered by this class is as if the type were specified in ASN.1 as follows. 

     GSM ::= SEQUENCE {
     transferMode       TransferMode,
     radioChannelReq    RadioChannelReq,
     content            Content
 }
    The class takes care of encoding the field values into a byte-array and decoding field values from a byte-array, the encoded representation being as tabulated below.

    Data Encoding - based on 3GPP TS 24.008 v4.17.0 (2007-09) §10.5.4.5 pp343-361
    87654321
    Octet 3ext. 0/1Radio channel requirementSpareTransfer modeInformation transfer capability
    Octet 3a*ext. 0/1Coding (0)CTMSpare (0)Speech version indication
    Octet 3b etc*ext. 0/1Coding (0)Spare (0)Spare (0)Speech version indication
    Octet 4*ext. 1CompressionStructureDuplex modeConfigurationNIRREstablishment
    Octet 5*ext. 0/1Access id. (00)Rate adaptionSignalling access protocol
    Octet 5a*ext. 0/1Other ITCOther rate adaptionSpare (000)
    Octet 5b*ext. 1Hdr/No HdrMultiframeModeLogical link identifierAssignor/eeInband negotiationSpare (0)
    Octet 6*ext. 0/1Layer 1 id. (01)User information layer 1 protocolAsync?
    Octet 6a*ext. 0/1Number of stop bitsNegotiationNumber of data bitsUser rate
    Octet 6b*ext. 0/1Intermediate rateNIC on TxNIC on RxParity
    Octet 6c*ext. 0/1Connection elementModem type
    Octet 6d*ext. 0/1Other modem typeFixed network user rate
    Octet 6e*ext. 0/1Acceptable channel codingsMaximum number of traffic channels
    Octet 6f*ext. 0/1UIMIWanted air interface user rate
    Octet 6g*ext. 1Acceptable channel codings extendedAsymmetry indicationSpare (00)
    Octet 7*ext. 1Layer 2 id. (10)User information layer 2 protocol

    The octet numbering in the above table is that used in the cited standard for the octets encoded here. Field names ending in ? are booleans: 1 for true, 0 for false.
    See Also:
    Serialized Form

    • Constructor Detail

      • GSM

        public GSM()
        Constructs a new GSM object with no fields set.

      • GSM

        public GSM​(byte[] data)
        Constructs a new GSM object from network-encoded data. The data is not decoded and might not be decodable.
        Parameters:
        data - network-encoded data
        Throws:
        NullPointerException - if data is null

      • GSM

        public GSM​(byte[] data,
           int start,
           int len)
        Constructs a new GSM object from part of network-encoded data. The part starts at index start and is len bytes long. The data is not decoded and might not be decodable.
        Parameters:
        data - network-encoded data
        start - starting offset of network-encoded data in byte array
        len - default length if not predictable
        Throws:
        NullPointerException - if data is null
        IllegalArgumentException - if len is negative

    • Method Detail

      • toStream

        public void toStream​(DataOutput out)
              throws IOException
        Serializes this object to a stream in a form suitable for reading by {@link #MSBearerCapability.GSM(DataInput)}.
        Specified by:
        toStream in interface FastSerializable
        Parameters:
        out - the stream to write to
        Throws:
        IOException - if an I/O error occurs

      • hasTransferMode

        public boolean hasTransferMode()
                        throws DecodeException
        Tests whether the field TransferMode has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasRadioChannelReq

        public boolean hasRadioChannelReq()
                           throws DecodeException
        Tests whether the field RadioChannelReq has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • hasContent

        public boolean hasContent()
                   throws DecodeException
        Tests whether the field Content has a value.
        Returns:
        whether the field has a value
        Throws:
        DecodeException - if encoded state cannot be decoded

      • copyOf

        public static MSBearerCapability.GSM copyOf​(MSBearerCapability.GSM from)
        Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
        Parameters:
        from - the object from which to copy
        Returns:
        GSM

      • getFieldAccessors

        public static FieldAccessor[] getFieldAccessors()
        Gets a new array of the accessors for fields of this type.
        Returns:
        FieldAccessor[]

      • getFieldsMap

        public Map<String,​Object> getFieldsMap​(boolean withAbsents)
        Gets a Map from field-name to field-value for the fields of a sequence. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an uninitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED. For a field of String type, the encoded form is used if the String cannot be decoded. For a type that represents an OCTET STRING that cannot be decoded, a map from "encodedValue" to the byte array value is returned.
        Specified by:
        getFieldsMap in class AbstractFieldsObject
        Parameters:
        withAbsents - whether to put absent optional fields into Map
        Returns:
        Map from field-name to field-value

      • encodedIsInvalid

        protected boolean encodedIsInvalid()
        Determines whether the encoded form is invalid.
        Returns:
        boolean

      • getEncodedForm

        public byte[] getEncodedForm()
                      throws EncodeException
        Gets the encoded form.
        Returns:
        encoded form
        Throws:
        EncodeException - if encoding fails

      • getContainedLength

        public static int getContainedLength​(byte[] data,
                                     int start,
                                     int len)
        Determines the length of the encoded value that commences at offset start in the given data. The value is not fully decoded and might not be decodable. If the encoded value ends with a filling field, then the given len is returned. If the encoded value is so currupt that its length cannot be determined, then 0 is returned.
        Parameters:
        data - network-encoded data
        start - index into data where value commences
        len - length in data to be considered
        Returns:
        length of encoded value, or 0 if not decodable
        Throws:
        NullPointerException - if data is null