UA Server SDK C++ Bundle
1.4.0.258
|
Generated event data class for a ConditionType. More...
#include <opcua_conditiontypebase.h>
Inherits BaseEventTypeData, and ReferenceCounter.
Inherited by OpcUa::AcknowledgeableConditionTypeData, and OpcUa::DialogConditionTypeData.
Public Member Functions | |
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... | |
ReferenceCounter * | getConditionDataReferenceCounter () |
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... | |
virtual void | getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
Get the field value for the passed index. More... | |
void | setBranchId (const UaNodeId &BranchId) |
Set the event field value BranchId. | |
UaNodeId | getBranchId () |
Get the event field value BranchId. | |
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. | |
UaString | getClientUserId () |
Get the event field value ClientUserId. | |
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. | |
UaLocalizedText | getComment () |
Get the event field value Comment. | |
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) |
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. | |
UaNodeId | getConditionClassId () |
Get the event field value ConditionClassId. | |
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. | |
UaLocalizedText | getConditionClassName () |
Get the event field value ConditionClassName. | |
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. | |
UaString | getConditionName () |
Get the event field value ConditionName. | |
virtual void | getConditionNameValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value ConditionName 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. | |
OpcUa_Boolean | getEnabledState () |
Get the event field state bool value for EnabledState. | |
void | setEnabledState_EffectiveDisplayName (const UaLocalizedText &EffectiveDisplayName) |
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) |
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) |
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. | |
OpcUa_UInt16 | getLastSeverity () |
Get the event field value LastSeverity. | |
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) |
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. | |
OpcUa_StatusCode | getQuality () |
Get the event field value Quality. | |
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) |
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. | |
OpcUa_Boolean | getRetain () |
Get the event field value Retain. | |
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 | initializeFromEventData (BaseEventTypeData *pEventData) |
virtual void | prepareNewEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &userEventId) |
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. More... | |
virtual void | setSource (const UaNode *pNode) |
Set the SourceNode and SoruceName by passing in a node pointer for the source node. | |
virtual void | setSourceNode (const UaNodeId &sourceNode) |
Set the SourceNode event field. | |
virtual UaNodeId | getSourceNode () const |
Get the SourceNode event field. | |
virtual void | setSourceName (const UaString &sourceName) |
Set the SourceName event field. | |
virtual UaString | getSourceName () const |
Get the SourceName event field. | |
virtual void | setTime (const UaDateTime &time) |
Set the Time event field. | |
virtual UaDateTime | getTime () const |
Get the Time event field. | |
virtual void | setReceiveTime (const UaDateTime &receiveTime) |
Set the ReceiveTime event field. | |
virtual UaDateTime | getReceiveTime () const |
Get the ReceiveTime event field. | |
virtual void | setMessage (const UaLocalizedText &message) |
Set the Message event field. | |
virtual UaLocalizedText | getMessage () const |
Get the Message event field. | |
virtual void | getMessageValue (Session *pSession, UaVariant &data) |
Get the message field value. More... | |
virtual void | setSeverity (OpcUa_UInt16 severity) |
Set the Severity event field. | |
virtual OpcUa_UInt16 | getSeverity () const |
Get the Severity event field. | |
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. | |
Public Member Functions inherited from ReferenceCounter | |
ReferenceCounter () | |
construction | |
virtual | ~ReferenceCounter () |
destruction | |
int | addReference () |
int | releaseReference () |
int | referenceCount () const |
Protected Member Functions | |
virtual | ~ConditionTypeData () |
Destroys the ConditionTypeData object. | |
Protected Attributes | |
UaMutex | m_mutex |
Additional Inherited Members | |
Static Public Member Functions inherited from BaseEventTypeData | |
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. | |
Generated event data class for a ConditionType.
This class contains the auto generated code for the object type ConditionType 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.
|
virtual |
Get the event field value BranchId 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
|
virtual |
Get the event field value ClientUserId 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
|
virtual |
Get the event field value SourceTimestamp 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
|
virtual |
Get the event field value Comment 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
|
virtual |
Get the event field value ConditionClassId 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
|
virtual |
Get the event field value ConditionClassName 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
|
virtual |
Get the event field value ConditionName 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
|
virtual |
Get the event field value EffectiveDisplayName 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
|
virtual |
Get the event field value EffectiveTransitionTime 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
|
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
|
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
|
virtual |
Get the event field value EnabledState 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
|
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 BaseEventTypeData.
Reimplemented in OpcUa::AlarmConditionTypeData, OpcUa::ExclusiveLimitAlarmTypeData, OpcUa::DialogConditionTypeData, OpcUa::AcknowledgeableConditionTypeData, OpcUa::ExclusiveDeviationAlarmTypeData, OpcUa::LimitAlarmTypeData, OpcUa::NonExclusiveDeviationAlarmTypeData, OpcUa::NonExclusiveLimitAlarmTypeData, OpcUa::OffNormalAlarmTypeData, OpcUa::DiscreteAlarmTypeData, OpcUa::ExclusiveLevelAlarmTypeData, OpcUa::ExclusiveRateOfChangeAlarmTypeData, OpcUa::NonExclusiveLevelAlarmTypeData, OpcUa::NonExclusiveRateOfChangeAlarmTypeData, OpcUa::SystemOffNormalAlarmTypeData, and OpcUa::TripAlarmTypeData.
|
virtual |
Get the event field value SourceTimestamp 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
|
virtual |
Get the event field value LastSeverity 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
|
virtual |
Get the event field value SourceTimestamp 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
|
virtual |
Get the event field value Quality 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
|
virtual |
Get the event field value Retain 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::ConditionTypeData::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.
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).
pCondition | The condition object . |
void OpcUa::ConditionTypeData::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.
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 time stamps and the EventId for every update sent to the client(s).
pConditionData | The condition data object . |
|
inlinevirtual |
Lock the event data for data update and event handling.
This method is used for event data objects maintaining a state for conditions since there may be concurrent access to the condition data by a condition update and a condition refresh triggered by a client. This method is also used during the event processing in the SDK.
Reimplemented from UaEventData.
|
inlinevirtual |
Unlock the event data after data update or event handling.
This method is used for event data objects maintaining a state for conditions since there may be concurrent access to the condition data by a condition update and a condition refresh triggered by a client. This method is also used during the event processing in the SDK.
Reimplemented from UaEventData.