5 Model ToC Previous Next

5.8 Alarm model ToC Previous Next

5.8.5 Reset2 Method ToC Previous Next

The Reset2 Method extends the Reset Method, by adding an optional Comment. For other functionality see the Reset Method definition.

Signature

Reset2(
[in] LocalizedText	Comment
);

The parameters are defined in Table 46.

Table 46 – Reset2 Method parameters

Argument Description
Comment A localized text to be applied to the Condition.

If the Comment argument is NULL (both locale and text are empty) it will be ignored and any existing comments will remain unchanged. If the comment is to be reset, an empty text with a locale shall be provided.

Method result codes in Table 47 (defined in Call service)

Table 47 – Reset2 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.
Bad_InvalidState The Alarm instance was not latched or is still active or still requires acknowledgement / confirmation. For an Alarm Instance to be reset it must have been in Alarm, and returned to normal and have been acknowledged/confirmed prior to being reset.

Table 48 specifies the AddressSpace representation for the Reset2 Method.

Table 48 – Reset2 Method AddressSpace definition

Attribute Value
BrowseName Reset2
References NodeClass BrowseName DataType TypeDefinition ModellingRule
HasProperty Variable InputArguments Argument[] PropertyType Mandatory
AlwaysGeneratesEvent ObjectType AuditConditionResetEventType Defined in 5.10.11    
ConformanceUnits          
A & C LatchedState          

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

Previous Next