UA Bundle SDK .NET  2.4.0.361
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Modules Pages
Public Member Functions | List of all members
UnifiedAutomation.UaServer.IShelvedStateMachineMethods Interface Reference

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...
 

Detailed Description

The interface for methods implemented on the ShelvedStateMachineModel object.

Member Function Documentation

StatusCode UnifiedAutomation.UaServer.IShelvedStateMachineMethods.OneShotShelve ( RequestContext  context,
ShelvedStateMachineModel  model 
)

Sets the AlarmCondition to the OneShotShelved state.

Method result codes:

ResultCode Description
Bad_AlreadyShelved The Alarm is already in a shelved state. The Alarm is already in OneShotShelved state.
Parameters
context
model
Returns

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IShelvedStateMachineMethods.TimedShelve ( RequestContext  context,
ShelvedStateMachineModel  model,
double  ShelvingTime 
)

Sets the AlarmCondition to the TimedShelved state.

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.
Parameters
context
model
ShelvingTimeSpecifies 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.
Returns

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IShelvedStateMachineMethods.Unshelve ( RequestContext  context,
ShelvedStateMachineModel  model 
)

Unshelve sets the AlarmCondition to the Unshelved state.

Method restult code:

ResultCode Description
Bad_ConditionNotShelved The Alarm is not in the requested shelved state.
Parameters
context
model
Returns

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

The documentation for this interface was generated from the following file: