|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.prosysopc.ua.EventData
public class EventData
State of an event object, when an event is triggered.
| Field Summary | |
|---|---|
static org.opcfoundation.ua.builtintypes.QualifiedName[] |
EVENT_TYPE_PATH
The browse path to the EventType field. |
static org.opcfoundation.ua.builtintypes.QualifiedName[] |
TIME_PATH
The browse path to the Time field. |
| Constructor Summary | |
|---|---|
EventData(org.opcfoundation.ua.builtintypes.NodeId nodeId,
org.opcfoundation.ua.builtintypes.ByteString eventId)
Create a new EventData structure. |
|
EventData(UaNode node,
org.opcfoundation.ua.builtintypes.ByteString eventId)
Create a new EventData structure using the current field values of an event node. |
|
| Method Summary | |
|---|---|
void |
addComment(org.opcfoundation.ua.builtintypes.LocalizedText comment)
|
org.opcfoundation.ua.builtintypes.LocalizedText[] |
getComments()
|
org.opcfoundation.ua.builtintypes.ByteString |
getEventId()
The unique EventId of the event. |
UaType |
getEventType()
The EventType as a reference to a UaType node. |
org.opcfoundation.ua.builtintypes.NodeId |
getEventTypeId()
The EventType as a NodeId. |
Set<List<org.opcfoundation.ua.builtintypes.QualifiedName>> |
getFieldNames()
Provide an iterable set of all field names for the EventData. |
org.opcfoundation.ua.builtintypes.Variant |
getFieldValue(List<org.opcfoundation.ua.builtintypes.QualifiedName> fieldPath)
Read the value of an event field |
org.opcfoundation.ua.builtintypes.Variant |
getFieldValue(org.opcfoundation.ua.builtintypes.QualifiedName[] fieldPath)
Read the value of an event field |
org.opcfoundation.ua.builtintypes.Variant[] |
getFieldValues(List<List<org.opcfoundation.ua.builtintypes.QualifiedName>> fieldPaths)
Get the field values corresponding to the provided fieldPaths. |
org.opcfoundation.ua.builtintypes.NodeId |
getNodeId()
The ID of the node that generated the event. |
org.opcfoundation.ua.builtintypes.DateTime |
getTime()
|
void |
setEventType(UaType eventType)
|
void |
setFieldValue(List<org.opcfoundation.ua.builtintypes.QualifiedName> browsePath,
org.opcfoundation.ua.builtintypes.Variant value)
Set the value of an event field in the EventData structure. |
void |
setFieldValue(org.opcfoundation.ua.builtintypes.QualifiedName[] browsePath,
org.opcfoundation.ua.builtintypes.Variant value)
Set the value of an event field in the EventData structure. |
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final org.opcfoundation.ua.builtintypes.QualifiedName[] EVENT_TYPE_PATH
getEventTypeId()
public static final org.opcfoundation.ua.builtintypes.QualifiedName[] TIME_PATH
getTime()
| Constructor Detail |
|---|
public EventData(org.opcfoundation.ua.builtintypes.NodeId nodeId,
org.opcfoundation.ua.builtintypes.ByteString eventId)
Use setFieldValue(java.util.List to define the values of the event fields.
nodeId - the event or condition node that generated the eventeventId - the ID of the event occurrence
public EventData(UaNode node,
org.opcfoundation.ua.builtintypes.ByteString eventId)
node - the event or condition node that generated the eventeventId - the ID of the event occurrence| Method Detail |
|---|
public void addComment(org.opcfoundation.ua.builtintypes.LocalizedText comment)
comment - public org.opcfoundation.ua.builtintypes.LocalizedText[] getComments()
public org.opcfoundation.ua.builtintypes.ByteString getEventId()
public UaType getEventType()
setEventType(UaType) method. In case the node is not be available,
use getEventTypeId() and define the node for further use, if possible.
public org.opcfoundation.ua.builtintypes.NodeId getEventTypeId()
getEventType()public Set<List<org.opcfoundation.ua.builtintypes.QualifiedName>> getFieldNames()
public org.opcfoundation.ua.builtintypes.Variant getFieldValue(List<org.opcfoundation.ua.builtintypes.QualifiedName> fieldPath)
fieldPath - the browse path to the field of the event to read
public org.opcfoundation.ua.builtintypes.Variant getFieldValue(org.opcfoundation.ua.builtintypes.QualifiedName[] fieldPath)
fieldPath - the browse path to the field of the event to read
public org.opcfoundation.ua.builtintypes.Variant[] getFieldValues(List<List<org.opcfoundation.ua.builtintypes.QualifiedName>> fieldPaths)
fieldPaths -
public org.opcfoundation.ua.builtintypes.NodeId getNodeId()
public org.opcfoundation.ua.builtintypes.DateTime getTime()
public void setEventType(UaType eventType)
eventType - the eventType to set
public void setFieldValue(List<org.opcfoundation.ua.builtintypes.QualifiedName> browsePath,
org.opcfoundation.ua.builtintypes.Variant value)
You typically only need to use this method, if you do not provide the UaNode to the EventData in the constructor. If you do provide it, the field values are added to the EventData automatically.
browsePath - The browse path to the field (e.g. property) of the event.value - the value of the field
public void setFieldValue(org.opcfoundation.ua.builtintypes.QualifiedName[] browsePath,
org.opcfoundation.ua.builtintypes.Variant value)
browsePath - The browse path to the field (e.g. property) of the event.value - the value of the fieldpublic String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||