C++ Based OPC UA Client/Server SDK  1.5.5.355
OpcUa::DialogConditionType Class Reference

Class implementing the UaObject interface for the DialogConditionType. More...

#include <opcua_dialogconditiontype.h>

Inherits OpcUa::DialogConditionTypeBase.

Public Member Functions

 DialogConditionType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class DialogConditionType. More...
 
 DialogConditionType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class DialogConditionType. More...
 
 DialogConditionType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class DialogConditionType with all components. More...
 
virtual UaStatus Respond (const ServiceContext &serviceContext, OpcUa_Int32 SelectedResponse)
 Respond is used to pass the selected response option and end the dialog. More...
 
- Public Member Functions inherited from OpcUa::DialogConditionTypeBase
 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 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::PropertyTypegetCancelResponseNode ()
 Returns the CancelResponse node. More...
 
virtual OpcUa::PropertyTypegetDefaultResponseNode ()
 Returns the DefaultResponse node. More...
 
virtual
OpcUa::TwoStateVariableType
getDialogStateNode ()
 Returns the DialogState node. More...
 
virtual OpcUa::PropertyTypegetLastResponseNode ()
 Returns the LastResponse node. More...
 
virtual OpcUa::PropertyTypegetOkResponseNode ()
 Returns the OkResponse node. More...
 
virtual OpcUa::PropertyTypegetPromptNode ()
 Returns the Prompt node. More...
 
virtual OpcUa::PropertyTypegetResponseOptionSetNode ()
 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...
 
ReferenceCountergetConditionDataReferenceCounter ()
 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...
 
ConditionTypeDatagetBranch (const UaNodeId &branchNodeId)
 Returns a pointer to the branch event data based on the passed branch NodeId. More...
 
ConditionTypeDatagetBranchByEventId (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::PropertyTypegetBranchIdNode ()
 Returns the BranchId node. More...
 
virtual OpcUa::PropertyTypegetClientUserIdNode ()
 Returns the ClientUserId node. More...
 
virtual
OpcUa::ConditionVariableType
getCommentNode ()
 Returns the Comment node. More...
 
virtual OpcUa::PropertyTypegetConditionClassIdNode ()
 Returns the ConditionClassId node. More...
 
virtual OpcUa::PropertyTypegetConditionClassNameNode ()
 Returns the ConditionClassName node. More...
 
virtual OpcUa::PropertyTypegetConditionNameNode ()
 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::PropertyTypegetRetainNode ()
 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 type related static members of the class.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
static void addDialogStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName)
 Add Dialog state strings for additional locale.
 
- Static Public Member Functions inherited from OpcUa::DialogConditionTypeBase
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 ~DialogConditionType ()
 Destruction.
 
- Protected Member Functions inherited from OpcUa::DialogConditionTypeBase
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.
 

Detailed Description

Class implementing the UaObject interface for the DialogConditionType.

OPC UA Objects are used to represent systems, system components, real-world objects and software objects. They have the NodeClass Object. The detailed description of Objects and their attributes can be found in the general description of the Object node class.

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
EnabledState LocalizedText TwoStateVariableType Mandatory getEnabledState, setEnabledState
LastResponse Int32 PropertyType Mandatory getLastResponse, setLastResponse
OkResponse Int32 PropertyType Mandatory getOkResponse, setOkResponse
Prompt LocalizedText PropertyType Mandatory getPrompt, setPrompt
ResponseOptionSet LocalizedText PropertyType Mandatory getResponseOptionSet, setResponseOptionSet

Method members of the DialogConditionType:

Browse Name Modelling Rule
Respond Mandatory

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.

Constructor & Destructor Documentation

OpcUa::DialogConditionType::DialogConditionType ( const UaNodeId nodeId,
UaObject pInstanceDeclarationObject,
NodeManagerConfig pNodeConfig,
const UaNodeId sourceNode,
const UaString sourceName,
UaMutexRefCounted pSharedMutex = NULL 
)

Construction of the class DialogConditionType.

This constructor is used if the object is created based on an instance declaration of an object type. Since the only difference between the instance declaration object and the instance object are the node id, the pointer to the instance declaration node is used to get the attribute values other than NodeId from the instance declaration node.

The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

Parameters
[in]nodeIdNodeId of the new object
[in]pInstanceDeclarationObjectUaObject interface of the instance declaration node used to provide attribute values other than NodeId
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]sourceNodeNodeId of the source node used for this condition object. Can be null if the source is not a node in the address space
[in]sourceNameName of the source used for this condition object
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
OpcUa::DialogConditionType::DialogConditionType ( const UaNodeId nodeId,
const UaString name,
OpcUa_UInt16  browseNameNameSpaceIndex,
NodeManagerConfig pNodeConfig,
const UaNodeId sourceNode,
const UaString sourceName,
UaMutexRefCounted pSharedMutex = NULL 
)

Construction of the class DialogConditionType.

This constructor is used if the object is not created based on an instance declaration. It defines the name and node id of the object. Additional language specific names and other attribute values can be set with set methods provided by the class.

The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

Parameters
[in]nodeIdNodeId of the new object
[in]nameName of the new object. Used as browse name and also as display name if no additional language specific names are set.
[in]browseNameNameSpaceIndexNamespace index used for the browse name
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]sourceNodeNodeId of the source node used for this condition object. Can be null if the source is not a node in the address space
[in]sourceNameName of the source used for this condition object
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
OpcUa::DialogConditionType::DialogConditionType ( UaBase::Object pBaseNode,
XmlUaNodeFactoryManager pFactory,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Constructs an instance of the class DialogConditionType with all components.

Parameters
[in]pBaseNodeThe "tree" of nodes that specifies the attributes of the instance and its children
[in]pFactoryThe factory to create the children
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided

Member Function Documentation

UaStatus OpcUa::DialogConditionType::Respond ( const ServiceContext serviceContext,
OpcUa_Int32  SelectedResponse 
)
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.
Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]SelectedResponseThe response to the dialog condition.. Selected index of the ResponseOptionSet array.

Implements OpcUa::DialogConditionTypeBase.


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