Class MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- AbstractEncodedDataObject<T>
-
- AbstractLazyEncodedDataObject<byte[]>
-
- AbstractLazyEncodedByteArray
-
- com.opencloud.slee.resources.in.datatypes.cc.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a
-
- All Implemented Interfaces:
DataObject
,Serializable
- Enclosing class:
- MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability
public static final class MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a extends AbstractLazyEncodedByteArray
Class O6a represents octets 6a to 6g within a MSBearerCapability.Layer1Capability 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.
O6a ::= SEQUENCE { userRate UserRate, numberOfDataBits NumberOfDataBits, negotiation Negotiation, numberOfStopBits NumberOfStopBits, o6b O6b OPTIONAL }
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 8 7 6 5 4 3 2 1 Octet 6a* ext. 0/1 Number of stop bits Negotiation Number of data bits User rate Octet 6b* ext. 0/1 Intermediate rate NIC on Tx NIC on Rx Parity Octet 6c* ext. 0/1 Connection element Modem type Octet 6d* ext. 0/1 Other modem type Fixed network user rate Octet 6e* ext. 0/1 Acceptable channel codings Maximum number of traffic channels Octet 6f* ext. 0/1 UIMI Wanted air interface user rate Octet 6g* ext. 1 Acceptable channel codings extended Asymmetry indication Spare (00)
The octet numbering in the above table is that used in the cited standard for the octets encoded here.There is a static condition in standard 24.008 that says if octet 6a is present then octet 6b shall also be present, in the GSM encoding. Contradicting that, the standard allows the ext bit in octet 6a to be 1, which would indicate that there is no following octet 6b. As a compromise, this API offers field O6b as an OPTIONAL field, but with this recommendation: you should always provide a value for field O6b.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.Negotiation
Negotiation constants.static class
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.NumberOfDataBits
Enumeration of NumberOfDataBits constants.static class
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.NumberOfStopBits
Enumeration of NumberOfStopBits constants.static class
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b
Class O6b represents data that is relevant to octets 6b* to 6g*.static class
MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.UserRate
UserRate constants.
-
Field Summary
-
Fields inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject
isDecoded
-
Fields inherited from class com.opencloud.slee.resources.cgin.AbstractEncodedDataObject
encoded
-
Fields inherited from class com.opencloud.util.AbstractFieldsObject
FIELD_ABSENT, FIELD_UNINITIALISED
-
-
Constructor Summary
Constructors Constructor Description O6a()
Constructs a new O6a object with no fields set.O6a(byte[] data)
Constructs a new O6a object from network-encoded data.O6a(byte[] data, int start, int len)
Constructs a new O6a object from part of network-encoded data.O6a(DataInput in)
Constructs a new O6a object from data deserialized from a stream that was written bytoStream(DataOutput)
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
checkFieldsSet()
Checks that all mandatory fields are present.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a
clone()
Constructs a copy of this object and everything reachable from it.static MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a
copyOf(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a 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.protected void
decode()
Computes the decoded form from the encoded form.protected void
encode()
Computes the encoded form from the decoded form.protected boolean
encodedIsInvalid()
Determines whether the encoded form is invalid.static int
getContainedLength(byte[] data, int start, int len)
Determines the length of the encoded value that commences at offsetstart
in the givendata
.byte[]
getEncodedForm()
Gets the encoded form.static FieldAccessor[]
getFieldAccessors()
Gets a new array of the accessors for fields of this type.Map<String,Object>
getFieldsMap(boolean withAbsents)
Gets a Map from field-name to field-value for the fields of a sequence.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.Negotiation
getNegotiation()
Gets the value of the negotiation.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.NumberOfDataBits
getNumberOfDataBits()
Gets the value of the number of data bits excluding parity bit if present.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.NumberOfStopBits
getNumberOfStopBits()
Gets the value of the number of Stop Bits.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b
getO6b()
Gets the value of the octets 6b*..6g*.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.UserRate
getUserRate()
Gets the value of the user rate.boolean
hasNegotiation()
Tests whether the field Negotiation has a value.boolean
hasNumberOfDataBits()
Tests whether the field NumberOfDataBits has a value.boolean
hasNumberOfStopBits()
Tests whether the field NumberOfStopBits has a value.boolean
hasO6b()
Tests whether the field O6b has a value.boolean
hasUserRate()
Tests whether the field UserRate has a value.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a
setNegotiation(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.Negotiation value)
Sets the value of the negotiation.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a
setNumberOfDataBits(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.NumberOfDataBits value)
Sets the value of the number of data bits excluding parity bit if present.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a
setNumberOfStopBits(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.NumberOfStopBits value)
Sets the value of the number of Stop Bits.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a
setO6b(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b value)
Sets the value of the octets 6b*..6g*.MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a
setUserRate(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.UserRate value)
Sets the value of the user rate.void
toStream(DataOutput out)
Serializes this object to a stream in a form suitable for reading by {@link #MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a(DataInput)}.-
Methods inherited from class com.opencloud.slee.resources.cgin.AbstractLazyEncodedDataObject
checkDecode, checkModifyAndDecode
-
Methods inherited from class com.opencloud.util.AbstractFieldsObject
equals, hashCode, toString
-
Methods inherited from class com.opencloud.util.AbstractDataObject
checkModify, isReadOnly, setReadOnly
-
-
-
-
Constructor Detail
-
O6a
public O6a()
Constructs a new O6a object with no fields set.
-
O6a
public O6a(byte[] data)
Constructs a new O6a 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
-
O6a
public O6a(byte[] data, int start, int len)
Constructs a new O6a object from part of network-encoded data. The part starts at indexstart
and islen
bytes long. The data is not decoded and might not be decodable.- Parameters:
data
- network-encoded datastart
- starting offset of network-encoded data in byte arraylen
- default length if not predictable- Throws:
NullPointerException
- if data is nullIllegalArgumentException
- if len is negative
-
O6a
public O6a(DataInput in) throws IOException
Constructs a new O6a object from data deserialized from a stream that was written bytoStream(DataOutput)
.- Parameters:
in
- the stream to read from- Throws:
EOFException
- if reading is pre-empted by end-of-fileIOException
- if the data cannot be read
-
-
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.Content.NonSpeech.Layer1Capability.O6a(DataInput)}.- Parameters:
out
- the stream to write to- Throws:
IOException
- if an I/O error occurs
-
hasUserRate
public boolean hasUserRate() throws DecodeException
Tests whether the field UserRate has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
hasNumberOfDataBits
public boolean hasNumberOfDataBits() throws DecodeException
Tests whether the field NumberOfDataBits has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
hasNegotiation
public boolean hasNegotiation() throws DecodeException
Tests whether the field Negotiation has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
hasNumberOfStopBits
public boolean hasNumberOfStopBits() throws DecodeException
Tests whether the field NumberOfStopBits has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
hasO6b
public boolean hasO6b() throws DecodeException
Tests whether the field O6b has a value.- Returns:
- whether the field has a value
- Throws:
DecodeException
- if encoded state cannot be decoded
-
checkFieldsSet
public void checkFieldsSet() throws EncodeException
Checks that all mandatory fields are present. Should be called immediately before all calls to encode().- Specified by:
checkFieldsSet
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
EncodeException
- if any mandatory field is not present
-
getUserRate
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.UserRate getUserRate() throws DecodeException
Gets the value of the user rate.- Returns:
- UserRate representation of the user rate
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getNumberOfDataBits
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.NumberOfDataBits getNumberOfDataBits() throws DecodeException
Gets the value of the number of data bits excluding parity bit if present.- Returns:
- NumberOfDataBits representation of the number of data bits excluding parity bit if present
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getNegotiation
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.Negotiation getNegotiation() throws DecodeException
Gets the value of the negotiation.- Returns:
- Negotiation representation of the negotiation
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getNumberOfStopBits
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.NumberOfStopBits getNumberOfStopBits() throws DecodeException
Gets the value of the number of Stop Bits.- Returns:
- NumberOfStopBits representation of the number of Stop Bits
- Throws:
DecodeException
- if encoded state cannot be decoded
-
getO6b
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b getO6b() throws DecodeException
Gets the value of the octets 6b*..6g*.- Returns:
- O6b representation of the octets 6b*..6g*
- Throws:
DecodeException
- if encoded state cannot be decoded
-
setUserRate
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a setUserRate(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.UserRate value) throws IllegalStateException
Sets the value of the user rate.- Parameters:
value
- UserRate representation of the user rate- Returns:
- this
- Throws:
IllegalStateException
-
setNumberOfDataBits
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a setNumberOfDataBits(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.NumberOfDataBits value) throws IllegalStateException
Sets the value of the number of data bits excluding parity bit if present.- Parameters:
value
- NumberOfDataBits representation of the number of data bits excluding parity bit if present- Returns:
- this
- Throws:
IllegalStateException
-
setNegotiation
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a setNegotiation(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.Negotiation value) throws IllegalStateException
Sets the value of the negotiation.- Parameters:
value
- Negotiation representation of the negotiation- Returns:
- this
- Throws:
IllegalStateException
-
setNumberOfStopBits
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a setNumberOfStopBits(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.NumberOfStopBits value) throws IllegalStateException
Sets the value of the number of Stop Bits.- Parameters:
value
- NumberOfStopBits representation of the number of Stop Bits- Returns:
- this
- Throws:
IllegalStateException
-
setO6b
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a setO6b(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a.O6b value) throws IllegalStateException
Sets the value of the octets 6b*..6g*.- Parameters:
value
- O6b representation of the octets 6b*..6g*- Returns:
- this
- Throws:
IllegalStateException
-
copyOf
public static MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a copyOf(MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a 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:
- O6a
-
clone
public MSBearerCapability.GSM.Content.NonSpeech.Layer1Capability.O6a clone()
Constructs a copy of this object and everything reachable from it.- Specified by:
clone
in interfaceDataObject
- Specified by:
clone
in classAbstractDataObject
- Returns:
- copy of object
-
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 classAbstractFieldsObject
- 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 offsetstart
in the givendata
. The value is not fully decoded and might not be decodable. If the encoded value ends with a filling field, then the givenlen
is returned. If the encoded value is so currupt that its length cannot be determined, then0
is returned.- Parameters:
data
- network-encoded datastart
- index into data where value commenceslen
- length in data to be considered- Returns:
- length of encoded value, or 0 if not decodable
- Throws:
NullPointerException
- if data is null
-
encode
protected void encode() throws EncodeException
Computes the encoded form from the decoded form.- Specified by:
encode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
EncodeException
- if choice does not match already encoded coding standard
-
decode
protected void decode() throws DecodeException
Computes the decoded form from the encoded form.- Specified by:
decode
in classAbstractLazyEncodedDataObject<byte[]>
- Throws:
DecodeException
- if too few or too many octets to be decoded
-
-