C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
OpcUa::DialogConditionTypeData Class Reference

Generated event data class for a DialogConditionType. More...

#include <opcua_dialogconditiontypebase.h>

Inherits OpcUa::ConditionTypeData.

Public Member Functions

 DialogConditionTypeData ()
 Constructs an DialogConditionTypeData object.
 
void initializeAsBranch (DialogConditionTypeBase *pCondition)
 This method is used to initializes the DialogConditionTypeData object with event data from a condition object to create a branch of this condition object. More...
 
void initializeAsBranch (DialogConditionTypeData *pConditionData)
 This method is used to initializes the DialogConditionTypeData 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...
 
void setCancelResponse (OpcUa_Int32 CancelResponse)
 Set the event field value CancelResponse. More...
 
void setCancelResponseStatus (OpcUa_StatusCode status)
 Set a status code for the event field value CancelResponse. More...
 
OpcUa_Int32 getCancelResponse ()
 Get the event field value CancelResponse. More...
 
virtual void getCancelResponseValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value CancelResponse for delivering the event data. More...
 
void setDefaultResponse (OpcUa_Int32 DefaultResponse)
 Set the event field value DefaultResponse. More...
 
void setDefaultResponseStatus (OpcUa_StatusCode status)
 Set a status code for the event field value DefaultResponse. More...
 
OpcUa_Int32 getDefaultResponse ()
 Get the event field value DefaultResponse. More...
 
virtual void getDefaultResponseValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value DefaultResponse for delivering the event data. More...
 
virtual void getDialogStateValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value DialogState for delivering the event data. More...
 
void setDialogState (OpcUa_Boolean dialogState)
 Set the event field state bool value for DialogState. More...
 
void setDialogStateStatus (OpcUa_StatusCode status)
 Set a status code for the event field value DialogState. More...
 
OpcUa_Boolean getDialogState ()
 Get the event field state bool value for DialogState. More...
 
virtual void getDialogState_IdValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value Id for delivering the event data. More...
 
void setDialogState_TransitionTime (const UaDateTime &TransitionTime)
 Set the event field state bool value for TransitionTime.
 
void setDialogState_TransitionTimeStatus (OpcUa_StatusCode status)
 Set a status code for the event field value TransitionTime. More...
 
UaDateTime getDialogState_TransitionTime ()
 Get the event field value TransitionTime.
 
virtual void getDialogState_TransitionTimeValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value TransitionTime for delivering the event data. More...
 
void setLastResponse (OpcUa_Int32 LastResponse)
 Set the event field value LastResponse. More...
 
void setLastResponseStatus (OpcUa_StatusCode status)
 Set a status code for the event field value LastResponse. More...
 
OpcUa_Int32 getLastResponse ()
 Get the event field value LastResponse. More...
 
virtual void getLastResponseValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value LastResponse for delivering the event data. More...
 
void setOkResponse (OpcUa_Int32 OkResponse)
 Set the event field value OkResponse. More...
 
void setOkResponseStatus (OpcUa_StatusCode status)
 Set a status code for the event field value OkResponse. More...
 
OpcUa_Int32 getOkResponse ()
 Get the event field value OkResponse. More...
 
virtual void getOkResponseValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value OkResponse for delivering the event data. More...
 
void setPrompt (const UaLocalizedText &Prompt)
 Set the event field value Prompt. More...
 
void setPromptStatus (OpcUa_StatusCode status)
 Set a status code for the event field value Prompt. More...
 
UaLocalizedText getPrompt ()
 Get the event field value Prompt. More...
 
virtual void getPromptValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value Prompt for delivering the event data. More...
 
void setResponseOptionSet (const UaLocalizedTextArray &ResponseOptionSet)
 Set the event field value ResponseOptionSet. More...
 
void setResponseOptionSetStatus (OpcUa_StatusCode status)
 Set a status code for the event field value ResponseOptionSet. More...
 
void getResponseOptionSet (UaLocalizedTextArray &ResponseOptionSet)
 Get the event field value ResponseOptionSet. More...
 
virtual void getResponseOptionSetValue (Session *pSession, OpcUa_Variant &value)
 Get the event field value ResponseOptionSet 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...
 
ReferenceCountergetConditionDataReferenceCounter ()
 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 NodeAccessInfogetEventAccessInfo () 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 ~DialogConditionTypeData ()
 Destroys the DialogConditionTypeData 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.
 

Detailed Description

Generated event data class for a DialogConditionType.

This class contains the auto generated code for the object type DialogConditionType 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 DialogConditionType:

Browse Name DataType TypeDefinition Modelling Rule See Also
CancelResponse Int32 PropertyType Mandatory getCancelResponse, setCancelResponse
DefaultResponse Int32 PropertyType Mandatory getDefaultResponse, setDefaultResponse
DialogState LocalizedText TwoStateVariableType Mandatory getDialogState, setDialogState
LastResponse Int32 PropertyType Mandatory getLastResponse, setLastResponse
OkResponse Int32 PropertyType Mandatory getOkResponse, setOkResponse
Prompt LocalizedText PropertyType Mandatory getPrompt, setPrompt
ResponseOptionSet LocalizedText PropertyType Mandatory getResponseOptionSet, setResponseOptionSet

