C++ UA Server SDK
1.5.2.336
|
Generated base class for a DialogConditionType. More...
#include <opcua_dialogconditiontypebase.h>
Inherits OpcUa::ConditionType.
Inherited by OpcUa::DialogConditionType.
Public Member Functions | |
DialogConditionTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the DialogConditionType condition type using an instance declaration node as base. | |
DialogConditionTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the DialogConditionType condition type. | |
DialogConditionTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class DialogConditionTypeBase with all components. More... | |
virtual UaNodeId | typeDefinitionId () const |
Returns the type definition NodeId for the DialogConditionType. | |
virtual void | getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
Get the field value for the passed index. More... | |
void | clearFieldData () |
Clears the event field data after event processing. | |
UaNodeId | createBranch () |
Creates a new branch from the current state and adds the branch to a list managed by the condition object. More... | |
virtual UaStatus | beginCall (MethodManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments) |
Call method of an UA object. More... | |
virtual UaStatus | call (const ServiceContext &serviceContext, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments, UaVariantArray &outputArguments, UaStatusCodeArray &inputArgumentResults, UaDiagnosticInfos &inputArgumentDiag) |
Synchronous version of the MethodManager method call executed in a worker thread. | |
virtual UaStatus | Respond (const ServiceContext &serviceContext, OpcUa_Int32 SelectedResponse)=0 |
Respond is used to pass the selected response option and end the dialog. More... | |
virtual void | setCancelResponse (OpcUa_Int32 CancelResponse) |
Sets the CancelResponse value. More... | |
virtual OpcUa_Int32 | getCancelResponse () const |
Returns the value of CancelResponse. More... | |
virtual void | setCancelResponseStatus (OpcUa_StatusCode status) |
Set a status code for the event field CancelResponse. More... | |
virtual void | getCancelResponseValue (Session *pSession, UaVariant &value) |
Sets the value of CancelResponse to argument value. More... | |
virtual void | setDefaultResponse (OpcUa_Int32 DefaultResponse) |
Sets the DefaultResponse value. More... | |
virtual OpcUa_Int32 | getDefaultResponse () const |
Returns the value of DefaultResponse. More... | |
virtual void | setDefaultResponseStatus (OpcUa_StatusCode status) |
Set a status code for the event field DefaultResponse. More... | |
virtual void | getDefaultResponseValue (Session *pSession, UaVariant &value) |
Sets the value of DefaultResponse to argument value. More... | |
virtual void | setDialogState (OpcUa_Boolean dialogState) |
Sets the DialogState. More... | |
virtual OpcUa_Boolean | getDialogStateBool () |
Returns the boolean value of the DialogState. More... | |
virtual UaLocalizedText | getDialogState () |
Returns the LocalizedText representation of the DialogState. More... | |
virtual void | setDialogStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field DialogState. More... | |
virtual void | getDialogStateValue (Session *pSession, UaVariant &value) |
Sets the value of DialogState to argument value. More... | |
virtual void | setLastResponse (OpcUa_Int32 LastResponse) |
Sets the LastResponse value. More... | |
virtual OpcUa_Int32 | getLastResponse () const |
Returns the value of LastResponse. More... | |
virtual void | setLastResponseStatus (OpcUa_StatusCode status) |
Set a status code for the event field LastResponse. More... | |
virtual void | getLastResponseValue (Session *pSession, UaVariant &value) |
Sets the value of LastResponse to argument value. More... | |
virtual void | setOkResponse (OpcUa_Int32 OkResponse) |
Sets the OkResponse value. More... | |
virtual OpcUa_Int32 | getOkResponse () const |
Returns the value of OkResponse. More... | |
virtual void | setOkResponseStatus (OpcUa_StatusCode status) |
Set a status code for the event field OkResponse. More... | |
virtual void | getOkResponseValue (Session *pSession, UaVariant &value) |
Sets the value of OkResponse to argument value. More... | |
virtual void | setPrompt (const UaLocalizedText &Prompt) |
Sets the Prompt value. More... | |
virtual UaLocalizedText | getPrompt (Session *pSession) const |
Returns the value of Prompt. More... | |
virtual void | setPromptStatus (OpcUa_StatusCode status) |
Set a status code for the event field Prompt. More... | |
virtual void | getPromptValue (Session *pSession, UaVariant &value) |
Sets the value of Prompt to argument value. More... | |
virtual void | setResponseOptionSet (const UaLocalizedTextArray &ResponseOptionSet) |
Sets the ResponseOptionSet. More... | |
virtual void | getResponseOptionSet (UaLocalizedTextArray &ResponseOptionSet) const |
Gets the ResponseOptionSet. More... | |
virtual void | setResponseOptionSetStatus (OpcUa_StatusCode status) |
Set a status code for the event field ResponseOptionSet. More... | |
virtual void | getResponseOptionSetValue (Session *pSession, UaVariant &value) |
Sets the value of ResponseOptionSet to argument value. More... | |
virtual OpcUa::PropertyType * | getCancelResponseNode () |
Returns the CancelResponse node. More... | |
virtual OpcUa::PropertyType * | getDefaultResponseNode () |
Returns the DefaultResponse node. More... | |
virtual OpcUa::TwoStateVariableType * | getDialogStateNode () |
Returns the DialogState node. More... | |
virtual OpcUa::PropertyType * | getLastResponseNode () |
Returns the LastResponse node. More... | |
virtual OpcUa::PropertyType * | getOkResponseNode () |
Returns the OkResponse node. More... | |
virtual OpcUa::PropertyType * | getPromptNode () |
Returns the Prompt node. More... | |
virtual OpcUa::PropertyType * | getResponseOptionSetNode () |
Returns the ResponseOptionSet node. More... | |
virtual void | useAccessInfoFromType () |
Applies the NodeAccessInfo set at the DialogConditionTypeBase and its children. More... | |
void | useAccessInfoFromInstance (DialogConditionTypeBase *pInstance) |
Uses the NodeAccessInfo of pOther and its children. More... | |
virtual UaStatus | triggerEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &eventId) |
Send event with current event field data to the subscribed clients. More... | |
virtual void | getDialogConditionTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
Get the field value for the passed index for optional fields of the DialogConditionType. More... | |
Public Member Functions inherited from OpcUa::ConditionType | |
ConditionType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Construction of the class ConditionType. More... | |
ConditionType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Construction of the class ConditionType. More... | |
ConditionType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class ConditionType with all components. More... | |
ReferenceCounter * | getConditionDataReferenceCounter () |
Get the ReferenceCounter interface necessary for condition event data classes. | |
virtual UaStatus | AddComment (const ServiceContext &serviceContext, UaByteString &EventId, const UaLocalizedText &Comment) |
Applies a comment to a specific state of a Condition instance. More... | |
virtual UaStatus | Disable (const ServiceContext &serviceContext) |
Changes a Condition instance to the Disabled state. More... | |
virtual UaStatus | Enable (const ServiceContext &serviceContext) |
Changes a Condition instance to the enabled state. More... | |
virtual UaNodeId | getConditionNodeId () |
Returns the condition NodeId for the condition object. More... | |
virtual UaNodeId | getConditionBranchNodeId () |
Returns the condition branch NodeId for the condition object. More... | |
virtual OpcUa_Boolean | getConditionRetain () |
Returns the Retain flag for the condition object. More... | |
OpcUa_UInt32 | getBranchCount () |
Returns the number of active branches. More... | |
ConditionTypeData * | getBranch (const UaNodeId &branchNodeId) |
Returns a pointer to the branch event data based on the passed branch NodeId. More... | |
ConditionTypeData * | getBranchByEventId (const UaByteString &eventId, UaByteString &userEventId) |
Returns a pointer to the branch event data based on the passed EventId. More... | |
void | getAllBranches (UaPointerArray< ConditionTypeData > &branchArray) |
Returns an array of the available branches. More... | |
OpcUa_StatusCode | deleteBranch (const UaNodeId &branchNodeId) |
Deletes the branch identified by the branch NodeId. More... | |
UaStatus | triggerBranchEvent (ConditionTypeData *pConditionTypeData, const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &eventId) |
Send event with event field data of the passed condition branch to the subscribed clients. More... | |
virtual void | setInvalid () |
Set the entry to invalid. More... | |
Public Member Functions inherited from OpcUa::ConditionTypeBase | |
ConditionTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the ConditionType condition type using an instance declaration node as base. | |
ConditionTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the ConditionType condition type. | |
ConditionTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class ConditionTypeBase with all components. More... | |
void | clearFieldData () |
Clears the event field data after event processing. | |
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... | |
virtual void | setBranchId (const UaNodeId &BranchId) |
Sets the BranchId value. More... | |
virtual UaNodeId | getBranchId () const |
Returns the value of BranchId. More... | |
virtual void | setBranchIdStatus (OpcUa_StatusCode status) |
Set a status code for the event field BranchId. More... | |
virtual void | getBranchIdValue (Session *pSession, UaVariant &value) |
Sets the value of BranchId to argument value. More... | |
virtual void | setClientUserId (const UaString &ClientUserId) |
Sets the ClientUserId value. More... | |
virtual UaString | getClientUserId () const |
Returns the value of ClientUserId. More... | |
virtual void | setClientUserIdStatus (OpcUa_StatusCode status) |
Set a status code for the event field ClientUserId. More... | |
virtual void | getClientUserIdValue (Session *pSession, UaVariant &value) |
Sets the value of ClientUserId to argument value. More... | |
virtual void | setComment (const UaLocalizedText &Comment) |
Sets the Comment value. More... | |
virtual UaLocalizedText | getComment (Session *pSession) const |
Returns the value of Comment. More... | |
virtual void | setCommentStatus (OpcUa_StatusCode status) |
Set a status code for the event field Comment. More... | |
virtual void | getCommentValue (Session *pSession, UaVariant &value) |
Sets the value of Comment to argument value. More... | |
virtual void | setConditionClassId (const UaNodeId &ConditionClassId) |
Sets the ConditionClassId value. More... | |
virtual UaNodeId | getConditionClassId () const |
Returns the value of ConditionClassId. More... | |
virtual void | setConditionClassIdStatus (OpcUa_StatusCode status) |
Set a status code for the event field ConditionClassId. More... | |
virtual void | getConditionClassIdValue (Session *pSession, UaVariant &value) |
Sets the value of ConditionClassId to argument value. More... | |
virtual void | setConditionClassName (const UaLocalizedText &ConditionClassName) |
Sets the ConditionClassName value. More... | |
virtual UaLocalizedText | getConditionClassName (Session *pSession) const |
Returns the value of ConditionClassName. More... | |
virtual void | setConditionClassNameStatus (OpcUa_StatusCode status) |
Set a status code for the event field ConditionClassName. More... | |
virtual void | getConditionClassNameValue (Session *pSession, UaVariant &value) |
Sets the value of ConditionClassName to argument value. More... | |
virtual void | setConditionName (const UaString &ConditionName) |
Sets the ConditionName value. More... | |
virtual UaString | getConditionName () const |
Returns the value of ConditionName. More... | |
virtual void | setConditionNameStatus (OpcUa_StatusCode status) |
Set a status code for the event field ConditionName. More... | |
virtual void | getConditionNameValue (Session *pSession, UaVariant &value) |
Sets the value of ConditionName to argument value. More... | |
virtual void | setEnabledState (OpcUa_Boolean enabledState) |
Sets the EnabledState. More... | |
virtual OpcUa_Boolean | getEnabledStateBool () |
Returns the boolean value of the EnabledState. More... | |
virtual UaLocalizedText | getEnabledState () |
Returns the LocalizedText representation of the EnabledState. More... | |
virtual void | setEnabledStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field EnabledState. More... | |
virtual void | getEnabledStateValue (Session *pSession, UaVariant &value) |
Sets the value of EnabledState to argument value. More... | |
virtual void | getEnabledState_EffectiveDisplayNameValue (Session *pSession, OpcUa_Variant &value) |
Sets the value of the EffectiveDisplayName property to value. More... | |
virtual void | setLastSeverity (OpcUa_UInt16 LastSeverity) |
Sets the LastSeverity value. More... | |
virtual OpcUa_UInt16 | getLastSeverity () const |
Returns the value of LastSeverity. More... | |
virtual void | setLastSeverityStatus (OpcUa_StatusCode status) |
Set a status code for the event field LastSeverity. More... | |
virtual void | getLastSeverityValue (Session *pSession, UaVariant &value) |
Sets the value of LastSeverity to argument value. More... | |
virtual void | setQuality (OpcUa_StatusCode Quality) |
Sets the Quality value. More... | |
virtual OpcUa_StatusCode | getQuality () const |
Returns the value of Quality. More... | |
virtual void | setQualityStatus (OpcUa_StatusCode status) |
Set a status code for the event field Quality. More... | |
virtual void | getQualityValue (Session *pSession, UaVariant &value) |
Sets the value of Quality to argument value. More... | |
virtual void | setRetain (OpcUa_Boolean Retain) |
Sets the Retain value. More... | |
virtual OpcUa_Boolean | getRetain () const |
Returns the value of Retain. More... | |
virtual void | setRetainStatus (OpcUa_StatusCode status) |
Set a status code for the event field Retain. More... | |
virtual void | getRetainValue (Session *pSession, UaVariant &value) |
Sets the value of Retain to argument value. More... | |
virtual OpcUa::PropertyType * | getBranchIdNode () |
Returns the BranchId node. More... | |
virtual OpcUa::PropertyType * | getClientUserIdNode () |
Returns the ClientUserId node. More... | |
virtual OpcUa::ConditionVariableType * | getCommentNode () |
Returns the Comment node. More... | |
virtual OpcUa::PropertyType * | getConditionClassIdNode () |
Returns the ConditionClassId node. More... | |
virtual OpcUa::PropertyType * | getConditionClassNameNode () |
Returns the ConditionClassName node. More... | |
virtual OpcUa::PropertyType * | getConditionNameNode () |
Returns the ConditionName node. More... | |
virtual OpcUa::TwoStateVariableType * | getEnabledStateNode () |
Returns the EnabledState node. More... | |
virtual OpcUa::ConditionVariableType * | getLastSeverityNode () |
Returns the LastSeverity node. More... | |
virtual OpcUa::ConditionVariableType * | getQualityNode () |
Returns the Quality node. More... | |
virtual OpcUa::PropertyType * | getRetainNode () |
Returns the Retain node. More... | |
void | useAccessInfoFromInstance (ConditionTypeBase *pInstance) |
Uses the NodeAccessInfo of pOther and its children. More... | |
virtual void | getConditionTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
Get the field value for the passed index for optional fields of the ConditionType. More... | |
Static Public Member Functions | |
static void | createTypes () |
Create the related type nodes. | |
static void | clearStaticMembers () |
Clear the static members of the class. | |
static void | registerEventFields () |
Registers all event type fields with the EventManagerBase. | |
static OpcUa_UInt32 | registerOptionalEventFields (const UaString &fieldName) |
Registers optional event fields with the EventManagerBase. | |
Static Public Member Functions inherited from OpcUa::ConditionType | |
static void | createTypes () |
Create the related type nodes for condition classes. | |
static void | addEnabledStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName) |
Add Enabled state strings for additional locale. | |
static void | clearStaticMembers () |
Internal SDK method used to clear the static members of this class. | |
Static Public Member Functions inherited from OpcUa::ConditionTypeBase | |
static void | createTypes () |
Create the related type nodes. | |
static void | clearStaticMembers () |
Clear the static members of the class. | |
static void | registerEventFields () |
Registers all event type fields with the EventManagerBase. | |
static OpcUa_UInt32 | registerOptionalEventFields (const UaString &fieldName) |
Registers optional event fields with the EventManagerBase. | |
Protected Member Functions | |
virtual | ~DialogConditionTypeBase () |
Destroys the DialogConditionType object. | |
Protected Member Functions inherited from OpcUa::ConditionType | |
virtual | ~ConditionType () |
Destruction. | |
Protected Member Functions inherited from OpcUa::ConditionTypeBase | |
virtual | ~ConditionTypeBase () |
Destroys the ConditionType object. | |
Generated base class for a DialogConditionType.
This class contains the auto generated code for the object type DialogConditionType representing an OPC UA condition type. This class is used to create the condition type and to create and represent the condition object in the server address space. It provides also the UaEventData interface for the access to event data containing the current state of the condition for events sent to the client.
Variable members 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.
OpcUa::DialogConditionTypeBase::DialogConditionTypeBase | ( | UaBase::Object * | pBaseNode, |
XmlUaNodeFactoryManager * | pFactory, | ||
NodeManagerConfig * | pNodeConfig, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Constructs an instance of the class DialogConditionTypeBase with all components.
[in] | pBaseNode | The "tree" of nodes that specifies the attributes of the instance and its children. |
[in] | pFactory | The factory to create the children. |
[in] | pNodeConfig | Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space. |
[in] | pSharedMutex | Shared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided. |
|
virtual |
Call method of an UA object.
Implementation of the MethodManager interface method beginCall.
Reimplemented from OpcUa::ConditionTypeBase.
UaNodeId OpcUa::DialogConditionTypeBase::createBranch | ( | ) |
Creates a new branch from the current state and adds the branch to a list managed by the condition object.
ConditionType::getBranch() and ConditionType::deleteBranch() can be used to access or to delete the branch.
|
virtual |
Returns the value of 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.
|
virtual |
Returns the CancelResponse node.
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.
|
virtual |
Sets the value of CancelResponse to argument value.
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.
|
virtual |
Returns the value of 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.
|
virtual |
Returns the DefaultResponse node.
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.
|
virtual |
Sets the value of DefaultResponse to argument value.
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.
|
virtual |
Get the field value for the passed index for optional fields of the DialogConditionType.
This function must be overwritten by derived classes to provide the optional fields registered with DialogConditionTypeData::registerOptionalEventFields.
index | The index of the selected field. |
pSession | The session context for the method call. |
data | The data for the selected field. |
|
virtual |
Returns the LocalizedText representation of the DialogState.
See DialogConditionTypeBase::getDialogStateBool for a detailed description of DialogState.
|
virtual |
Returns the boolean value of the 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 |
|
virtual |
Returns the DialogState node.
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 |
|
virtual |
Sets the value of DialogState to argument value.
See DialogConditionTypeBase::getDialogStateBool for a detailed description of DialogState.
|
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::ConditionTypeBase.
|
virtual |
Returns the value of 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.
|
virtual |
Returns the LastResponse node.
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.
|
virtual |
Sets the value of LastResponse to argument value.
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.
|
virtual |
Returns the value of 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.
|
virtual |
Returns the OkResponse node.
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.
|
virtual |
Sets the value of OkResponse to argument value.
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.
|
virtual |
Returns the value of Prompt.
Prompt is a dialog prompt to be shown to the user.
|
virtual |
Returns the Prompt node.
Prompt is a dialog prompt to be shown to the user.
|
virtual |
Sets the value of Prompt to argument value.
Prompt is a dialog prompt to be shown to the user.
|
virtual |
Gets the 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
|
virtual |
Returns the ResponseOptionSet node.
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
|
virtual |
Sets the value of ResponseOptionSet to argument value.
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
|
pure virtual |
Respond is used to pass the selected response option and end the dialog.
DialogState will return to FALSE.
Method Result Codes
ResultCode | Description |
---|---|
Bad_DialogNotActive | The DialogConditionType instance is not in Active state. |
Bad_DialogResponseInvalid | The selected option is not a valid index in the ResponseOptionSet array. |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. | |
[in] | SelectedResponse | The response to the dialog condition.. Selected index of the ResponseOptionSet array. |
Implemented in OpcUa::DialogConditionType.
|
virtual |
Sets the CancelResponse value.
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.
|
virtual |
Set a status code for the event field CancelResponse.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
|
virtual |
Sets the DefaultResponse value.
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.
|
virtual |
Set a status code for the event field DefaultResponse.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
|
virtual |
Sets the 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 |
|
virtual |
Set a status code for the event field DialogState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
See DialogConditionTypeBase::setDialogState for a detailed description of DialogState.
|
virtual |
Sets the LastResponse value.
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.
|
virtual |
Set a status code for the event field LastResponse.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
|
virtual |
Sets the OkResponse value.
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.
|
virtual |
Set a status code for the event field OkResponse.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
|
virtual |
Sets the Prompt value.
Prompt is a dialog prompt to be shown to the user.
|
virtual |
Set a status code for the event field Prompt.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
|
virtual |
Sets the 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
|
virtual |
Set a status code for the event field ResponseOptionSet.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
|
virtual |
Send event with current event field data to the subscribed clients.
After setting the changed states of the event this method is used to trigger the event notification that contains the snapshot of the new state of the condition.
[in] | time | Time provides the time the Event occurred. This value is set as close to the event generator as possible. It often comes from the underlying system or device. |
[in] | receiveTime | ReceiveTime provides the time the OPC UA Server received the Event from the underlying device or another Server. |
[in] | userEventId | The server is responsible for generating a unique EventId for every event sent to the client. The SDK uses this parameter userEventId as part of the EventId but adds a unique part. The EventId is provided by the client in calls back to the server like in an alarm acknowledgement. The user specific part can be extracted from the EventId provided by the client by using EventManagerBase::getUserEventId(). |
Reimplemented from OpcUa::ConditionTypeBase.
void OpcUa::DialogConditionTypeBase::useAccessInfoFromInstance | ( | DialogConditionTypeBase * | pOther | ) |
Uses the NodeAccessInfo of pOther and its children.
|
virtual |
Applies the NodeAccessInfo set at the DialogConditionTypeBase and its children.
Reimplemented from OpcUa::ConditionTypeBase.