5 Model ToC Previous Next

5.8 Alarm model ToC Previous Next

5.8.11 RemoveFromService Method ToC Previous Next

The RemoveFromService Method is used to suppress a specific Alarm instance. It is only available on an instance of an AlarmConditionType that also exposes the OutOfServiceState. 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 RemoveFromService Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the AlarmConditionType Node.

Signature

RemoveFromService ();

Method result codes in Table 59 (defined in Call Service).

Table 59 – RemoveFromService result codes

Result Code Description
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.

Comments

Instances that do not expose the OutOfService State shall reject RemoveFromService calls. RemoveFromService Method applies to an Alarm instance, even if it is not currently in the Active State.

Table 60 specifies the AddressSpace representation for the RemoveFromService Method.

Table 60 – RemoveFromService Method AddressSpace definition

Attribute Value
BrowseName RemoveFromService
References NodeClass BrowseName DataType TypeDefinition ModellingRule
AlwaysGeneratesEvent ObjectType AuditConditionOutOfServiceEventType Defined in 5.10.12    
ConformanceUnits          
A & C OutOfService          

If Auditing is supported, this Method shall generate an Event of AuditConditionOutOfServiceEventType for all invocations of the Method.

Previous Next