Used to represent Conditions as dialogs.

The DialogConditionType inherits all Properties of the ConditionType.

See also DialogConditionType for a documentation of the complete Information Model.

Member Function Documentation

OpcUa_Int32 OpcUa::DialogConditionTypeData::getCancelResponse ( )

Get the event field value CancelResponse.

Provides the index of the response in the ResponseOptionSet array that will cause the Dialog to go into the inactive state without proceeding with the operation described by the prompt.

This allows a Client to identify the Cancel option if a special handling for this option is available. If no Cancel option is available the value of this Property is -1.

void OpcUa::DialogConditionTypeData::getCancelResponseValue ( Session pSession,
OpcUa_Variant value 
)
virtual

Get the event field value CancelResponse 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 index of the response in the ResponseOptionSet array that will cause the Dialog to go into the inactive state without proceeding with the operation described by the prompt.

This allows a Client to identify the Cancel option if a special handling for this option is available. If no Cancel option is available the value of this Property is -1.

OpcUa_Int32 OpcUa::DialogConditionTypeData::getDefaultResponse ( )

Get the event field value DefaultResponse.

Identifies the response option that should be shown as default to the user.

It is the index in the ResponseOptionSet array. If no response option is the default, the value of the Property is -1.

void OpcUa::DialogConditionTypeData::getDefaultResponseValue ( Session pSession,
OpcUa_Variant value 
)
virtual

Get the event field value DefaultResponse 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

Identifies the response option that should be shown as default to the user.

It is the index in the ResponseOptionSet array. If no response option is the default, the value of the Property is -1.

OpcUa_Boolean OpcUa::DialogConditionTypeData::getDialogState ( )

Get the event field state bool value for DialogState.

DialogState when set to TRUE indicates that the Dialog is active and waiting for a response. 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::DialogConditionTypeData::getDialogState_IdValue ( Session pSession,
OpcUa_Variant value 
)
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.

void OpcUa::DialogConditionTypeData::getDialogState_TransitionTimeValue ( Session pSession,
OpcUa_Variant value 
)
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.

void OpcUa::DialogConditionTypeData::getDialogStateValue ( Session pSession,
OpcUa_Variant value 
)
virtual

Get the event field value DialogState 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

DialogState when set to TRUE indicates that the Dialog is active and waiting for a response. 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::DialogConditionTypeData::getFieldData ( OpcUa_UInt32  index,
Session pSession,
OpcUa_Variant data 
)
virtual

Get the field value for the passed index.

Parameters
indexThe index of the selected field.
pSessionThe session context for the method call.
dataThe data for the selected field.

Reimplemented from OpcUa::ConditionTypeData.

OpcUa_Int32 OpcUa::DialogConditionTypeData::getLastResponse ( )

Get the event field value LastResponse.

Contains the last response provided by a Client in the Respond method.

If no previous response exists then the value of the Property is -1.

void OpcUa::DialogConditionTypeData::getLastResponseValue ( Session pSession,
OpcUa_Variant value 
)
virtual

Get the event field value LastResponse 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

Contains the last response provided by a Client in the Respond method.

If no previous response exists then the value of the Property is -1.

OpcUa_Int32 OpcUa::DialogConditionTypeData::getOkResponse ( )

Get the event field value OkResponse.

Provides the index of the OK option in the ResponseOptionSet array.

This choice is the response that will allow the system to proceed with the operation described by the prompt. This allows a Client to identify the OK option if a special handling for this option is available. If no OK option is available the value of this Property is -1.

void OpcUa::DialogConditionTypeData::getOkResponseValue ( Session pSession,
OpcUa_Variant value 
)
virtual

Get the event field value OkResponse 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 index of the OK option in the ResponseOptionSet array.

This choice is the response that will allow the system to proceed with the operation described by the prompt. This allows a Client to identify the OK option if a special handling for this option is available. If no OK option is available the value of this Property is -1.

UaLocalizedText OpcUa::DialogConditionTypeData::getPrompt ( )

Get the event field value Prompt.

Prompt is a dialog prompt to be shown to the user.

void OpcUa::DialogConditionTypeData::getPromptValue ( Session pSession,
OpcUa_Variant value 
)
virtual

Get the event field value Prompt 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

Prompt is a dialog prompt to be shown to the user.

void OpcUa::DialogConditionTypeData::getResponseOptionSet ( UaLocalizedTextArray ResponseOptionSet)

Get the event field value ResponseOptionSet.

Specifies the desired set of responses as array of LocalizedText.

The index in this array is used for the corresponding fields like DefaultResponse, LastResponse and SelectedOption in the Respond method. The recommended Dialog response option names in different locales are listed in the following table.

Locale “en” Locale “de”
Ok OK
Cancel Abbrechen
Yes Ja
No Nein
Abort Abbrechen
Retry Wiederholen
Ignore Ignorieren
Next Nächster
Previous Vorheriger

Typical combinations of response options are

  • OK
  • OK, Cancel
  • Yes, No, Cancel
  • Abort, Retry, Ignore
  • Retry, Cancel
  • Yes, No
void OpcUa::DialogConditionTypeData::getResponseOptionSetValue ( Session pSession,
OpcUa_Variant value 
)
virtual

Get the event field value ResponseOptionSet 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

Specifies the desired set of responses as array of LocalizedText.

The index in this array is used for the corresponding fields like DefaultResponse, LastResponse and SelectedOption in the Respond method. The recommended Dialog response option names in different locales are listed in the following table.

Locale “en” Locale “de”
Ok OK
Cancel Abbrechen
Yes Ja
No Nein
Abort Abbrechen
Retry Wiederholen
Ignore Ignorieren
Next Nächster
Previous Vorheriger

Typical combinations of response options are

  • OK
  • OK, Cancel
  • Yes, No, Cancel
  • Abort, Retry, Ignore
  • Retry, Cancel
  • Yes, No
void OpcUa::DialogConditionTypeData::initializeAsBranch ( DialogConditionTypeBase pCondition)

This method is used to initializes the DialogConditionTypeData 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).

Parameters
pConditionThe condition object .
void OpcUa::DialogConditionTypeData::initializeAsBranch ( DialogConditionTypeData pConditionData)

This method is used to initializes the DialogConditionTypeData 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).

Parameters
pConditionDataThe condition data object .
void OpcUa::DialogConditionTypeData::setCancelResponse ( OpcUa_Int32  CancelResponse)

Set the event field value CancelResponse.

Provides the index of the response in the ResponseOptionSet array that will cause the Dialog to go into the inactive state without proceeding with the operation described by the prompt.

This allows a Client to identify the Cancel option if a special handling for this option is available. If no Cancel option is available the value of this Property is -1.

void OpcUa::DialogConditionTypeData::setCancelResponseStatus ( OpcUa_StatusCode  status)

Set a status code for the event field value CancelResponse.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.

void OpcUa::DialogConditionTypeData::setDefaultResponse ( OpcUa_Int32  DefaultResponse)

Set the event field value DefaultResponse.

Identifies the response option that should be shown as default to the user.

It is the index in the ResponseOptionSet array. If no response option is the default, the value of the Property is -1.

void OpcUa::DialogConditionTypeData::setDefaultResponseStatus ( OpcUa_StatusCode  status)

Set a status code for the event field value DefaultResponse.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.

void OpcUa::DialogConditionTypeData::setDialogState ( OpcUa_Boolean  DialogState)

Set the event field state bool value for DialogState.

DialogState when set to TRUE indicates that the Dialog is active and waiting for a response. 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::DialogConditionTypeData::setDialogState_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::DialogConditionTypeData::setDialogStateStatus ( OpcUa_StatusCode  status)

Set a status code for the event field value DialogState.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.

DialogState when set to TRUE indicates that the Dialog is active and waiting for a response. 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::DialogConditionTypeData::setLastResponse ( OpcUa_Int32  LastResponse)

Set the event field value LastResponse.

Contains the last response provided by a Client in the Respond method.

If no previous response exists then the value of the Property is -1.

void OpcUa::DialogConditionTypeData::setLastResponseStatus ( OpcUa_StatusCode  status)

Set a status code for the event field value LastResponse.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.

void OpcUa::DialogConditionTypeData::setOkResponse ( OpcUa_Int32  OkResponse)

Set the event field value OkResponse.

Provides the index of the OK option in the ResponseOptionSet array.

This choice is the response that will allow the system to proceed with the operation described by the prompt. This allows a Client to identify the OK option if a special handling for this option is available. If no OK option is available the value of this Property is -1.

void OpcUa::DialogConditionTypeData::setOkResponseStatus ( OpcUa_StatusCode  status)

Set a status code for the event field value OkResponse.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.

void OpcUa::DialogConditionTypeData::setPrompt ( const UaLocalizedText Prompt)

Set the event field value Prompt.

Prompt is a dialog prompt to be shown to the user.

void OpcUa::DialogConditionTypeData::setPromptStatus ( OpcUa_StatusCode  status)

Set a status code for the event field value Prompt.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.

void OpcUa::DialogConditionTypeData::setResponseOptionSet ( const UaLocalizedTextArray ResponseOptionSet)

Set the event field value ResponseOptionSet.

Specifies the desired set of responses as array of LocalizedText.

The index in this array is used for the corresponding fields like DefaultResponse, LastResponse and SelectedOption in the Respond method. The recommended Dialog response option names in different locales are listed in the following table.

Locale “en” Locale “de”
Ok OK
Cancel Abbrechen
Yes Ja
No Nein
Abort Abbrechen
Retry Wiederholen
Ignore Ignorieren
Next Nächster
Previous Vorheriger

Typical combinations of response options are

  • OK
  • OK, Cancel
  • Yes, No, Cancel
  • Abort, Retry, Ignore
  • Retry, Cancel
  • Yes, No
void OpcUa::DialogConditionTypeData::setResponseOptionSetStatus ( OpcUa_StatusCode  status)

Set a status code for the event field value ResponseOptionSet.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.


The documentation for this class was generated from the following files: