5 Model ToC Previous Next

5.8 Alarm model ToC Previous Next

5.8.6 Suppress Method ToC Previous Next

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 AlarmSupressionGroup, 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.

Signature

Suppress();

Method Result Codes in Table 43 (defined in Call Service)

Table 43 – Suppress result codes

Result Code Description
Bad_MethodInvalid The MethodId provided does not correspond to the ObjectId provided. See OPC 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 ConditionType Node.
See OPC 10000-4 for the general description of this result code.

Comments

Suppress Method applies to an Alarm instance, even if it is not currently active.

Table 44 specifies the AddressSpace representation for the Suppress Method.

Table 44 – Suppress Method AddressSpace definition

Attribute Value
BrowseName Suppress
References NodeClass BrowseName DataType TypeDefinition ModellingRule
           
AlwaysGeneratesEvent ObjectType AuditConditionSuppressionEventType Defined in 5.10.4
   

Previous Next