| Alarm ABE UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 | ![]() | |
ThresholdCrossingDirection | ![]() |
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 | ![]() |
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 | ![]() |
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 | ![]() |
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 | ![]() |
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 | ![]() |
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 | ![]() |
Indicates the identifier of the threshold that caused the alarm. |
AttributeValuePair | ![]() |
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 Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | dataType |
Name | CrossedThreshold |
Name Expression | |
Namespace | Alarm ABE |
Owned Template Signature | |
Owner | Alarm ABE |
Owning Template Parameter | |
Package | Alarm ABE |
Qualified Name | SID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public ResourceAlarm alarm
Aggregation | None |
Alias | |
Association | AlarmHasCrossedThreshold |
Association End | |
Class | «dataType» CrossedThreshold |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | alarm |
Name Expression | |
Namespace | «dataType» CrossedThreshold |
Opposite | _crossedThresholdInformation |
Owner | «dataType» CrossedThreshold |
Owning Association | |
Owning Template Parameter | |
Qualified Name | SID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::alarm |
Stereotype | |
Template Parameter | |
Type | ResourceAlarm |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «dataType» CrossedThreshold |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | direction |
Name Expression | |
Namespace | «dataType» CrossedThreshold |
Opposite | |
Owner | «dataType» CrossedThreshold |
Owning Association | |
Owning Template Parameter | |
Qualified Name | SID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::direction |
Stereotype | required |
Template Parameter | |
Type | ThresholdCrossingDirection |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «dataType» CrossedThreshold |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | granularity |
Name Expression | |
Namespace | «dataType» CrossedThreshold |
Opposite | |
Owner | «dataType» CrossedThreshold |
Owning Association | |
Owning Template Parameter | |
Qualified Name | SID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::granularity |
Stereotype | required |
Template Parameter | |
Type | Granularity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «dataType» CrossedThreshold |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | indicatorName |
Name Expression | |
Namespace | «dataType» CrossedThreshold |
Opposite | |
Owner | «dataType» CrossedThreshold |
Owning Association | |
Owning Template Parameter | |
Qualified Name | SID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::indicatorName |
Stereotype | required |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «dataType» CrossedThreshold |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | indicatorUnit |
Name Expression | |
Namespace | «dataType» CrossedThreshold |
Opposite | |
Owner | «dataType» CrossedThreshold |
Owning Association | |
Owning Template Parameter | |
Qualified Name | SID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::indicatorUnit |
Stereotype | required |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «dataType» CrossedThreshold |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | observedValue |
Name Expression | |
Namespace | «dataType» CrossedThreshold |
Opposite | |
Owner | «dataType» CrossedThreshold |
Owning Association | |
Owning Template Parameter | |
Qualified Name | SID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::observedValue |
Stereotype | required |
Template Parameter | |
Type | long |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «dataType» CrossedThreshold |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | thresholdCrossingDescription |
Name Expression | |
Namespace | «dataType» CrossedThreshold |
Opposite | |
Owner | «dataType» CrossedThreshold |
Owning Association | |
Owning Template Parameter | |
Qualified Name | SID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::thresholdCrossingDescription |
Stereotype | required |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String thresholdId
Indicates the identifier of the threshold that caused the alarm.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «dataType» CrossedThreshold |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | |
Multiplicity | None (1) |
Name | thresholdId |
Name Expression | |
Namespace | «dataType» CrossedThreshold |
Opposite | |
Owner | «dataType» CrossedThreshold |
Owning Association | |
Owning Template Parameter | |
Qualified Name | SID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::thresholdId |
Stereotype | required |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | |
Visibility | Public |
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.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | «dataType» CrossedThreshold |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | thresholdQualifier |
Name Expression | |
Namespace | «dataType» CrossedThreshold |
Opposite | |
Owner | «dataType» CrossedThreshold |
Owning Association | |
Owning Template Parameter | |
Qualified Name | SID Models::Resource Domain::Resource Trouble ABE::Alarm ABE::CrossedThreshold::thresholdQualifier |
Stereotype | required |
Template Parameter | |
Type | AttributeValuePair |
Upper | * |
Upper Value | (*) |
Visibility | Public |
| Alarm ABE UML Documentation |
Summary:AttributesProperties | Detail:Attributes |