The Suppress Method is used to suppress a specific Alarm instance. It is only available on an instance of an AlarmConditionType that also exposes the SuppressedState. This Method can be used to change the SuppressedState of an Alarm and overwrite any suppression caused by an associated AlarmSuppressionGroup. This Method works in parallel with any suppression triggered by an AlarmSuppressionGroup, in that if the Method is used to suppress an Alarm, an AlarmSuppressionGroup might clear the suppression.
Normally, the NodeId of the object instance is passed as the ObjectId to the Call Service. However, some Servers do not expose Condition instances in the AddressSpace. Therefore, Servers shall allow Clients to call the Suppress Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the AlarmConditionType Node.
Method Result Codes in Table 51 (defined in Call Service)
Table 51 – Suppress result codes
|Bad_MethodInvalid||The MethodId provided does not correspond to the ObjectId provided. See 10000-4 for the general description of this result code.|
|Bad_NodeIdInvalid||Used to indicate that the specified ObjectId is not valid or that the Method was called on the AlarmConditionType Node.See 10000-4 for the general description of this result code.|
Suppress Method applies to an Alarm instance, even if it is not currently active.
Table 52 specifies the AddressSpace representation for the Suppress Method.
Table 52 – Suppress Method AddressSpace definition
|AlwaysGeneratesEvent||ObjectType||AuditConditionSuppressionEventType||Defined in 5.10.4|
|A & C Suppression by Operator|
If Auditing is supported, this Method shall generate an Event of AuditConditionSuppressionEventType for all invocations of the Method.