OSS NAS Tools for C# for 5G for 3GPP Release 16.6.0
Oss.Nas.Reason Class Reference

Defines the error codes reported by the NAS/C# API. This class permits only a restricted set of instances at run time so its values can be compared using the == or != operator rather than Equals(). More...

Static Public Attributes

static readonly Reason UnexpectedNullReferenceInInput
 Unexpected null reference in input. More...
 
static readonly Reason AttemptToReadPastEndOfEncodedData
 Attempt to read past the end of the encoded data. More...
 
static readonly Reason AttemptToPeekBeyondEndOfEncodedData
 Attempt to read a field beyond the end of the encoded data. More...
 
static readonly Reason AttemptToSetCursorBeyondEndOfEncodedDataBuffer
 Attempt to set the current position beyond the end of the encoded data buffer. More...
 
static readonly Reason IELBelowLowerBoundDetectedInEncodedData
 An information element shorter than its minimum allowed length was detected in the encoded data. More...
 
static readonly Reason IELAboveUpperBoundDetectedInEncodedData
 An information element longer than its maximum allowed length was detected in the encoded data. More...
 
static readonly Reason IEShorterThanItsIELDetectedInEncodedData
 An information element shorter than the length indicated in its IEL field was detected in the encoded data. More...
 
static readonly Reason IELongerThanItsIELDetectedInEncodedData
 An information element longer than the length indicated in its IEL field was detected in the encoded data. More...
 
static readonly Reason IELFieldNotWideEnough
 The IEL field of an information element is not wide enough to contain the length of the information element. More...
 
static readonly Reason LengthOfIEBelowIELLowerBound
 An information element is shorter than its minimum allowed length. More...
 
static readonly Reason LengthOfIEAboveIELUpperBound
 An information element is longer than its maximum allowed length. More...
 
static readonly Reason ChoiceIndexIncompatibleWithOriginatorDetectedInEncodedData
 A choice alternative incompatible with the message originator was detected in the encoded data. More...
 
static readonly Reason ChoiceIndexIncompatibleWithOriginator
 A choice selector incompatible with the message originator was found in the data to be encoded. More...
 
static readonly Reason InvalidChoiceIndexDetectedInEncodedData
 An invalid choice index was detected in the encoded data. More...
 
static readonly Reason InvalidChoiceIndex
 An invalid choice selector was found in the data to be encoded. More...
 
static readonly Reason InvalidSequenceOfLengthDetectedInEncodedData
 An invalid sequence-of value length was detected in the encoded data. More...
 
static readonly Reason InvalidSequenceOfLength
 An invalid sequence-of value length was found in the data to be encoded. More...
 
static readonly Reason InvalidIntegerValue
 An invalid integer value was found in the data to be encoded. More...
 
static readonly Reason InvalidIntegerValueDetectedInEncodedData
 An invalid integer value was detected in the encoded data. More...
 
static readonly Reason InvalidStringLengthDetectedInEncodedData
 An invalid length for an octet, bit, or character string was detected in the encoded data. More...
 
static readonly Reason InvalidStringLength
 An invalid length for an octet, bit, or character string was found in the data to be encoded. More...
 
static readonly Reason InvalidCharacterInStringDetectedInEncodedData
 A character string containing an invalid character was detected in the encoded data. More...
 
static readonly Reason InvalidCharacterInString
 A character string containing an invalid character was found in the data to be encoded. More...
 
static readonly Reason InvalidChoiceSelectionDetectedInEncodedData
 An invalid choice selection value was detected in the encoded data. More...
 
static readonly Reason ForbidViolation
 A forbidden value was found in the data to be encoded. More...
 
static readonly Reason ForbidViolationDetectedInEncodedData
 A forbidden value was detected in the encoded data. More...
 
static readonly Reason RequireViolationDetectedInEncodedData
 A value different from a required value was detected in the encoded data. More...
 
static readonly Reason ValueToBeInterpretedAsAnotherValueDetectedInEncodedData
 A value required to be interpreted as another value was detected in the encoded data. More...
 
static readonly Reason DuplicateIEDetectedInEncodedData
 A duplicate information element was detected in the encoded data. More...
 
static readonly Reason UnknownIEDetectedInEncodedData
 An unknown information element was detected in the encoded data. More...
 
