Errata exists for this version of the document.

The TimedShelve Method sets the instance of AlarmConditionType to the TimedShelved state (parameters are defined in Table 55 and result codes are described in Table 56). Normally, the MethodId found in the Shelving child of the Condition instance and the NodeId of the Shelving object as the ObjectId are passed to the Call Service. However, some Servers do not expose Condition instances in the AddressSpace. Therefore, all Servers shall also allow Clients to call the TimedShelve Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the ShelvedStateMachineType Node.

Signature

TimedShelve(

[in] Duration ShelvingTime

);

Table 55 – TimedShelve 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.

Method Result Codes (defined in Call Service)

Table 56 – TimedShelve result codes

Result Code	Description
Bad_ConditionAlreadyShelved	See Table 103 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 103 for the description of this result code.

Comments

Shelving for some time is quite often used to block nuisance Alarms. For example, an Alarm that occurs more than 10 times in a minute may get shelved for a few minutes.

In some systems the length of time covered by this duration may be limited and the Server may generate an error refusing the provided duration. This limit may be exposed as the MaxTimeShelved Property.

Table 57 specifies the AddressSpace representation for the TimedShelve Method.

Table 57 – TimedShelve Method AddressSpace definition

Attribute	Value
BrowseName	TimedShelve
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
HasProperty	Variable	InputArguments	Argument[]	PropertyType	Mandatory
AlwaysGeneratesEvent	ObjectType	AuditConditionShelvingEventType	Defined in 5.10.7