.NET Based OPC UA Client/Server SDK
3.0.5.474
|
The interface for methods implemented on the ShelvedStateMachineModel object. More...
Inherited by UnifiedAutomation.UaServer.BaseNodeManager.
Public Member Functions | |
StatusCode | OneShotShelve (RequestContext context, ShelvedStateMachineModel model) |
Sets the AlarmCondition to the OneShotShelved state. More... | |
StatusCode | TimedShelve (RequestContext context, ShelvedStateMachineModel model, double ShelvingTime) |
Sets the AlarmCondition to the TimedShelved state. More... | |
StatusCode | Unshelve (RequestContext context, ShelvedStateMachineModel model) |
Unshelve sets the AlarmCondition to the Unshelved state. More... | |
The interface for methods implemented on the ShelvedStateMachineModel object.
StatusCode UnifiedAutomation.UaServer.IShelvedStateMachineMethods.OneShotShelve | ( | RequestContext | context, |
ShelvedStateMachineModel | model | ||
) |
Sets the AlarmCondition to the OneShotShelved state.
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 OneShotShelve method by specifying ConditionId as the ObjectId. The method cannot be called with an ObjectId of the ShelvedStateMachineType Node.
Method Result Codes
ResultCode | Description |
---|---|
Bad_ConditionAlreadyShelved | The Alarm is already in a shelved state. The Alarm is already in OneShotShelved state. |
context | |
model |
Implemented in UnifiedAutomation.UaServer.BaseNodeManager.
StatusCode UnifiedAutomation.UaServer.IShelvedStateMachineMethods.TimedShelve | ( | RequestContext | context, |
ShelvedStateMachineModel | model, | ||
double | ShelvingTime | ||
) |
Sets the AlarmCondition to the TimedShelved state.
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.
Method Result Codes
ResultCode | Description |
---|---|
Bad_ConditionAlreadyShelved | The Alarm is already in a shelved state. The Alarm is already in TimedShelved state and the system does not allow a reset of the shelved timer. |
Bad_ShelvingTimeOutOfRange | The provided Shelving time is outside the range allowed by the Server for Shelving. |
Implemented in UnifiedAutomation.UaServer.BaseNodeManager.
StatusCode UnifiedAutomation.UaServer.IShelvedStateMachineMethods.Unshelve | ( | RequestContext | context, |
ShelvedStateMachineModel | model | ||
) |
Unshelve sets the AlarmCondition to the Unshelved state.
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 Unshelve method by specifying ConditionId as the ObjectId. The method cannot be called with an ObjectId of the ShelvedStateMachineType Node.
Method Result Codes:
ResultCode | Description |
---|---|
Bad_ConditionNotShelved | The Alarm is not in the requested shelved state. |
context | |
model |
Implemented in UnifiedAutomation.UaServer.BaseNodeManager.