static readonly Reason OutOfSequenceIEDetectedInEncodedData
 An out-of-sequence information element was detected in the encoded data. More...
 
static readonly Reason InvalidOptionalIEInEncodedDataDiscarded
 An invalid optional information element present in the encoded data was discarded. More...
 
static readonly Reason OptionalIEWithRecoverableConditionsInEncodedDataNotDiscarded
 An optional information element with one or more recoverable conditions has not been discarded. More...
 
static readonly Reason DecodedDataIncompleteDueToUnresolvedCriticalCondition
 The decoded data may be incomplete due to an unresolved critical condition that occurred during the decode operation. More...
 
static readonly Reason IELExceedsEncodedDataLength
 The IEL field that value exceeds the length of the encoded data was detected. More...
 
static readonly Reason IELExceedsContainerLength
 The IEL field that value exceeds the length of the enclosing container was detected in the encoded data. More...
 
static readonly Reason OtherError = new Reason("OtherError", 9999)
 

Properties

int ErrorCode [get]
 Returns a numeric code associated with an error. More...
 
string Id [get]
 Returns a meaningful name that identifies an error. More...
 
string Message [get]
 Returns a detailed message associated with an error. More...
 

Detailed Description

Defines the error codes reported by the NAS/C# API. This class permits only a restricted set of instances at run time so its values can be compared using the == or != operator rather than Equals().

Member Data Documentation

◆ AttemptToPeekBeyondEndOfEncodedData

readonly Reason Oss.Nas.Reason.AttemptToPeekBeyondEndOfEncodedData
static
Initial value:
=
new Reason("AttemptToPeekBeyondEndOfEncodedData", 19)

Attempt to read a field beyond the end of the encoded data.

◆ AttemptToReadPastEndOfEncodedData

readonly Reason Oss.Nas.Reason.AttemptToReadPastEndOfEncodedData
static
Initial value:
=
new Reason("AttemptToReadPastEndOfEncodedData", 17)

Attempt to read past the end of the encoded data.

◆ AttemptToSetCursorBeyondEndOfEncodedDataBuffer

readonly Reason Oss.Nas.Reason.AttemptToSetCursorBeyondEndOfEncodedDataBuffer
static
Initial value:
=
new Reason("AttemptToSetCursorBeyondEndOfEncodedDataBuffer", 21)

Attempt to set the current position beyond the end of the encoded data buffer.

◆ ChoiceIndexIncompatibleWithOriginator

readonly Reason Oss.Nas.Reason.ChoiceIndexIncompatibleWithOriginator
static
Initial value:
=
new Reason("ChoiceIndexIncompatibleWithOriginator", 34)

A choice selector incompatible with the message originator was found in the data to be encoded.

◆ ChoiceIndexIncompatibleWithOriginatorDetectedInEncodedData

readonly Reason Oss.Nas.Reason.ChoiceIndexIncompatibleWithOriginatorDetectedInEncodedData
static
Initial value:
=
new Reason("ChoiceIndexIncompatibleWithOriginatorDetectedInEncodedData", 33)

A choice alternative incompatible with the message originator was detected in the encoded data.

◆ DecodedDataIncompleteDueToUnresolvedCriticalCondition

readonly Reason Oss.Nas.Reason.DecodedDataIncompleteDueToUnresolvedCriticalCondition
static
Initial value:
=
new Reason("DecodedDataIncompleteDueToUnresolvedCriticalCondition", 69)

The decoded data may be incomplete due to an unresolved critical condition that occurred during the decode operation.

◆ DuplicateIEDetectedInEncodedData

readonly Reason Oss.Nas.Reason.DuplicateIEDetectedInEncodedData
static
Initial value:
=
new Reason("DuplicateIEDetectedInEncodedData", 64)

A duplicate information element was detected in the encoded data.

◆ ForbidViolation

readonly Reason Oss.Nas.Reason.ForbidViolation
static
Initial value:
=
new Reason("ForbidViolation", 60)

A forbidden value was found in the data to be encoded.

◆ ForbidViolationDetectedInEncodedData

readonly Reason Oss.Nas.Reason.ForbidViolationDetectedInEncodedData
static
Initial value:
=
new Reason("ForbidViolationDetectedInEncodedData", 61)

A forbidden value was detected in the encoded data.

