OpcUa::DialogConditionTypeData Class Reference

#include <opcua_dialogconditiontypebase.h>

Inheritance diagram for OpcUa::DialogConditionTypeData:
Collaboration diagram for OpcUa::DialogConditionTypeData:

List of all members.

Public Member Functions

 DialogConditionTypeData ()
virtual ~DialogConditionTypeData ()
void initializeAsBranch (DialogConditionTypeBase *pCondition)
virtual void getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
void setCancelResponse (OpcUa_Int32 cancelResponse)
OpcUa_Int32 getCancelResponse ()
virtual void getCancelResponseValue (Session *pSession, OpcUa_Variant &value)
void setDefaultResponse (OpcUa_Int32 defaultResponse)
OpcUa_Int32 getDefaultResponse ()
virtual void getDefaultResponseValue (Session *pSession, OpcUa_Variant &value)
virtual void getDialogStateValue (Session *pSession, OpcUa_Variant &value)
void setDialogState (OpcUa_Boolean dialogState)
OpcUa_Boolean getDialogState ()
virtual void getDialogStateIdValue (Session *pSession, OpcUa_Variant &value)
void setLastResponse (OpcUa_Int32 lastResponse)
OpcUa_Int32 getLastResponse ()
virtual void getLastResponseValue (Session *pSession, OpcUa_Variant &value)
void setOkResponse (OpcUa_Int32 okResponse)
OpcUa_Int32 getOkResponse ()
virtual void getOkResponseValue (Session *pSession, OpcUa_Variant &value)
void setPrompt (const UaLocalizedText &prompt)
UaLocalizedText getPrompt ()
virtual void getPromptValue (Session *pSession, OpcUa_Variant &value)
void setResponseOptionSet (const UaLocalizedText &responseOptionSet)
UaLocalizedText getResponseOptionSet ()
virtual void getResponseOptionSetValue (Session *pSession, OpcUa_Variant &value)

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.


Constructor & Destructor Documentation

OpcUa::DialogConditionTypeData::DialogConditionTypeData (  )

Constructs an DialogConditionTypeData object

OpcUa::DialogConditionTypeData::~DialogConditionTypeData (  ) [virtual]

Destroys the DialogConditionTypeData object


Member Function Documentation

OpcUa_Int32 OpcUa::DialogConditionTypeData::getCancelResponse (  )

Get the event field value CancelResponse

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

OpcUa_Int32 OpcUa::DialogConditionTypeData::getDefaultResponse (  )

Get the event field value DefaultResponse

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

OpcUa_Boolean OpcUa::DialogConditionTypeData::getDialogState (  )

Get the event field state bool value for DialogState

void OpcUa::DialogConditionTypeData::getDialogStateIdValue ( Session pSession,
OpcUa_Variant &  value 
) [virtual]

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

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

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

OpcUa_Int32 OpcUa::DialogConditionTypeData::getOkResponse (  )

Get the event field value OkResponse

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

UaLocalizedText OpcUa::DialogConditionTypeData::getPrompt (  )

Get the event field value Prompt

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

UaLocalizedText OpcUa::DialogConditionTypeData::getResponseOptionSet (  )

Get the event field value ResponseOptionSet

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

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 time stamps and the EventId for every update sent to the client(s).

Parameters:
pConditionThe condition object .
void OpcUa::DialogConditionTypeData::setCancelResponse ( OpcUa_Int32  cancelResponse )

Set the event field value CancelResponse

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

Set the event field value DefaultResponse

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

Set the event field state bool value for DialogState

void OpcUa::DialogConditionTypeData::setLastResponse ( OpcUa_Int32  lastResponse )

Set the event field value LastResponse

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

Set the event field value OkResponse

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

Set the event field value Prompt

void OpcUa::DialogConditionTypeData::setResponseOptionSet ( const UaLocalizedText responseOptionSet )

Set the event field value ResponseOptionSet


The documentation for this class was generated from the following files:
  • /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_dialogconditiontypebase.h
  • /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_dialogconditiontypebase.cpp