 |
C++ Based OPC UA Client/Server SDK
1.5.5.355
|
|
C++ Based OPC UA Client/Server SDK
1.5.5.355
|
Event data class for the OPC UA event type ProgramTransitionEventType. More...
#include <opcua_programtransitioneventtypedata.h>
Inherits OpcUa::TransitionEventTypeData.
Public Member Functions | |
| ProgramTransitionEventTypeData () | |
| Constructs an instance of the event data class ProgramTransitionEventTypeData. | |
| virtual | ~ProgramTransitionEventTypeData () |
| Destroys the ProgramTransitionEventTypeData object. | |
| virtual void | getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
| Get the field value for the passed index. More... | |
| void | setIntermediateResult (const UaVariant &IntermediateResult) |
| Set the event field value IntermediateResult. | |
| void | setIntermediateResultStatus (OpcUa_StatusCode status) |
| Set a status code for the event field value IntermediateResult. More... | |
| UaVariant | getIntermediateResult () |
| Get the event field value IntermediateResult. | |
| virtual void | getIntermediateResultValue (Session *pSession, OpcUa_Variant &value) |
| Get the event field value IntermediateResult for delivering the event data. More... | |
 Public Member Functions inherited from OpcUa::TransitionEventTypeData | |
| TransitionEventTypeData () | |
| Constructs an instance of the event data class TransitionEventTypeData. | |
| virtual | ~TransitionEventTypeData () |
| Destroys the TransitionEventTypeData object. | |
| void | setFromState (const UaLocalizedText &FromState) |
| Set the event field value FromState. | |
| void | setFromStateStatus (OpcUa_StatusCode status) |
| Set a status code for the event field value FromState. More... | |
| UaLocalizedText | getFromState () |
| Get the event field value FromState. | |
| virtual void | getFromStateValue (Session *pSession, OpcUa_Variant &value) |
| Get the event field value FromState for delivering the event data. More... | |
| void | setFromState_Id (const UaVariant &Id) |
| Set the event field state bool value for Id. | |
| void | setFromState_IdStatus (OpcUa_StatusCode status) |
| Set a status code for the event field value Id. More... | |
| UaVariant | getFromState_Id () |
| Get the event field value Id. | |
| virtual void | getFromState_IdValue (Session *pSession, OpcUa_Variant &value) |
| Get the event field value Id for delivering the event data. More... | |
| void | setToState (const UaLocalizedText &ToState) |
| Set the event field value ToState. | |
| void | setToStateStatus (OpcUa_StatusCode status) |
| Set a status code for the event field value ToState. More... | |
| UaLocalizedText | getToState () |
| Get the event field value ToState. | |
| virtual void | getToStateValue (Session *pSession, OpcUa_Variant &value) |
| Get the event field value ToState for delivering the event data. More... | |
| void | setToState_Id (const UaVariant &Id) |
| Set the event field state bool value for Id. | |
| void | setToState_IdStatus (OpcUa_StatusCode status) |
| Set a status code for the event field value Id. More... | |
| UaVariant | getToState_Id () |
| Get the event field value Id. | |
| virtual void | getToState_IdValue (Session *pSession, OpcUa_Variant &value) |
| Get the event field value Id for delivering the event data. More... | |
| void | setTransition (const UaLocalizedText &Transition) |
| Set the event field value Transition. | |
| void | setTransitionStatus (OpcUa_StatusCode status) |
| Set a status code for the event field value Transition. More... | |
| UaLocalizedText | getTransition () |
| Get the event field value Transition. | |
| virtual void | getTransitionValue (Session *pSession, OpcUa_Variant &value) |
| Get the event field value Transition for delivering the event data. More... | |
| void | setTransition_Id (const UaVariant &Id) |
| Set the event field state bool value for Id. | |
| void | setTransition_IdStatus (OpcUa_StatusCode status) |
| Set a status code for the event field value Id. More... | |
| UaVariant | getTransition_Id () |
| Get the event field value Id. | |
| virtual void | getTransition_IdValue (Session *pSession, OpcUa_Variant &value) |
| Get the event field value Id 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 | |
| virtual UaNodeId | getConditionNodeId () |
| Returns the condition NodeId if the event data is related to a condition object. More... | |
| virtual UaNodeId | getConditionBranchNodeId () |
| Returns the condition branch NodeId if the event data is related to a condition object. More... | |
| virtual OpcUa_Boolean | getConditionRetain () |
| Returns the Retain flag if the event data is related to a condition object. More... | |
| 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 | setEventUserData (OpcUa_Handle pEventUserData) |
| Sets the user specific event data to the EventData object. More... | |
| OpcUa_Handle | getEventUserData () const |
| Returns the user specific event data. | |
| const NodeAccessInfo * | getEventAccessInfo () const |
| Returns the access info associated with this UaEventData. More... | |
| void | useEventAccessInfoFrom (const UaEventData *pOther) |
| Set the access info from another node to this node. More... | |
| void | setEventAccessInfo (NodeAccessInfo *pAccessInfo) |
| Set access info for this UaEventData. More... | |
| void | attachEventAccessInfo (NodeAccessInfo *pAccessInfo) |
| Set access info for this UaEventData. More... | |
| virtual ReferenceCounter * | getConditionDataReferenceCounter () |
| Get the ReferenceCounter interface necessary for condition event data classes. | |
Static Public Member Functions | |
| static void | createTypes () |
| Create the type nodes for the event type ProgramTransitionEventType. | |
| static void | clearStaticMembers () |
| Clear the static members of the class. | |
| static void | registerEventFields () |
| Registers all event type fields with the EventManagerBase. | |
| Static Public Member Functions inherited from OpcUa::TransitionEventTypeData | |
| static void | createTypes () |
| Create the type nodes for the event type TransitionEventType. | |
| static void | clearStaticMembers () |
| Clear the static members of the class. | |
| static void | registerEventFields () |
| Registers all event type fields with the EventManagerBase. | |
| 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. | |
Additional Inherited Members | |
| 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. | |
Event data class for the OPC UA event type ProgramTransitionEventType.
This class provides the functionality necessary to create an event of type ProgramTransitionEventType, to set the values of the event fields and to send the event to interested clients through EventManagerBase::fireEvent().
Event Fields of the ProgramTransitionEventType:
| Browse Name | DataType | TypeDefinition | Modelling Rule | See Also |
|---|---|---|---|---|
| IntermediateResult | BaseDataType | PropertyType | Mandatory | getIntermediateResult, setIntermediateResult |
|
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::TransitionEventTypeData.
|
virtual |
Get the event field value IntermediateResult 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::ProgramTransitionEventTypeData::setIntermediateResultStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value IntermediateResult.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.