The TimedShelve Method extends the TimedShelve Method, by adding an optional Comment. For other functionality see the TimedShelve Method definition.
Signature
TimedShelve2(
[in] Duration ShelvingTime
[in] LocalizedTextComment
);
The parameters are defined in Table 84.
Table 84 – TimedShelve2 parameters
|
Argument |
Description |
|
ShelvingTime |
Specifies a fixed time for which the Alarm is to be shelved. The Server may refuse the provided duration. If a MaxTimeShelved Property exist on the Alarm than the Shelving time shall be less than or equal to the value of this Property. |
|
Comment |
A localized text to be applied to the Condition. |
Method Result Codes in Table 85 (defined in Call Service)
Table 85 – TimedShelve2 result codes
|
Result Code |
Description |
|
Bad_ConditionAlreadyShelved |
See Table 137 for the description of this result code. The Alarm is already in TimedShelved state and the system does not allow a reset of the shelved timer. |
|
Bad_ShelvingTimeOutOfRange |
See Table 137 for the description of this result code. |
Table 86 specifies the AddressSpace representation for the TimedShelve2 Method.
Table 86 – TimedShelve2 Method AddressSpace definition
|
Attribute |
Value |
||||
|
BrowseName |
TimedShelve2 |
||||
|
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
HasProperty |
Variable |
InputArguments |
Argument[] |
PropertyType |
Mandatory |
|
AlwaysGeneratesEvent |
ObjectType |
AuditConditionShelvingEventType |
Defined in 5.10.7 |
||
|
ConformanceUnits |
|||||
|
A & C Shelving2 |
|||||
If Auditing is supported, this Method shall generate an Event of AuditConditionShelvingEventType for all invocations of the Method.