Extends the ConditionType by defining acknowledgement characteristics. It is an abstract type.
More...
|
virtual StatusCode | Acknowledge (RequestContext context, byte[] eventId, LocalizedText comment) |
| Acknowledges an Event Notification for a Condition instance state where AckedState was set to FALSE. More...
|
|
virtual StatusCode | Confirm (RequestContext context, byte[] eventId, LocalizedText comment) |
| Confirms an Event Notification for a Condition instance state where ConfirmedState was set to FALSE. More...
|
|
virtual void | ResetAcked (RequestContext context) |
| Sets the state to unacknownledged and unconfirmed. More...
|
|
override void | UpdateEnabledEffectiveDisplayName () |
| Updates the effect display name for the enabled state. More...
|
|
| AcknowledgeableConditionModel () |
| Initializes a new instance of the AcknowledgeableConditionModel class. More...
|
|
| AcknowledgeableConditionModel (AcknowledgeableConditionModel template) |
| Initializes a new instance of the AcknowledgeableConditionModel class. More...
|
|
override void | UpdateEvent (GenericEvent e) |
| Updates the event. More...
|
|
override CallMethodEventHandler | GetMethodDispatcher (RequestContext context, NodeId objectId, NodeId methodId) |
| Gets the method dispatcher. More...
|
|
override StatusCode | DispatchMethod (RequestContext context, MethodHandle methodHandle, IList< Variant > inputArguments, List< StatusCode > inputArgumentResults, List< Variant > outputArguments) |
| Dispatches the method. More...
|
|
virtual StatusCode | Enable (RequestContext context) |
| Changes a Condition instance to the Disabled state. More...
|
|
virtual StatusCode | Disable (RequestContext context) |
| Change a Condition instance to the enabled state. More...
|
|
virtual StatusCode | AddComment (RequestContext context, byte[] eventId, LocalizedText comment) |
| Applies a comment to a specific state of a Condition instance. More...
|
|
| ConditionModel () |
| Initializes a new instance of the ConditionModel class. More...
|
|
| ConditionModel (ConditionModel template) |
| Initializes a new instance of the ConditionModel class. More...
|
|
| BaseEventModel () |
| Initializes a new instance of the BaseEventModel class. More...
|
|
| BaseEventModel (BaseEventModel template) |
| Initializes a new instance of the BaseEventModel class. More...
|
|
void | NewId () |
| Assigns a new EventId, Time and ReceiveTime to the event. More...
|
|
virtual GenericEvent | CreateEvent (FilterManager manager) |
| Creates the event. More...
|
|
virtual ModelHandle | GetModelHandle (StringTable namespaceUris, object instance) |
| Gets the metadata handle. More...
|
|
virtual DataValue | GetValue (IMapperContext context, ModelMapping mapping) |
| Gets the value associated with the mapping. More...
|
|
virtual bool | SetValue (IMapperContext context, ModelMapping mapping, DataValue value) |
| Sets the value associated with the mapping. More...
|
|
|
TwoStateVariableModel | AckedState [get, set] |
| AckedState when FALSE indicates that the Condition instance requires acknowledgement for the reported Condition state. More...
|
|
TwoStateVariableModel | ConfirmedState [get, set] |
| Indicates whether the Condition requires confirmation. More...
|
|
new TwoStateVariableModel | EnabledState [get, set] |
| Gets or sets the EnabledState More...
|
|
NodeId | BranchId [get, set] |
|
string | ClientUserId [get, set] |
| Is related to the Comment field and contains the identity of the user who inserted the most recent Comment. More...
|
|
ConditionVariableModel
< LocalizedText > | Comment [get, set] |
| Contains the last comment provided for a certain state (ConditionBranch). More...
|
|
NodeId | ConditionClassId [get, set] |
| Specifies in which domain this Condition is used. More...
|
|
LocalizedText | ConditionClassName [get, set] |
|
string | ConditionName [get, set] |
| Identifies the Condition instance that the Event originated from. More...
|
|
TwoStateVariableModel | EnabledState [get, set] |
| EnabledState indicates whether the Condition is enabled. More...
|
|
ConditionVariableModel< ushort > | LastSeverity [get, set] |
| Provides the previous severity of the ConditionBranch. More...
|
|
ConditionVariableModel
< StatusCode > | Quality [get, set] |
| Reveals the status of process values or other resources that this Condition instance is based upon. More...
|
|
bool | Retain [get, set] |
|
IConditionMethods | ConditionMethods [get, set] |
| Gets or sets the Condition methods. More...
|
|
NodeId | NodeId [get, set] |
| The node identifier for a representation of an event in the Server address space. Used mainly for ConditionIds. More...
|
|
byte[] | EventId [get, set] |
| Generated by the server to uniquely identify a particular Event Notification. More...
|
|
NodeId | EventType [get, set] |
| Describes the specific type of Event. More...
|
|
NodeId | SourceNode [get, set] |
| Identifies the Node that the Event originated from. More...
|
|
string | SourceName [get, set] |
| Provides a description of the source of the Event. More...
|
|
DateTime | Time [get, set] |
| Provides the time the Event occurred. More...
|
|
DateTime | ReceiveTime [get, set] |
| Provides the time the OPC UA Server received the Event from the underlying device of another Server. More...
|
|
TimeZoneDataType | LocalTime [get, set] |
| Contains the Offset and the DaylightSavingInOffset flag. More...
|
|
LocalizedText | Message [get, set] |
| Provides a human-readable and localizable text description of the Event. More...
|
|
ushort | Severity [get, set] |
| An indication of the urgency of the Event. More...
|
|
ModelHandle | ModelHandle [get, set] |
| Gets or sets the metadata handle. More...
|
|
object | UserData [get, set] |
| Gets or sets the user data. More...
|
|
Extends the ConditionType by defining acknowledgement characteristics. It is an abstract type.
The AcknowledgeableConditionType inherits all Properties of the ConditionType.
AcknowledgeableConditions expose states to indicate whether a Condition has to be acknowledged or confirmed.
The Confirmed Acknowledge model is typically used to differentiate between acknowledging the presence of a Condition and having done something to address the Condition. For example an Operator receiving a motor high temperature Notification calls the Acknowledge Method to inform the Server that the high temperature has been observed. The Operator then takes some action such as lowering the load on the motor in order to reduce the temperature. The Operator then calls the Confirm Method to inform the Server that a corrective action has been taken.
AckedState when FALSE indicates that the Condition instance requires acknowledgement for the reported Condition state. When the Condition instance is acknowledged the AckedState is set to TRUE. ConfirmedState indicates whether it requires confirmation. The two states are substates of the TRUE EnabledState. The EventId used in the Event Notification is considered the identifier of this state and has to be used when calling the Methods for acknowledgement or confirmation.
A Server may require that previous states be acknowledged. If the acknowledgement of a previous state is still open and a new state also requires acknowledgement, the Server shall create a branch of the Condition instance. In situations where state changes occur in short succession there can be multiple unacknowledged states and the Server has to maintain ConditionBranches for all previous unacknowledged states. These branches will be deleted after they have been acknowledged or if they reached their final state. Clients are expected to keep track of all ConditionBranches where AckedState is FALSE to allow acknowledgement of those. See also UnifiedAutomation.UaServer.ConditionModel for more information about ConditionBranches and the examples in Annex B.1 of Part 9 of the OPC UA Specification. The handling of the AckedState and branches also applies to the ConfirmState.