Resource Domain::Resource Trouble ABE::Alarm ABE
Class CrossedThreshold

This class provides crossed threshold information when the alarm is a result of crossing a threshold.
It is an implementation-oriented object, since the information it provides is a summary of information contained in other SID entities.

It consists of :
- Threshold Id, identifying the threshold that caused the alarm
- Indicator Name, identifying the name of performance indicator which crossed the threshold
- Observed Value, providing the value of the performance indicator which crossed the threshold
- Granularity, providing the granularity at which the indicator is evaluated for threshold crossing
- Direction, providing the threshold crossing direction: up or down
- ThresholdQualifier, qualifying the crossed threshold
- Threshold Crossing Description, containing further information on the threshold crossing alarm.

Note that some of the information present in the Threshold object , like indicator name or granularity is repeated here in order to have a contained alarm report.

Attributes
ResourceAlarm alarm alarm
ThresholdCrossingDirection direction direction

Indicates the threshold crossing direction: up or down.

If the threshold applies to a single indicator, then this attribute is mandatory. It can only be omitted for complex threshold involving multiple indicators.

Granularity granularity granularity

Indicates the granularity at which the indicator is evaluated for threshold crossing.

If the threshold applies to a single indicator, then this attribute is mandatory. It can only be omitted for complex threshold involving multiple indicators.

String indicatorName indicatorName

Indicates the name of performance indicator, KPI, gauge or counter which crossed the threshold.

If the threshold applies to a single indicator, then this attribute is mandatory. It can only be omitted for complex threshold involving multiple indicators.

String indicatorUnit indicatorUnit

This attribute identifies the unit of the measurement of the indicator corresponding to the threshold that has been crossed in a free format string.

long observedValue observedValue

Indicates the observed value: the value of the indicator which crossed the threshold. This may be different from the threshold value if, for example, the indicator is a gauge and this gauge only takes on discrete values.

If the threshold applies to a single indicator, then this attribute is mandatory. It can only be omitted for complex threshold involving multiple indicators.

String thresholdCrossingDescription thresholdCrossingDescription

Contains further information on the threshold crossing alarm. Vendors should avoid using this field to put additional information identifying the indicator or the threshold id. The corresponding fields should be use for better alarm quality.

For complex thresholds involving multiple indicators, this field is required to provide a textual description of the threshold crossing condition.

String thresholdId thresholdId

Indicates the identifier of the threshold that caused the alarm.

AttributeValuePair thresholdQualifier thresholdQualifier

This attribute contains a set of name/ value pairs used to qualify the crossed threshold.

When migrating from MTOSI, this attribute can contain the pmLocation and the thresholdType.
For pmLocation, the name would be pmLocation and the values would be Contra_Near_End_Rx, Contra_Far_End_Rx, Near_End_Rx, Near_End_Tx, Far_End_Rx, Far_End_Tx, Bidirectional.
For thresholdType, the name is thresholdType and the possible values are Low, Lowest, Highest and High.


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsdataType
NameCrossedThreshold
Name Expression
NamespaceAlarm ABE
Owned Template Signature
OwnerAlarm ABE
Owning Template Parameter
PackageAlarm ABE
Qualified NameSID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 alarm
Public ResourceAlarm alarm
Constraints:
Properties:

AggregationNone
Alias
AssociationAlarmHasCrossedThreshold
Association End
Class«dataType» CrossedThreshold
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namealarm
Name Expression
Namespace«dataType» CrossedThreshold
Opposite_crossedThresholdInformation
Owner«dataType» CrossedThreshold
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::alarm
Stereotype
Template Parameter
TypeResourceAlarm
Upper1
Upper Value(1)
VisibilityPublic


 direction
Public ThresholdCrossingDirection direction

Indicates the threshold crossing direction: up or down.

If the threshold applies to a single indicator, then this attribute is mandatory. It can only be omitted for complex threshold involving multiple indicators.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» CrossedThreshold
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedirection
Name Expression
Namespace«dataType» CrossedThreshold
Opposite
Owner«dataType» CrossedThreshold
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::direction
Stereotyperequired
Template Parameter
TypeThresholdCrossingDirection
Upper1
Upper Value(1)
VisibilityPublic


 granularity
Public Granularity granularity

Indicates the granularity at which the indicator is evaluated for threshold crossing.

If the threshold applies to a single indicator, then this attribute is mandatory. It can only be omitted for complex threshold involving multiple indicators.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» CrossedThreshold
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namegranularity
Name Expression
Namespace«dataType» CrossedThreshold
Opposite
Owner«dataType» CrossedThreshold
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::granularity
Stereotyperequired
Template Parameter
TypeGranularity
Upper1
Upper Value(1)
VisibilityPublic


 indicatorName
Public String indicatorName

Indicates the name of performance indicator, KPI, gauge or counter which crossed the threshold.

If the threshold applies to a single indicator, then this attribute is mandatory. It can only be omitted for complex threshold involving multiple indicators.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» CrossedThreshold
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameindicatorName
Name Expression
Namespace«dataType» CrossedThreshold
Opposite
Owner«dataType» CrossedThreshold
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::indicatorName
Stereotyperequired
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 indicatorUnit
Public String indicatorUnit

This attribute identifies the unit of the measurement of the indicator corresponding to the threshold that has been crossed in a free format string.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» CrossedThreshold
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameindicatorUnit
Name Expression
Namespace«dataType» CrossedThreshold
Opposite
Owner«dataType» CrossedThreshold
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::indicatorUnit
Stereotyperequired
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 observedValue
Public long observedValue

Indicates the observed value: the value of the indicator which crossed the threshold. This may be different from the threshold value if, for example, the indicator is a gauge and this gauge only takes on discrete values.

If the threshold applies to a single indicator, then this attribute is mandatory. It can only be omitted for complex threshold involving multiple indicators.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» CrossedThreshold
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameobservedValue
Name Expression
Namespace«dataType» CrossedThreshold
Opposite
Owner«dataType» CrossedThreshold
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::observedValue
Stereotyperequired
Template Parameter
Typelong
Upper1
Upper Value(1)
VisibilityPublic


 thresholdCrossingDescription
Public String thresholdCrossingDescription

Contains further information on the threshold crossing alarm. Vendors should avoid using this field to put additional information identifying the indicator or the threshold id. The corresponding fields should be use for better alarm quality.

For complex thresholds involving multiple indicators, this field is required to provide a textual description of the threshold crossing condition.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» CrossedThreshold
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamethresholdCrossingDescription
Name Expression
Namespace«dataType» CrossedThreshold
Opposite
Owner«dataType» CrossedThreshold
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::thresholdCrossingDescription
Stereotyperequired
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 thresholdId
Public String thresholdId

Indicates the identifier of the threshold that caused the alarm.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» CrossedThreshold
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value
MultiplicityNone (1)
NamethresholdId
Name Expression
Namespace«dataType» CrossedThreshold
Opposite
Owner«dataType» CrossedThreshold
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::thresholdId
Stereotyperequired
Template Parameter
TypeString
Upper1
Upper Value
VisibilityPublic


 thresholdQualifier
Public AttributeValuePair thresholdQualifier

This attribute contains a set of name/ value pairs used to qualify the crossed threshold.

When migrating from MTOSI, this attribute can contain the pmLocation and the thresholdType.
For pmLocation, the name would be pmLocation and the values would be Contra_Near_End_Rx, Contra_Far_End_Rx, Near_End_Rx, Near_End_Tx, Far_End_Rx, Far_End_Tx, Bidirectional.
For thresholdType, the name is thresholdType and the possible values are Low, Lowest, Highest and High.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
Class«dataType» CrossedThreshold
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamethresholdQualifier
Name Expression
Namespace«dataType» CrossedThreshold
Opposite
Owner«dataType» CrossedThreshold
Owning Association
Owning Template Parameter
Qualified NameSID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::thresholdQualifier
Stereotyperequired
Template Parameter
TypeAttributeValuePair
Upper*
Upper Value(*)
VisibilityPublic