◆ IELAboveUpperBoundDetectedInEncodedData

readonly Reason Oss.Nas.Reason.IELAboveUpperBoundDetectedInEncodedData
static
Initial value:
=
new Reason("IELAboveUpperBoundDetectedInEncodedData", 27)

An information element longer than its maximum allowed length was detected in the encoded data.

◆ IELBelowLowerBoundDetectedInEncodedData

readonly Reason Oss.Nas.Reason.IELBelowLowerBoundDetectedInEncodedData
static
Initial value:
=
new Reason("IELBelowLowerBoundDetectedInEncodedData", 26)

An information element shorter than its minimum allowed length was detected in the encoded data.

◆ IELExceedsContainerLength

readonly Reason Oss.Nas.Reason.IELExceedsContainerLength
static
Initial value:
=
new Reason("IELExceedsContainerLength", 201)

The IEL field that value exceeds the length of the enclosing container was detected in the encoded data.

◆ IELExceedsEncodedDataLength

readonly Reason Oss.Nas.Reason.IELExceedsEncodedDataLength
static
Initial value:
=
new Reason("IELExceedsEncodedDataLength", 200)

The IEL field that value exceeds the length of the encoded data was detected.

◆ IELFieldNotWideEnough

readonly Reason Oss.Nas.Reason.IELFieldNotWideEnough
static
Initial value:
=
new Reason("IELFieldNotWideEnough", 30)

The IEL field of an information element is not wide enough to contain the length of the information element.

◆ IELongerThanItsIELDetectedInEncodedData

readonly Reason Oss.Nas.Reason.IELongerThanItsIELDetectedInEncodedData
static
Initial value:
=
new Reason("IELongerThanItsIELDetectedInEncodedData", 29)

An information element longer than the length indicated in its IEL field was detected in the encoded data.

◆ IEShorterThanItsIELDetectedInEncodedData

readonly Reason Oss.Nas.Reason.IEShorterThanItsIELDetectedInEncodedData
static
Initial value:
=
new Reason("IEShorterThanItsIELDetectedInEncodedData", 28)

An information element shorter than the length indicated in its IEL field was detected in the encoded data.

◆ InvalidCharacterInString

readonly Reason Oss.Nas.Reason.InvalidCharacterInString
static
Initial value:
=
new Reason("InvalidCharacterInString", 57)

A character string containing an invalid character was found in the data to be encoded.

◆ InvalidCharacterInStringDetectedInEncodedData

readonly Reason Oss.Nas.Reason.InvalidCharacterInStringDetectedInEncodedData
static
Initial value:
=
new Reason("InvalidCharacterInStringDetectedInEncodedData", 56)

A character string containing an invalid character was detected in the encoded data.

◆ InvalidChoiceIndex

readonly Reason Oss.Nas.Reason.InvalidChoiceIndex
static
Initial value:
=
new Reason("InvalidChoiceIndex", 38)

An invalid choice selector was found in the data to be encoded.

◆ InvalidChoiceIndexDetectedInEncodedData

readonly Reason Oss.Nas.Reason.InvalidChoiceIndexDetectedInEncodedData
static
Initial value:
=
new Reason("InvalidChoiceIndexDetectedInEncodedData", 37)

An invalid choice index was detected in the encoded data.

◆ InvalidChoiceSelectionDetectedInEncodedData

readonly Reason Oss.Nas.Reason.InvalidChoiceSelectionDetectedInEncodedData
static
Initial value:
=
new Reason("InvalidChoiceSelectionDetectedInEncodedData", 59)

An invalid choice selection value was detected in the encoded data.

◆ InvalidIntegerValue

readonly Reason Oss.Nas.Reason.InvalidIntegerValue
static
Initial value:
=
new Reason("InvalidIntegerValue", 50)

An invalid integer value was found in the data to be encoded.

◆ InvalidIntegerValueDetectedInEncodedData

readonly Reason Oss.Nas.Reason.InvalidIntegerValueDetectedInEncodedData
static
Initial value:
=
new Reason("InvalidIntegerValueDetectedInEncodedData", 51)

An invalid integer value was detected in the encoded data.

◆ InvalidOptionalIEInEncodedDataDiscarded

readonly Reason Oss.Nas.Reason.InvalidOptionalIEInEncodedDataDiscarded
static
Initial value:
=
new Reason("InvalidOptionalIEInEncodedDataDiscarded", 67)

An invalid optional information element present in the encoded data was discarded.

◆ InvalidSequenceOfLength

readonly Reason Oss.Nas.Reason.InvalidSequenceOfLength
static
Initial value:
=
new Reason("InvalidSequenceOfLength", 42)

An invalid sequence-of value length was found in the data to be encoded.

◆ InvalidSequenceOfLengthDetectedInEncodedData

readonly Reason Oss.Nas.Reason.InvalidSequenceOfLengthDetectedInEncodedData
static
Initial value:
=
new Reason("InvalidSequenceOfLengthDetectedInEncodedData", 41)

An invalid sequence-of value length was detected in the encoded data.

◆ InvalidStringLength

readonly Reason Oss.Nas.Reason.InvalidStringLength
static
Initial value:
=
new Reason("InvalidStringLength", 55)

An invalid length for an octet, bit, or character string was found in the data to be encoded.

◆ InvalidStringLengthDetectedInEncodedData

readonly Reason Oss.Nas.Reason.InvalidStringLengthDetectedInEncodedData
static
Initial value:
=
new Reason("InvalidStringLengthDetectedInEncodedData", 54)

An invalid length for an octet, bit, or character string was detected in the encoded data.

◆ LengthOfIEAboveIELUpperBound

readonly Reason Oss.Nas.Reason.LengthOfIEAboveIELUpperBound
static
Initial value:
=
new Reason("LengthOfIEAboveIELUpperBound", 32)

An information element is longer than its maximum allowed length.

◆ LengthOfIEBelowIELLowerBound

readonly Reason Oss.Nas.Reason.LengthOfIEBelowIELLowerBound
static
Initial value:
=
new Reason("LengthOfIEBelowIELLowerBound", 31)

An information element is shorter than its minimum allowed length.

◆ OptionalIEWithRecoverableConditionsInEncodedDataNotDiscarded

readonly Reason Oss.Nas.Reason.OptionalIEWithRecoverableConditionsInEncodedDataNotDiscarded
static
Initial value:
=
new Reason("OptionalIEWithRecoverableConditionsInEncodedDataNotDiscarded", 68)

An optional information element with one or more recoverable conditions has not been discarded.

◆ OtherError

readonly Reason Oss.Nas.Reason.OtherError = new Reason("OtherError", 9999)
static

Unexpected exception.

◆ OutOfSequenceIEDetectedInEncodedData

readonly Reason Oss.Nas.Reason.OutOfSequenceIEDetectedInEncodedData
static
Initial value:
=
new Reason("OutOfSequenceIEDetectedInEncodedData", 66)

An out-of-sequence information element was detected in the encoded data.

◆ RequireViolationDetectedInEncodedData

readonly Reason Oss.Nas.Reason.RequireViolationDetectedInEncodedData
static
Initial value:
=
new Reason("RequireViolationDetectedInEncodedData", 62)

A value different from a required value was detected in the encoded data.

◆ UnexpectedNullReferenceInInput

readonly Reason Oss.Nas.Reason.UnexpectedNullReferenceInInput
static
Initial value:
=
new Reason("UnexpectedNullReferenceInInput", 1)

Unexpected null reference in input.

◆ UnknownIEDetectedInEncodedData

readonly Reason Oss.Nas.Reason.UnknownIEDetectedInEncodedData
static
Initial value:
=
new Reason("UnknownIEDetectedInEncodedData", 65)

An unknown information element was detected in the encoded data.

◆ ValueToBeInterpretedAsAnotherValueDetectedInEncodedData

readonly Reason Oss.Nas.Reason.ValueToBeInterpretedAsAnotherValueDetectedInEncodedData
static
Initial value:
=
new Reason("ValueToBeInterpretedAsAnotherValueDetectedInEncodedData", 63)

A value required to be interpreted as another value was detected in the encoded data.

Property Documentation

◆ ErrorCode

int Oss.Nas.Reason.ErrorCode
get

Returns a numeric code associated with an error.

◆ Id

string Oss.Nas.Reason.Id
get

Returns a meaningful name that identifies an error.

◆ Message

string Oss.Nas.Reason.Message
get

Returns a detailed message associated with an error.