An abstract type that extends the AcknowledgeableConditionType by introducing an ActiveState, SuppressedState and ShelvingState.
More...
|
StatusCode | OneShotShelve (RequestContext context) |
| Shelves an alarm. More...
|
|
StatusCode | TimedShelve (RequestContext context, double shelvingTime) |
| Shelves an alarm for the specified time. More...
|
|
StatusCode | Unshelve (RequestContext context) |
| Unshelves an alarm. More...
|
|
virtual StatusCode | Suppress (RequestContext context, bool suppress) |
| Suppresses an alarm. More...
|
|
virtual StatusCode | Activate (RequestContext context, bool active) |
| Activates an alarm More...
|
|
override void | UpdateEnabledEffectiveDisplayName () |
| Updates the effect display name for the enabled state. More...
|
|
virtual void | UpdateActiveEffectiveDisplayName () |
| Updates the effective display name for the active state. More...
|
|
| AlarmConditionModel () |
| Initializes a new instance of the AlarmConditionModel class. More...
|
|
| AlarmConditionModel (AlarmConditionModel template) |
| Initializes a new instance of the AlarmConditionModel class. More...
|
|
override void | UpdateEvent (GenericEvent e) |
| Updates the event. 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...
|
|
| AcknowledgeableConditionModel () |
| Initializes a new instance of the AcknowledgeableConditionModel class. More...
|
|
| AcknowledgeableConditionModel (AcknowledgeableConditionModel template) |
| Initializes a new instance of the AcknowledgeableConditionModel class. 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 | ActiveState [get, set] |
| ActiveState when set to TRUE indicates that the situation the Condition is representing currently exists. More...
|
|
new TwoStateVariableModel | EnabledState [get, set] |
| Gets or sets the EnabledState More...
|
|
NodeId | InputNode [get, set] |
| Provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state. More...
|
|
double | MaxTimeShelved [get, set] |
| Optional Property used to set the maximum time that an Alarm Condition may be shelved. More...
|
|
ShelvedStateMachineModel | ShelvingState [get, set] |
| Suggests whether an Alarm shall (temporarily) be prevented from being displayed to the user. More...
|
|
bool | SuppressedOrShelved [get, set] |
| The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition. More...
|
|
TwoStateVariableModel | SuppressedState [get, set] |
| Used internally by a Server to automatically suppress Alarms due to system specific reasons. 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...
|
|
INodeAccessInfo | NodeAccessInfo [get, set] |
| Using a NodeAccessInfo can restrict the access of an event to single scopes. More...
|
|
ModelHandle | ModelHandle [get, set] |
| Gets or sets the metadata handle. More...
|
|
object | UserData [get, set] |
| Gets or sets the user data. More...
|
|
An abstract type that extends the AcknowledgeableConditionType by introducing an ActiveState, SuppressedState and ShelvingState.
The AlarmConditionType inherits all Properties of the AcknowledgeableConditionType. The following states are substates of the TRUE EnabledState.
NodeId UnifiedAutomation.UaServer.AlarmConditionModel.InputNode |
|
getset |
Provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state.
If this Variable is not in the AddressSpace, a Null NodeId shall be provided. In some systems, an Alarm may be calculated based on multiple Variables Values, it is up to the system to determine which Variable’s NodeId is used.
bool UnifiedAutomation.UaServer.AlarmConditionModel.SuppressedOrShelved |
|
getset |
The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition.
When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE and this Alarm is then typically not displayed by the Client. State transitions associated with the Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in either the Suppressed or Shelved state.
UnifiedAutomation.UaServer.ShelvedStateMachineModel