C++ Based OPC UA Client/Server SDK
1.6.1.391
|
Event data class for the OPC UA event type SystemStatusChangeEventType. More...
#include <opcua_systemeventtypedata.h>
Inherits OpcUa::SystemEventTypeData.
Public Member Functions | |
SystemStatusChangeEventTypeData () | |
Constructs an instance of the event data class SystemStatusChangeEventTypeData. | |
virtual | ~SystemStatusChangeEventTypeData () |
Destroys the SystemStatusChangeEventTypeData object. | |
virtual void | getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
Get the field value for the passed index. More... | |
void | setSystemState (OpcUa_ServerState SystemState) |
Set the event field value SystemState. More... | |
void | setSystemStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field value SystemState. More... | |
OpcUa_ServerState | getSystemState () |
Get the event field value SystemState. More... | |
virtual void | getSystemStateValue (Session *pSession, OpcUa_Variant &value) |
Get the event field value SystemState for delivering the event data. More... | |
Public Member Functions inherited from OpcUa::SystemEventTypeData | |
SystemEventTypeData () | |
Constructs an instance of the event data class SystemEventTypeData. | |
virtual | ~SystemEventTypeData () |
Destroys the SystemEventTypeData object. | |
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 SystemStatusChangeEventType. | |
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::SystemEventTypeData | |
static void | createTypes () |
Create the type nodes for the event type SystemEventType. | |
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 SystemStatusChangeEventType.
This class provides the functionality necessary to create an event of type SystemStatusChangeEventType, to set the values of the event fields and to send the event to interested clients through EventManagerBase::fireEvent().
Event Fields of the SystemStatusChangeEventType:
Browse Name | DataType | TypeDefinition | Modelling Rule | See Also |
---|---|---|---|---|
SystemState | ServerState | PropertyType | Mandatory | getSystemState, setSystemState |
Event that indicates a status change in a system.
For example, if the status indicates that an underlying system is not running, then a Client cannot expect any Events from the underlying system. A Server can identify its own status changes using this EventType.
This EventType inherits all Properties of the SystemEventType. The SourceNode and the SourceName shall identify the system. The system can be the Server itself or some underlying system.
See also SystemStatusChangeEventType for a documentation of the complete Information Model.
|
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::SystemEventTypeData.
OpcUa_ServerState OpcUa::SystemStatusChangeEventTypeData::getSystemState | ( | ) |
Get the event field value SystemState.
Specifies the current state of the system.
Changes to the ServerState of the system shall trigger a SystemStatusChangeEvent, when the event is supported by the system.
|
virtual |
Get the event field value SystemState 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
Specifies the current state of the system.
Changes to the ServerState of the system shall trigger a SystemStatusChangeEvent, when the event is supported by the system.
void OpcUa::SystemStatusChangeEventTypeData::setSystemState | ( | OpcUa_ServerState | SystemState | ) |
Set the event field value SystemState.
Specifies the current state of the system.
Changes to the ServerState of the system shall trigger a SystemStatusChangeEvent, when the event is supported by the system.
void OpcUa::SystemStatusChangeEventTypeData::setSystemStateStatus | ( | OpcUa_StatusCode | status | ) |
Set a status code for the event field value SystemState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.