C++ Based OPC UA Client/Server/PubSub SDK
1.7.3.505
|
Generated event data class for a AlarmConditionType. More...
#include <opcua_alarmconditiontypebase.h>
Inherits OpcUa::AcknowledgeableConditionTypeData.
Inherited by OpcUa::DiscrepancyAlarmTypeData, OpcUa::DiscreteAlarmTypeData, and OpcUa::LimitAlarmTypeData.
Public Member Functions | |
AlarmConditionTypeData () | |
Constructs an AlarmConditionTypeData object. | |
void | initializeAsBranch (AlarmConditionTypeBase *pCondition) |
This method is used to initializes the AlarmConditionTypeData object with event data from a condition object to create a branch of this condition object. More... | |
void | initializeAsBranch (AlarmConditionTypeData *pConditionData) |
This method is used to initializes the AlarmConditionTypeData object with event data from another condition data object to create a branch of this condition data object. More... | |
virtual void | getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
Get the field value for the passed index. More... | |
virtual void | getActiveStateValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value ActiveState for delivering the event data. More... | |
void | setActiveState (OpcUa_Boolean activeState) |
Set the event field state bool value for ActiveState. More... | |
void | setActiveStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field value ActiveState. More... | |
OpcUa_Boolean | getActiveState () |
Get the event field state bool value for ActiveState. More... | |
void | setActiveState_EffectiveDisplayName (const UaLocalizedText &EffectiveDisplayName) |
Set the event field state bool value for EffectiveDisplayName. | |
void | setActiveState_EffectiveDisplayNameStatus (OpcUa_StatusCode status) |
Set a status code for the event field value EffectiveDisplayName. More... | |
UaLocalizedText | getActiveState_EffectiveDisplayName () |
Get the event field value EffectiveDisplayName. | |
virtual void | getActiveState_EffectiveDisplayNameValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value EffectiveDisplayName for delivering the event data. More... | |
void | setActiveState_EffectiveTransitionTime (const UaDateTime &EffectiveTransitionTime) |
Set the event field state bool value for EffectiveTransitionTime. | |
void | setActiveState_EffectiveTransitionTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value EffectiveTransitionTime. More... | |
UaDateTime | getActiveState_EffectiveTransitionTime () |
Get the event field value EffectiveTransitionTime. | |
virtual void | getActiveState_EffectiveTransitionTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value EffectiveTransitionTime for delivering the event data. More... | |
virtual void | getActiveState_IdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Id for delivering the event data. More... | |
void | setActiveState_TransitionTime (const UaDateTime &TransitionTime) |
Set the event field state bool value for TransitionTime. | |
void | setActiveState_TransitionTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value TransitionTime. More... | |
UaDateTime | getActiveState_TransitionTime () |
Get the event field value TransitionTime. | |
virtual void | getActiveState_TransitionTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value TransitionTime for delivering the event data. More... | |
void | setAudibleEnabled (OpcUa_Boolean AudibleEnabled) |
Set the event field value AudibleEnabled. | |
void | setAudibleEnabledStatus (OpcUa_StatusCode status) |
Set a status code for the event field value AudibleEnabled. More... | |
OpcUa_Boolean | getAudibleEnabled () |
Get the event field value AudibleEnabled. | |
virtual void | getAudibleEnabledValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value AudibleEnabled for delivering the event data. More... | |
void | setAudibleSound (UaByteString &AudibleSound) |
Set the event field value AudibleSound. | |
void | setAudibleSoundStatus (OpcUa_StatusCode status) |
Set a status code for the event field value AudibleSound. More... | |
UaByteString | getAudibleSound () |
Get the event field value AudibleSound. | |
virtual void | getAudibleSoundValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value AudibleSound for delivering the event data. More... | |
void | setFirstInGroupFlag (OpcUa_Boolean FirstInGroupFlag) |
Set the event field value FirstInGroupFlag. | |
void | setFirstInGroupFlagStatus (OpcUa_StatusCode status) |
Set a status code for the event field value FirstInGroupFlag. More... | |
OpcUa_Boolean | getFirstInGroupFlag () |
Get the event field value FirstInGroupFlag. | |
virtual void | getFirstInGroupFlagValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value FirstInGroupFlag for delivering the event data. More... | |
void | setInputNode (const UaNodeId &InputNode) |
Set the event field value InputNode. More... | |
void | setInputNodeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value InputNode. More... | |
UaNodeId | getInputNode () |
Get the event field value InputNode. More... | |
virtual void | getInputNodeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value InputNode for delivering the event data. More... | |
virtual void | getLatchedStateValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value LatchedState for delivering the event data. More... | |
void | setLatchedState (OpcUa_Boolean latchedState) |
Set the event field state bool value for LatchedState. | |
void | setLatchedStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field value LatchedState. More... | |
OpcUa_Boolean | getLatchedState () |
Get the event field state bool value for LatchedState. | |
virtual void | getLatchedState_IdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Id for delivering the event data. More... | |
void | setLatchedState_TransitionTime (const UaDateTime &TransitionTime) |
Set the event field state bool value for TransitionTime. | |
void | setLatchedState_TransitionTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value TransitionTime. More... | |
UaDateTime | getLatchedState_TransitionTime () |
Get the event field value TransitionTime. | |
virtual void | getLatchedState_TransitionTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value TransitionTime for delivering the event data. More... | |
void | setMaxTimeShelved (OpcUa_Double MaxTimeShelved) |
Set the event field value MaxTimeShelved. More... | |
void | setMaxTimeShelvedStatus (OpcUa_StatusCode status) |
Set a status code for the event field value MaxTimeShelved. More... | |
OpcUa_Double | getMaxTimeShelved () |
Get the event field value MaxTimeShelved. More... | |
virtual void | getMaxTimeShelvedValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value MaxTimeShelved for delivering the event data. More... | |
void | setOffDelay (OpcUa_Double OffDelay) |
Set the event field value OffDelay. | |
void | setOffDelayStatus (OpcUa_StatusCode status) |
Set a status code for the event field value OffDelay. More... | |
OpcUa_Double | getOffDelay () |
Get the event field value OffDelay. | |
virtual void | getOffDelayValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value OffDelay for delivering the event data. More... | |
void | setOnDelay (OpcUa_Double OnDelay) |
Set the event field value OnDelay. | |
void | setOnDelayStatus (OpcUa_StatusCode status) |
Set a status code for the event field value OnDelay. More... | |
OpcUa_Double | getOnDelay () |
Get the event field value OnDelay. | |
virtual void | getOnDelayValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value OnDelay for delivering the event data. More... | |
virtual void | getOutOfServiceStateValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value OutOfServiceState for delivering the event data. More... | |
void | setOutOfServiceState (OpcUa_Boolean outOfServiceState) |
Set the event field state bool value for OutOfServiceState. | |
void | setOutOfServiceStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field value OutOfServiceState. More... | |
OpcUa_Boolean | getOutOfServiceState () |
Get the event field state bool value for OutOfServiceState. | |
virtual void | getOutOfServiceState_IdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Id for delivering the event data. More... | |
void | setOutOfServiceState_TransitionTime (const UaDateTime &TransitionTime) |
Set the event field state bool value for TransitionTime. | |
void | setOutOfServiceState_TransitionTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value TransitionTime. More... | |
UaDateTime | getOutOfServiceState_TransitionTime () |
Get the event field value TransitionTime. | |
virtual void | getOutOfServiceState_TransitionTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value TransitionTime for delivering the event data. More... | |
void | setReAlarmRepeatCount (OpcUa_Int16 ReAlarmRepeatCount) |
Set the event field value ReAlarmRepeatCount. | |
void | setReAlarmRepeatCountStatus (OpcUa_StatusCode status) |
Set a status code for the event field value ReAlarmRepeatCount. More... | |
OpcUa_Int16 | getReAlarmRepeatCount () |
Get the event field value ReAlarmRepeatCount. | |
virtual void | getReAlarmRepeatCountValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value ReAlarmRepeatCount for delivering the event data. More... | |
void | setReAlarmTime (OpcUa_Double ReAlarmTime) |
Set the event field value ReAlarmTime. | |
void | setReAlarmTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value ReAlarmTime. More... | |
OpcUa_Double | getReAlarmTime () |
Get the event field value ReAlarmTime. | |
virtual void | getReAlarmTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value ReAlarmTime for delivering the event data. More... | |
void | setShelvedState (ShelvedStateMachineType::ShelvedState state) |
Method used to change the state of the LimitState. More... | |
UaLocalizedText | getShelvingState_CurrentState () |
Get the event field value CurrentState. | |
virtual void | getShelvingState_CurrentStateValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value CurrentState for delivering the event data. More... | |
UaNodeId | getShelvingState_CurrentState_Id () |
Get the event field value Id. | |
virtual void | getShelvingState_CurrentState_IdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Id for delivering the event data. More... | |
UaLocalizedText | getShelvingState_LastTransition () |
Get the event field value LastTransition. | |
virtual void | getShelvingState_LastTransitionValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value LastTransition for delivering the event data. More... | |
UaNodeId | getShelvingState_LastTransition_Id () |
Get the event field value Id. | |
virtual void | getShelvingState_LastTransition_IdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Id for delivering the event data. More... | |
UaDateTime | getShelvingState_LastTransition_TransitionTime () |
Get the event field value TransitionTime. | |
virtual void | getShelvingState_LastTransition_TransitionTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value TransitionTime for delivering the event data. More... | |
void | setShelvingState_UnshelveTime (OpcUa_Double UnshelveTime) |
Set the event field state bool value for UnshelveTime. | |
OpcUa_Double | getShelvingState_UnshelveTime () |
Get the event field value UnshelveTime. | |
virtual void | getShelvingState_UnshelveTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value UnshelveTime for delivering the event data. More... | |
virtual void | getSilenceStateValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value SilenceState for delivering the event data. More... | |
void | setSilenceState (OpcUa_Boolean silenceState) |
Set the event field state bool value for SilenceState. | |
void | setSilenceStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field value SilenceState. More... | |
OpcUa_Boolean | getSilenceState () |
Get the event field state bool value for SilenceState. | |
virtual void | getSilenceState_IdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Id for delivering the event data. More... | |
void | setSilenceState_TransitionTime (const UaDateTime &TransitionTime) |
Set the event field state bool value for TransitionTime. | |
void | setSilenceState_TransitionTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value TransitionTime. More... | |
UaDateTime | getSilenceState_TransitionTime () |
Get the event field value TransitionTime. | |
virtual void | getSilenceState_TransitionTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value TransitionTime for delivering the event data. More... | |
void | setSuppressedOrShelved (OpcUa_Boolean SuppressedOrShelved) |
Set the event field value SuppressedOrShelved. More... | |
void | setSuppressedOrShelvedStatus (OpcUa_StatusCode status) |
Set a status code for the event field value SuppressedOrShelved. More... | |
OpcUa_Boolean | getSuppressedOrShelved () |
Get the event field value SuppressedOrShelved. More... | |
virtual void | getSuppressedOrShelvedValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value SuppressedOrShelved for delivering the event data. More... | |
virtual void | getSuppressedStateValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value SuppressedState for delivering the event data. More... | |
void | setSuppressedState (OpcUa_Boolean suppressedState) |
Set the event field state bool value for SuppressedState. More... | |
void | setSuppressedStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field value SuppressedState. More... | |
OpcUa_Boolean | getSuppressedState () |
Get the event field state bool value for SuppressedState. More... | |
virtual void | getSuppressedState_IdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Id for delivering the event data. More... | |
void | setSuppressedState_TransitionTime (const UaDateTime &TransitionTime) |
Set the event field state bool value for TransitionTime. | |
void | setSuppressedState_TransitionTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value TransitionTime. More... | |
UaDateTime | getSuppressedState_TransitionTime () |
Get the event field value TransitionTime. | |
virtual void | getSuppressedState_TransitionTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value TransitionTime for delivering the event data. More... | |
Public Member Functions inherited from OpcUa::AcknowledgeableConditionTypeData | |
AcknowledgeableConditionTypeData () | |
Constructs an AcknowledgeableConditionTypeData object. | |
void | initializeAsBranch (AcknowledgeableConditionTypeBase *pCondition) |
This method is used to initializes the AcknowledgeableConditionTypeData object with event data from a condition object to create a branch of this condition object. More... | |
void | initializeAsBranch (AcknowledgeableConditionTypeData *pConditionData) |
This method is used to initializes the AcknowledgeableConditionTypeData object with event data from another condition data object to create a branch of this condition data object. More... | |
virtual void | getAckedStateValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value AckedState for delivering the event data. More... | |
void | setAckedState (OpcUa_Boolean ackedState) |
Set the event field state bool value for AckedState. More... | |
void | setAckedStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field value AckedState. More... | |
OpcUa_Boolean | getAckedState () |
Get the event field state bool value for AckedState. More... | |
virtual void | getAckedState_IdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Id for delivering the event data. More... | |
void | setAckedState_TransitionTime (const UaDateTime &TransitionTime) |
Set the event field state bool value for TransitionTime. | |
void | setAckedState_TransitionTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value TransitionTime. More... | |
UaDateTime | getAckedState_TransitionTime () |
Get the event field value TransitionTime. | |
virtual void | getAckedState_TransitionTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value TransitionTime for delivering the event data. More... | |
virtual void | getConfirmedStateValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value ConfirmedState for delivering the event data. More... | |
void | setConfirmedState (OpcUa_Boolean confirmedState) |
Set the event field state bool value for ConfirmedState. More... | |
void | setConfirmedStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field value ConfirmedState. More... | |
OpcUa_Boolean | getConfirmedState () |
Get the event field state bool value for ConfirmedState. More... | |
virtual void | getConfirmedState_IdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Id for delivering the event data. More... | |
void | setConfirmedState_TransitionTime (const UaDateTime &TransitionTime) |
Set the event field state bool value for TransitionTime. | |
void | setConfirmedState_TransitionTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value TransitionTime. More... | |
UaDateTime | getConfirmedState_TransitionTime () |
Get the event field value TransitionTime. | |
virtual void | getConfirmedState_TransitionTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value TransitionTime for delivering the event data. More... | |
Public Member Functions inherited from OpcUa::ConditionTypeData | |
ConditionTypeData () | |
Constructs an ConditionTypeData object. | |
void | initializeAsBranch (ConditionTypeBase *pCondition) |
This method is used to initializes the ConditionTypeData object with event data from a condition object to create a branch of this condition object. More... | |
void | initializeAsBranch (ConditionTypeData *pConditionData) |
This method is used to initializes the ConditionTypeData object with event data from another condition data object to create a branch of this condition data object. More... | |
ReferenceCounter * | getConditionDataReferenceCounter () |
Get the ReferenceCounter interface necessary for condition event data classes. | |
void | setConditionNodeId (const UaNodeId &conditionNodeId) |
Sets the condition NodeId for the event data related to a condition object. | |
virtual UaNodeId | getConditionNodeId () |
Returns the condition NodeId since the event data is related to a condition object. | |
virtual UaNodeId | getConditionBranchNodeId () |
Returns the condition branch NodeId since the event data is related to a condition object. | |
virtual OpcUa_Boolean | getConditionRetain () |
Returns the Retain flag since the event data is related to a condition object. | |
virtual void | lockEventData () |
Lock the event data for data update and event handling. More... | |
virtual void | unlockEventData () |
Unlock the event data after data update or event handling. More... | |
void | setBranchId (const UaNodeId &BranchId) |
Set the event field value BranchId. More... | |
void | setBranchIdStatus (OpcUa_StatusCode status) |
Set a status code for the event field value BranchId. More... | |
UaNodeId | getBranchId () |
Get the event field value BranchId. More... | |
virtual void | getBranchIdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value BranchId for delivering the event data. More... | |
void | setClientUserId (const UaString &ClientUserId) |
Set the event field value ClientUserId. More... | |
void | setClientUserIdStatus (OpcUa_StatusCode status) |
Set a status code for the event field value ClientUserId. More... | |
UaString | getClientUserId () |
Get the event field value ClientUserId. More... | |
virtual void | getClientUserIdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value ClientUserId for delivering the event data. More... | |
void | setComment (const UaLocalizedText &Comment) |
Set the event field value Comment. More... | |
void | setCommentStatus (OpcUa_StatusCode status) |
Set a status code for the event field value Comment. More... | |
UaLocalizedText | getComment () |
Get the event field value Comment. More... | |
virtual void | getCommentValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Comment for delivering the event data. More... | |
void | setComment_SourceTimestamp (const UaDateTime &SourceTimestamp) |
Set the event field state bool value for SourceTimestamp. | |
void | setComment_SourceTimestampStatus (OpcUa_StatusCode status) |
Set a status code for the event field value SourceTimestamp. More... | |
UaDateTime | getComment_SourceTimestamp () |
Get the event field value SourceTimestamp. | |
virtual void | getComment_SourceTimestampValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value SourceTimestamp for delivering the event data. More... | |
void | setConditionClassId (const UaNodeId &ConditionClassId) |
Set the event field value ConditionClassId. More... | |
void | setConditionClassIdStatus (OpcUa_StatusCode status) |
Set a status code for the event field value ConditionClassId. More... | |
UaNodeId | getConditionClassId () |
Get the event field value ConditionClassId. More... | |
virtual void | getConditionClassIdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value ConditionClassId for delivering the event data. More... | |
void | setConditionClassName (const UaLocalizedText &ConditionClassName) |
Set the event field value ConditionClassName. More... | |
void | setConditionClassNameStatus (OpcUa_StatusCode status) |
Set a status code for the event field value ConditionClassName. More... | |
UaLocalizedText | getConditionClassName () |
Get the event field value ConditionClassName. More... | |
virtual void | getConditionClassNameValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value ConditionClassName for delivering the event data. More... | |
void | setConditionName (const UaString &ConditionName) |
Set the event field value ConditionName. More... | |
void | setConditionNameStatus (OpcUa_StatusCode status) |
Set a status code for the event field value ConditionName. More... | |
UaString | getConditionName () |
Get the event field value ConditionName. More... | |
virtual void | getConditionNameValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value ConditionName for delivering the event data. More... | |
void | setConditionSubClassId (const UaNodeIdArray &ConditionSubClassId) |
Set the event field value ConditionSubClassId. | |
void | setConditionSubClassIdStatus (OpcUa_StatusCode status) |
Set a status code for the event field value ConditionSubClassId. More... | |
void | getConditionSubClassId (UaNodeIdArray &ConditionSubClassId) |
Get the event field value ConditionSubClassId. | |
virtual void | getConditionSubClassIdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value ConditionSubClassId for delivering the event data. More... | |
void | setConditionSubClassName (const UaLocalizedTextArray &ConditionSubClassName) |
Set the event field value ConditionSubClassName. | |
void | setConditionSubClassNameStatus (OpcUa_StatusCode status) |
Set a status code for the event field value ConditionSubClassName. More... | |
void | getConditionSubClassName (UaLocalizedTextArray &ConditionSubClassName) |
Get the event field value ConditionSubClassName. | |
virtual void | getConditionSubClassNameValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value ConditionSubClassName for delivering the event data. More... | |
virtual void | getEnabledStateValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value EnabledState for delivering the event data. More... | |
void | setEnabledState (OpcUa_Boolean enabledState) |
Set the event field state bool value for EnabledState. More... | |
void | setEnabledStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field value EnabledState. More... | |
OpcUa_Boolean | getEnabledState () |
Get the event field state bool value for EnabledState. More... | |
void | setEnabledState_EffectiveDisplayName (const UaLocalizedText &EffectiveDisplayName) |
Set the event field state bool value for EffectiveDisplayName. | |
void | setEnabledState_EffectiveDisplayNameStatus (OpcUa_StatusCode status) |
Set a status code for the event field value EffectiveDisplayName. More... | |
UaLocalizedText | getEnabledState_EffectiveDisplayName () |
Get the event field value EffectiveDisplayName. | |
virtual void | getEnabledState_EffectiveDisplayNameValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value EffectiveDisplayName for delivering the event data. More... | |
void | setEnabledState_EffectiveTransitionTime (const UaDateTime &EffectiveTransitionTime) |
Set the event field state bool value for EffectiveTransitionTime. | |
void | setEnabledState_EffectiveTransitionTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value EffectiveTransitionTime. More... | |
UaDateTime | getEnabledState_EffectiveTransitionTime () |
Get the event field value EffectiveTransitionTime. | |
virtual void | getEnabledState_EffectiveTransitionTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value EffectiveTransitionTime for delivering the event data. More... | |
virtual void | getEnabledState_IdValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Id for delivering the event data. More... | |
void | setEnabledState_TransitionTime (const UaDateTime &TransitionTime) |
Set the event field state bool value for TransitionTime. | |
void | setEnabledState_TransitionTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field value TransitionTime. More... | |
UaDateTime | getEnabledState_TransitionTime () |
Get the event field value TransitionTime. | |
virtual void | getEnabledState_TransitionTimeValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value TransitionTime for delivering the event data. More... | |
void | setLastSeverity (OpcUa_UInt16 LastSeverity) |
Set the event field value LastSeverity. More... | |
void | setLastSeverityStatus (OpcUa_StatusCode status) |
Set a status code for the event field value LastSeverity. More... | |
OpcUa_UInt16 | getLastSeverity () |
Get the event field value LastSeverity. More... | |
virtual void | getLastSeverityValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value LastSeverity for delivering the event data. More... | |
void | setLastSeverity_SourceTimestamp (const UaDateTime &SourceTimestamp) |
Set the event field state bool value for SourceTimestamp. | |
void | setLastSeverity_SourceTimestampStatus (OpcUa_StatusCode status) |
Set a status code for the event field value SourceTimestamp. More... | |
UaDateTime | getLastSeverity_SourceTimestamp () |
Get the event field value SourceTimestamp. | |
virtual void | getLastSeverity_SourceTimestampValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value SourceTimestamp for delivering the event data. More... | |
void | setQuality (OpcUa_StatusCode Quality) |
Set the event field value Quality. More... | |
void | setQualityStatus (OpcUa_StatusCode status) |
Set a status code for the event field value Quality. More... | |
OpcUa_StatusCode | getQuality () |
Get the event field value Quality. More... | |
virtual void | getQualityValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Quality for delivering the event data. More... | |
void | setQuality_SourceTimestamp (const UaDateTime &SourceTimestamp) |
Set the event field state bool value for SourceTimestamp. | |
void | setQuality_SourceTimestampStatus (OpcUa_StatusCode status) |
Set a status code for the event field value SourceTimestamp. More... | |
UaDateTime | getQuality_SourceTimestamp () |
Get the event field value SourceTimestamp. | |
virtual void | getQuality_SourceTimestampValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value SourceTimestamp for delivering the event data. More... | |
void | setRetain (OpcUa_Boolean Retain) |
Set the event field value Retain. More... | |
void | setRetainStatus (OpcUa_StatusCode status) |
Set a status code for the event field value Retain. More... | |
OpcUa_Boolean | getRetain () |
Get the event field value Retain. More... | |
virtual void | getRetainValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value Retain for delivering the event data. More... | |
Public Member Functions inherited from BaseEventTypeData | |
BaseEventTypeData () | |
Constructs a BaseEventTypeData object. | |
virtual | ~BaseEventTypeData () |
Destroys the BaseEventTypeData object. | |
virtual void | prepareNewEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &userEventId) |
Initializes the event data fields EventId, Time and ReceiveTime with valid values for the next event. More... | |
virtual UaByteString | getEventId () const |
Get the EventId event field. More... | |
virtual UaNodeId | getEventTypeId () const |
Get the EventType event field. More... | |
virtual void | setSource (const UaNode *pNode) |
Set the SourceNode and SourceName by passing in a node pointer for the source node. | |
virtual void | setSourceNode (const UaNodeId &sourceNode) |
Set the SourceNode event field. More... | |
virtual UaNodeId | getSourceNode () const |
Get the SourceNode event field. More... | |
virtual void | setSourceName (const UaString &sourceName) |
Set the SourceName event field. More... | |
virtual UaString | getSourceName () const |
Get the SourceName event field. More... | |
virtual void | setTime (const UaDateTime &time) |
Set the Time event field. More... | |
virtual UaDateTime | getTime () const |
Get the Time event field. More... | |
virtual void | setReceiveTime (const UaDateTime &receiveTime) |
Set the ReceiveTime event field. More... | |
virtual UaDateTime | getReceiveTime () const |
Get the ReceiveTime event field. More... | |
virtual void | setMessage (const UaLocalizedText &message) |
Set the Message event field. More... | |
virtual UaLocalizedText | getMessage () const |
Get the Message event field. More... | |
virtual void | getMessageValue (Session *pSession, UaVariant &data) |
Get the message field value. More... | |
virtual void | setSeverity (OpcUa_UInt16 severity) |
Set the Severity event field. More... | |
virtual OpcUa_UInt16 | getSeverity () const |
Get the Severity event field. More... | |
virtual void | setLocalTime (const UaTimeZoneDataType &localTime) |
Set the LocalTime event field. More... | |
virtual UaTimeZoneDataType | getLocalTime () const |
Get the LocalTime event field. More... | |
Public Member Functions inherited from UaEventData | |
UaEventData () | |
construction | |
virtual | ~UaEventData () |
destruction | |
void | setEventUserData (OpcUa_Handle pEventUserData) |
Sets the user specific event data to the EventData object. More... | |
OpcUa_Handle | getEventUserData () const |
Returns the user specific event data. | |
const NodeAccessInfo * | getEventAccessInfo () const |
Returns the access info associated with this UaEventData. More... | |
void | useEventAccessInfoFrom (const UaEventData *pOther) |
Set the access info from another node to this node. More... | |
void | setEventAccessInfo (NodeAccessInfo *pAccessInfo) |
Set access info for this UaEventData. More... | |
void | attachEventAccessInfo (NodeAccessInfo *pAccessInfo) |
Set access info for this UaEventData. More... | |
Public Member Functions inherited from ReferenceCounter | |
ReferenceCounter () | |
construction | |
virtual | ~ReferenceCounter () |
destruction | |
Protected Member Functions | |
virtual | ~AlarmConditionTypeData () |
Destroys the AlarmConditionTypeData object. | |
Protected Member Functions inherited from OpcUa::AcknowledgeableConditionTypeData | |
virtual | ~AcknowledgeableConditionTypeData () |
Destroys the AcknowledgeableConditionTypeData object. | |
Protected Member Functions inherited from OpcUa::ConditionTypeData | |
virtual | ~ConditionTypeData () |
Destroys the ConditionTypeData object. | |
Additional Inherited Members | |
Static Public Member Functions inherited from BaseEventTypeData | |
static void | registerEventFields () |
Registers all event type fields with the EventManagerBase. | |
Static Public Member Functions inherited from UaEventData | |
static void | registerEventFields () |
Registers all event type fields with the EventManagerBase. | |
Public Attributes inherited from BaseEventTypeData | |
UaVariant | m_EventId |
Field 01 - EventId. | |
UaNodeId | m_EventTypeId |
Field 02 - EventType. | |
UaVariant | m_SourceNode |
Field 03 - SourceNode. | |
UaVariant | m_SourceName |
Field 04 - SourceName. | |
UaVariant | m_Time |
Field 05 - Time. | |
UaVariant | m_ReceiveTime |
Field 06 - ReceiveTime. | |
UaVariant | m_LocalTime |
Field 07 - LocalTime. | |
UaVariant | m_Message |
Field 08 - Message. | |
UaVariant | m_Severity |
Field 09 - Severity. | |
Generated event data class for a AlarmConditionType.
This class contains the auto generated code for the object type AlarmConditionType providing UaEventData interface for the access to event data containing the current state of the condition for events sent to the client. The class is used for condition events if the condition has no nodes in the address space or for condition branches created as snapshot of the main branch.
Event Fields of the AlarmConditionType:
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.
See also AlarmConditionType for a documentation of the complete Information Model.
OpcUa_Boolean OpcUa::AlarmConditionTypeData::getActiveState | ( | ) |
Get the event field state bool value for ActiveState.
ActiveState when set to TRUE indicates that the situation the Condition is representing currently exists.
When a Condition instance is in the inactive state (ActiveState when set to FALSE), it is representing a situation that has returned to a normal state. The transitions of Conditions to the inactive and Active states are triggered by Server specific actions. Subtypes of the AlarmConditionType will have substate models that further define the Active state. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Inactive | Active |
de | Inaktiv | Aktiv |
fr | Inactive | Active |
|
virtual |
Get the event field value EffectiveDisplayName for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value EffectiveTransitionTime for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value Id for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value TransitionTime for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value ActiveState for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
ActiveState when set to TRUE indicates that the situation the Condition is representing currently exists.
When a Condition instance is in the inactive state (ActiveState when set to FALSE), it is representing a situation that has returned to a normal state. The transitions of Conditions to the inactive and Active states are triggered by Server specific actions. Subtypes of the AlarmConditionType will have substate models that further define the Active state. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Inactive | Active |
de | Inaktiv | Aktiv |
fr | Inactive | Active |
|
virtual |
Get the event field value AudibleEnabled for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
|
virtual |
Get the event field value AudibleSound for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
|
virtual |
Get the field value for the passed index.
index | The index of the selected field. |
pSession | The session context for the method call. |
data | The data for the selected field. |
Reimplemented from OpcUa::AcknowledgeableConditionTypeData.
Reimplemented in OpcUa::LimitAlarmTypeData, OpcUa::NonExclusiveDeviationAlarmTypeData, OpcUa::NonExclusiveLimitAlarmTypeData, OpcUa::ExclusiveDeviationAlarmTypeData, OpcUa::NonExclusiveRateOfChangeAlarmTypeData, OpcUa::CertificateExpirationAlarmTypeData, OpcUa::OffNormalAlarmTypeData, OpcUa::ExclusiveRateOfChangeAlarmTypeData, OpcUa::ExclusiveLimitAlarmTypeData, OpcUa::NonExclusiveLevelAlarmTypeData, OpcUa::DiscrepancyAlarmTypeData, OpcUa::TrustListOutOfDateAlarmTypeData, OpcUa::ExclusiveLevelAlarmTypeData, OpcUa::TripAlarmTypeData, OpcUa::DiscreteAlarmTypeData, OpcUa::SystemOffNormalAlarmTypeData, OpcUaDi::CheckFunctionAlarmTypeData, OpcUaDi::DeviceHealthDiagnosticAlarmTypeData, OpcUaDi::FailureAlarmTypeData, OpcUaDi::MaintenanceRequiredAlarmTypeData, OpcUaDi::OffSpecAlarmTypeData, OpcUa::InstrumentDiagnosticAlarmTypeData, and OpcUa::SystemDiagnosticAlarmTypeData.
|
virtual |
Get the event field value FirstInGroupFlag for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
UaNodeId OpcUa::AlarmConditionTypeData::getInputNode | ( | ) |
Get the event field value InputNode.
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.
|
virtual |
Get the event field value InputNode for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
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.
|
virtual |
Get the event field value Id for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value TransitionTime for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value LatchedState for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
OpcUa_Double OpcUa::AlarmConditionTypeData::getMaxTimeShelved | ( | ) |
Get the event field value MaxTimeShelved.
Optional Property used to set the maximum time that an Alarm Condition may be shelved.
The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. If this Property is present it will be an upper limit on the duration passed into a TimedShelve method call. If a value that exceeds the value of this property is passed to the TimedShelve method, then a Bad_ShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will also be enforced for the OneShotShelved state, in that a Alarm Condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this Property expires following a OneShotShelve operation without a change of any of the other items associated with the Condition.
|
virtual |
Get the event field value MaxTimeShelved for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
Optional Property used to set the maximum time that an Alarm Condition may be shelved.
The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. If this Property is present it will be an upper limit on the duration passed into a TimedShelve method call. If a value that exceeds the value of this property is passed to the TimedShelve method, then a Bad_ShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will also be enforced for the OneShotShelved state, in that a Alarm Condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this Property expires following a OneShotShelve operation without a change of any of the other items associated with the Condition.
|
virtual |
Get the event field value OffDelay for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
|
virtual |
Get the event field value OnDelay for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
|
virtual |
Get the event field value Id for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value TransitionTime for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value OutOfServiceState for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
|
virtual |
Get the event field value ReAlarmRepeatCount for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
|
virtual |
Get the event field value ReAlarmTime for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
|
virtual |
Get the event field value Id for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value CurrentState for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value Id for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value TransitionTime for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value LastTransition for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value UnshelveTime for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value Id for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value TransitionTime for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value SilenceState for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
OpcUa_Boolean OpcUa::AlarmConditionTypeData::getSuppressedOrShelved | ( | ) |
Get the event field value SuppressedOrShelved.
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.
|
virtual |
Get the event field value SuppressedOrShelved for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
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.
OpcUa_Boolean OpcUa::AlarmConditionTypeData::getSuppressedState | ( | ) |
Get the event field state bool value for SuppressedState.
Used internally by a Server to automatically suppress Alarms due to system specific reasons.
For example, a system may be configured to suppress Alarms that are associated with machinery that is shut down, such as a low level Alarm for a tank that is currently not in use. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unsuppressed | Suppressed |
de | Nicht unterdrückt | Unterdrückt |
fr | Présent | Supprimé |
|
virtual |
Get the event field value Id for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value TransitionTime for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client.
|
virtual |
Get the event field value SuppressedState for delivering the event data.
This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client
Used internally by a Server to automatically suppress Alarms due to system specific reasons.
For example, a system may be configured to suppress Alarms that are associated with machinery that is shut down, such as a low level Alarm for a tank that is currently not in use. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unsuppressed | Suppressed |
de | Nicht unterdrückt | Unterdrückt |
fr | Présent | Supprimé |
void OpcUa::AlarmConditionTypeData::initializeAsBranch | ( | AlarmConditionTypeBase * | pCondition | ) |
This method is used to initializes the AlarmConditionTypeData object with event data from a condition object to create a branch of this condition object.
The method creates a unique BranchId. EventManagerBase::fireEvent() is used send the intial branch state and status updates for the branch to the client(s). It is necessary to update the timestamps and the EventId for every update sent to the client(s).
pCondition | The condition object . |
void OpcUa::AlarmConditionTypeData::initializeAsBranch | ( | AlarmConditionTypeData * | pConditionData | ) |
This method is used to initializes the AlarmConditionTypeData object with event data from another condition data object to create a branch of this condition data object.
The method creates a unique BranchId. EventManagerBase::fireEvent() is used to send the intial branch state and status updates for the branch to the client(s). It is necessary to update the timestamps and the EventId for every update sent to the client(s).
pConditionData | The condition data object . |
void OpcUa::AlarmConditionTypeData::setActiveState | ( | OpcUa_Boolean | ActiveState | ) |
Set the event field state bool value for ActiveState.
ActiveState when set to TRUE indicates that the situation the Condition is representing currently exists.
When a Condition instance is in the inactive state (ActiveState when set to FALSE), it is representing a situation that has returned to a normal state. The transitions of Conditions to the inactive and Active states are triggered by Server specific actions. Subtypes of the AlarmConditionType will have substate models that further define the Active state. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Inactive | Active |
de | Inaktiv | Aktiv |
fr | Inactive | Active |
void OpcUa::AlarmConditionTypeData::setActiveState_EffectiveDisplayNameStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value EffectiveDisplayName.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setActiveState_EffectiveTransitionTimeStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value EffectiveTransitionTime.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setActiveState_TransitionTimeStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value TransitionTime.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setActiveStateStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value ActiveState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
ActiveState when set to TRUE indicates that the situation the Condition is representing currently exists.
When a Condition instance is in the inactive state (ActiveState when set to FALSE), it is representing a situation that has returned to a normal state. The transitions of Conditions to the inactive and Active states are triggered by Server specific actions. Subtypes of the AlarmConditionType will have substate models that further define the Active state. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Inactive | Active |
de | Inaktiv | Aktiv |
fr | Inactive | Active |
void OpcUa::AlarmConditionTypeData::setAudibleEnabledStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value AudibleEnabled.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setAudibleSoundStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value AudibleSound.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setFirstInGroupFlagStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value FirstInGroupFlag.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setInputNode | ( | const UaNodeId & | InputNode | ) |
Set the event field value InputNode.
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.
void OpcUa::AlarmConditionTypeData::setInputNodeStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value InputNode.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setLatchedState_TransitionTimeStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value TransitionTime.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setLatchedStateStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value LatchedState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setMaxTimeShelved | ( | OpcUa_Double | MaxTimeShelved | ) |
Set the event field value MaxTimeShelved.
Optional Property used to set the maximum time that an Alarm Condition may be shelved.
The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. If this Property is present it will be an upper limit on the duration passed into a TimedShelve method call. If a value that exceeds the value of this property is passed to the TimedShelve method, then a Bad_ShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will also be enforced for the OneShotShelved state, in that a Alarm Condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this Property expires following a OneShotShelve operation without a change of any of the other items associated with the Condition.
void OpcUa::AlarmConditionTypeData::setMaxTimeShelvedStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value MaxTimeShelved.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setOffDelayStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value OffDelay.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setOnDelayStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value OnDelay.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setOutOfServiceState_TransitionTimeStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value TransitionTime.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setOutOfServiceStateStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value OutOfServiceState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setReAlarmRepeatCountStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value ReAlarmRepeatCount.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setReAlarmTimeStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value ReAlarmTime.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setShelvedState | ( | ShelvedStateMachineType::ShelvedState | state | ) |
Method used to change the state of the LimitState.
state | the new state of the LimitState state machine |
void OpcUa::AlarmConditionTypeData::setSilenceState_TransitionTimeStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value TransitionTime.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setSilenceStateStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value SilenceState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setSuppressedOrShelved | ( | OpcUa_Boolean | SuppressedOrShelved | ) |
Set the event field value SuppressedOrShelved.
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.
void OpcUa::AlarmConditionTypeData::setSuppressedOrShelvedStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value SuppressedOrShelved.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setSuppressedState | ( | OpcUa_Boolean | SuppressedState | ) |
Set the event field state bool value for SuppressedState.
Used internally by a Server to automatically suppress Alarms due to system specific reasons.
For example, a system may be configured to suppress Alarms that are associated with machinery that is shut down, such as a low level Alarm for a tank that is currently not in use. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unsuppressed | Suppressed |
de | Nicht unterdrückt | Unterdrückt |
fr | Présent | Supprimé |
void OpcUa::AlarmConditionTypeData::setSuppressedState_TransitionTimeStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value TransitionTime.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
void OpcUa::AlarmConditionTypeData::setSuppressedStateStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value SuppressedState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
Used internally by a Server to automatically suppress Alarms due to system specific reasons.
For example, a system may be configured to suppress Alarms that are associated with machinery that is shut down, such as a low level Alarm for a tank that is currently not in use. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unsuppressed | Suppressed |
de | Nicht unterdrückt | Unterdrückt |
fr | Présent | Supprimé |