C++ UA Server SDK
1.5.0.318
|
Generated event data class for a AcknowledgeableConditionType. More...
#include <opcua_acknowledgeableconditiontypebase.h>
Inherits OpcUa::ConditionTypeData.
Inherited by OpcUa::AlarmConditionTypeData.
Public Member Functions | |
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 | getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
Get the field value for the passed index. 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... | |
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 | ~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 AcknowledgeableConditionType.
This class contains the auto generated code for the object type AcknowledgeableConditionType 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 AcknowledgeableConditionType:
Browse Name | DataType | TypeDefinition | Modelling Rule | See Also |
---|---|---|---|---|
AckedState | LocalizedText | TwoStateVariableType | Mandatory | getAckedState, setAckedState |
ConfirmedState | LocalizedText | TwoStateVariableType | Optional | getConfirmedState, setConfirmedState |
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 ConditionTypeData 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.
See also AcknowledgeableConditionType for a documentation of the complete Information Model.
OpcUa_Boolean OpcUa::AcknowledgeableConditionTypeData::getAckedState | ( | ) |
Get the event field state bool value for AckedState.
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. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unacknowledged | Acknowledged |
de | Unquittiert | Quittiert |
fr | Non-acquitté | Acquitté |
|
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 AckedState 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
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. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unacknowledged | Acknowledged |
de | Unquittiert | Quittiert |
fr | Non-acquitté | Acquitté |
OpcUa_Boolean OpcUa::AcknowledgeableConditionTypeData::getConfirmedState | ( | ) |
Get the event field state bool value for ConfirmedState.
Indicates whether the Condition requires confirmation.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unconfirmed | Confirmed |
de | Unbestätigt | Bestätigt |
fr | Non-Confirmé | Confirmé |
|
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 ConfirmedState 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
Indicates whether the Condition requires confirmation.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unconfirmed | Confirmed |
de | Unbestätigt | Bestätigt |
fr | Non-Confirmé | Confirmé |
|
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::ConditionTypeData.
Reimplemented in OpcUa::LimitAlarmTypeData, OpcUa::AlarmConditionTypeData, OpcUa::NonExclusiveDeviationAlarmTypeData, OpcUa::NonExclusiveLimitAlarmTypeData, OpcUa::ExclusiveDeviationAlarmTypeData, OpcUa::NonExclusiveRateOfChangeAlarmTypeData, OpcUa::CertificateExpirationAlarmTypeData, OpcUa::OffNormalAlarmTypeData, OpcUa::ExclusiveRateOfChangeAlarmTypeData, OpcUa::ExclusiveLimitAlarmTypeData, OpcUa::NonExclusiveLevelAlarmTypeData, OpcUa::ExclusiveLevelAlarmTypeData, OpcUa::TripAlarmTypeData, OpcUa::DiscreteAlarmTypeData, and OpcUa::SystemOffNormalAlarmTypeData.
void OpcUa::AcknowledgeableConditionTypeData::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.
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::AcknowledgeableConditionTypeData::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.
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::AcknowledgeableConditionTypeData::setAckedState | ( | OpcUa_Boolean | AckedState | ) |
Set the event field state bool value for AckedState.
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. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unacknowledged | Acknowledged |
de | Unquittiert | Quittiert |
fr | Non-acquitté | Acquitté |
void OpcUa::AcknowledgeableConditionTypeData::setAckedState_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::AcknowledgeableConditionTypeData::setAckedStateStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value AckedState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
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. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unacknowledged | Acknowledged |
de | Unquittiert | Quittiert |
fr | Non-acquitté | Acquitté |
void OpcUa::AcknowledgeableConditionTypeData::setConfirmedState | ( | OpcUa_Boolean | ConfirmedState | ) |
Set the event field state bool value for ConfirmedState.
Indicates whether the Condition requires confirmation.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unconfirmed | Confirmed |
de | Unbestätigt | Bestätigt |
fr | Non-Confirmé | Confirmé |
void OpcUa::AcknowledgeableConditionTypeData::setConfirmedState_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::AcknowledgeableConditionTypeData::setConfirmedStateStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value ConfirmedState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
Indicates whether the Condition requires confirmation.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unconfirmed | Confirmed |
de | Unbestätigt | Bestätigt |
fr | Non-Confirmé | Confirmé |