TimedShelve Method (_EasyUAAlarmsAndConditionsClient)

The TimedShelve Method sets the AlarmCondition to the TimedShelved state.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Sub TimedShelve( _
   ByVal endpointDescriptor As Object, _
   ByVal objectOrConditionNodeDescriptor As Object, _
   ByVal millisecondsShelvingTime As Double _
)

'Usage
 
Dim instance As _EasyUAAlarmsAndConditionsClient
Dim endpointDescriptor As Object
Dim objectOrConditionNodeDescriptor As Object
Dim millisecondsShelvingTime As Double
 
instance.TimedShelve(endpointDescriptor, objectOrConditionNodeDescriptor, millisecondsShelvingTime)

void TimedShelve( 
   object endpointDescriptor,
   object objectOrConditionNodeDescriptor,
   double millisecondsShelvingTime
)

void TimedShelve( 
   Object^ endpointDescriptor,
   Object^ objectOrConditionNodeDescriptor,
   double millisecondsShelvingTime
)

Parameters

endpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server.
objectOrConditionNodeDescriptor: Node descriptor. Identifies the node in OPC server's address space.
millisecondsShelvingTime: 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.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

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: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

_EasyUAAlarmsAndConditionsClient Interface
_EasyUAAlarmsAndConditionsClient Members

Send Documentation Feedback. Technical Support