QuickOPC User's Guide and Reference
TimedShelve Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.AlarmsAndConditions.Extensions Namespace > IEasyUAClientExtension Class : TimedShelve Method
The client object that will perform the operation.
Endpoint descriptor. Identifies the OPC-UA server.
Node descriptor. Identifies the node in OPC server's address space.
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.
The TimedShelve Method sets the AlarmCondition to the TimedShelved state.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Sub TimedShelve( _
   ByVal client As IEasyUAClient, _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal objectOrConditionNodeDescriptor As UANodeDescriptor, _
   ByVal shelvingTime As Double _
) 
'Usage
 
Dim client As IEasyUAClient
Dim endpointDescriptor As UAEndpointDescriptor
Dim objectOrConditionNodeDescriptor As UANodeDescriptor
Dim shelvingTime As Double
 
IEasyUAClientExtension.TimedShelve(client, endpointDescriptor, objectOrConditionNodeDescriptor, shelvingTime)

Parameters

client
The client object that will perform the operation.
endpointDescriptor
Endpoint descriptor. Identifies the OPC-UA server.
objectOrConditionNodeDescriptor
Node descriptor. Identifies the node in OPC server's address space.
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.
Remarks
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.
Requirements

Target Platforms: Windows 7 with SP1, Windows Server 2008 R2 with SP1

See Also

Reference

IEasyUAClientExtension Class
IEasyUAClientExtension Members