|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface EventManagerListener
Listener for OPC UA Condition control commands from the client.
| Method Summary | |
|---|---|
boolean |
onAcknowledge(ServiceContext serviceContext,
AcknowledgeableConditionTypeNode condition,
org.opcfoundation.ua.builtintypes.ByteString eventId,
org.opcfoundation.ua.builtintypes.LocalizedText comment)
Notifies that the client wants to acknowledge a condition event. |
boolean |
onAddComment(ServiceContext serviceContext,
ConditionTypeNode condition,
org.opcfoundation.ua.builtintypes.ByteString eventId,
org.opcfoundation.ua.builtintypes.LocalizedText comment)
Notifies that the client wants to add a new comment to the event. |
void |
onAfterCreateMonitoredEventItem(ServiceContext serviceContext,
Subscription subscription,
MonitoredEventItem item)
Notification after a MonitoredEventItem was created. |
void |
onAfterDeleteMonitoredEventItem(ServiceContext serviceContext,
Subscription subscription,
MonitoredEventItem item)
Notification after a MonitoredEventItem was deleted from the subscription. |
void |
onAfterModifyMonitoredEventItem(ServiceContext serviceContext,
Subscription subscription,
MonitoredEventItem item)
Notification after a MonitoredEventItem was modified. |
void |
onConditionRefresh(ServiceContext serviceContext,
Subscription subscription)
Handle a ConditionRefresh call from a client. |
boolean |
onConfirm(ServiceContext serviceContext,
AcknowledgeableConditionTypeNode condition,
org.opcfoundation.ua.builtintypes.ByteString eventId,
org.opcfoundation.ua.builtintypes.LocalizedText comment)
Notifies that the client wants to confirm a condition event. |
void |
onCreateMonitoredEventItem(ServiceContext serviceContext,
org.opcfoundation.ua.builtintypes.NodeId nodeId,
org.opcfoundation.ua.core.EventFilter eventFilter,
org.opcfoundation.ua.core.EventFilterResult eventFilterResult)
Notification of a new MonitoredEventItem request from a client application. |
void |
onDeleteMonitoredEventItem(ServiceContext serviceContext,
Subscription subscription,
MonitoredEventItem monitoredItem)
Notification of an event item being removed from a client subscription. |
boolean |
onDisable(ServiceContext serviceContext,
ConditionTypeNode condition)
Notifies that the client wants to disable a condition. |
boolean |
onEnable(ServiceContext serviceContext,
ConditionTypeNode condition)
Notifies that the client wants to enable a condition. |
void |
onModifyMonitoredEventItem(ServiceContext serviceContext,
Subscription subscription,
MonitoredEventItem monitoredItem,
org.opcfoundation.ua.core.EventFilter eventFilter,
org.opcfoundation.ua.core.EventFilterResult eventFilterResult)
Notification of a modify request to the monitoring parameters of a monitored event item. |
boolean |
onOneshotShelve(ServiceContext serviceContext,
AlarmConditionTypeNode condition,
ShelvedStateMachineTypeNode stateMachine)
Notification of an OneshotShelve request for an Alarm object. |
boolean |
onTimedShelve(ServiceContext serviceContext,
AlarmConditionTypeNode condition,
ShelvedStateMachineTypeNode stateMachine,
double shelvingTime)
Notification of a TimedShelve request for an Alarm object. |
boolean |
onUnshelve(ServiceContext serviceContext,
AlarmConditionTypeNode condition,
ShelvedStateMachineTypeNode stateMachine)
Notification of an Unshelve request for an Alarm object. |
| Method Detail |
|---|
boolean onAcknowledge(ServiceContext serviceContext,
AcknowledgeableConditionTypeNode condition,
org.opcfoundation.ua.builtintypes.ByteString eventId,
org.opcfoundation.ua.builtintypes.LocalizedText comment)
throws StatusException
serviceContext - the client calling contextcondition - the condition that should be acknowledgedeventId - the ID of the eventcomment - the user comment to add to the event
StatusException
boolean onAddComment(ServiceContext serviceContext,
ConditionTypeNode condition,
org.opcfoundation.ua.builtintypes.ByteString eventId,
org.opcfoundation.ua.builtintypes.LocalizedText comment)
throws StatusException
serviceContext - the client calling contextcondition - the condition that should be acknowledgedeventId - the event occurrence being commentedcomment - the user comment to add to the event
StatusException
void onAfterCreateMonitoredEventItem(ServiceContext serviceContext,
Subscription subscription,
MonitoredEventItem item)
serviceContext - the client calling contextsubscription - the subscriptionitem - the item that was created
void onAfterDeleteMonitoredEventItem(ServiceContext serviceContext,
Subscription subscription,
MonitoredEventItem item)
serviceContext - the client calling contextsubscription - the subscriptionitem - the item that was deleted
void onAfterModifyMonitoredEventItem(ServiceContext serviceContext,
Subscription subscription,
MonitoredEventItem item)
The method is called whenever the item filter or the MonitoringMode is changed. The filter
change is also notified in
onModifyMonitoredEventItem(ServiceContext, Subscription, MonitoredEventItem, EventFilter, EventFilterResult)
where you can verify it. MonitoringMode is only notified here after it has been changed.
serviceContext - the client calling contextsubscription - the subscriptionitem - the item that was modified
void onConditionRefresh(ServiceContext serviceContext,
Subscription subscription)
throws StatusException
serviceContext - the client calling contextsubscription - the subscription to refresh
StatusException
boolean onConfirm(ServiceContext serviceContext,
AcknowledgeableConditionTypeNode condition,
org.opcfoundation.ua.builtintypes.ByteString eventId,
org.opcfoundation.ua.builtintypes.LocalizedText comment)
throws StatusException
serviceContext - the client calling contextcondition - the condition that should be acknowledgedeventId - the ID of the eventcomment - the user comment to add to the event
StatusException
void onCreateMonitoredEventItem(ServiceContext serviceContext,
org.opcfoundation.ua.builtintypes.NodeId nodeId,
org.opcfoundation.ua.core.EventFilter eventFilter,
org.opcfoundation.ua.core.EventFilterResult eventFilterResult)
throws StatusException
serviceContext - the client calling contextnodeId - the node that will be monitoredeventFilter - the event filter, which defines the nodes and events to monitoreventFilterResult - the filter results to fill in, if there is something to note about the
requested filter. This is defined as OK by default.
StatusException - if the item cannot or may not be created.
void onDeleteMonitoredEventItem(ServiceContext serviceContext,
Subscription subscription,
MonitoredEventItem monitoredItem)
serviceContext - the client calling contextsubscription - the subscription from which the item is being removedmonitoredItem - the monitored item to remove
boolean onDisable(ServiceContext serviceContext,
ConditionTypeNode condition)
throws StatusException
serviceContext - the client calling contextcondition - the condition that should be disabled
StatusException
boolean onEnable(ServiceContext serviceContext,
ConditionTypeNode condition)
throws StatusException
serviceContext - the client calling contextcondition - the condition that should be enabled
StatusException
void onModifyMonitoredEventItem(ServiceContext serviceContext,
Subscription subscription,
MonitoredEventItem monitoredItem,
org.opcfoundation.ua.core.EventFilter eventFilter,
org.opcfoundation.ua.core.EventFilterResult eventFilterResult)
throws StatusException
serviceContext - the client calling contextsubscription - the subscription to which the item is being addedmonitoredItem - the monitored event item to modifyeventFilter - the event filter, which defines the nodes and events to monitoreventFilterResult - the filter results to fill in, if there is something to note about the
requested filter. This is filled in by the default filter handler.
StatusException
boolean onOneshotShelve(ServiceContext serviceContext,
AlarmConditionTypeNode condition,
ShelvedStateMachineTypeNode stateMachine)
throws StatusException
serviceContext - the client calling contextcondition - the condition object concernedstateMachine - the state machine that is being shelved
true if the request is handled in the listener.
StatusException - if the arguments are incorrect or any other error needs to be returned
to the client. Specifically, Bad_ConditionAlreadyShelved, if the Alarm is already in
OneshotShelved state.
boolean onTimedShelve(ServiceContext serviceContext,
AlarmConditionTypeNode condition,
ShelvedStateMachineTypeNode stateMachine,
double shelvingTime)
throws StatusException
serviceContext - the client calling contextcondition - the condition object concernedstateMachine - the state machine that is being shelvedshelvingTime - specifies a fixed time for which the Alarm is to be shelved (in
milliseconds). The Server may refuse the provided duration. If a MaxTimeShelved Property
exist on the Alarm than the Shelving time shall be less than or equal to the value of
this Property.
true if the request is handled in the listener.
StatusException - if the arguments are incorrect or any other error needs to be returned
to the client. Specifically, Bad_ConditionAlreadyShelved, if the Alarm is already in
TimedShelved state and the system does not allow a reset of the shelved timer; or
Bad_ShelvingTimeOutOfRange, if the requested time exceeds the MaxTimeShelved (optional
property) defined in the alarm.
boolean onUnshelve(ServiceContext serviceContext,
AlarmConditionTypeNode condition,
ShelvedStateMachineTypeNode stateMachine)
throws StatusException
serviceContext - the client calling contextcondition - the condition object concernedstateMachine - the state machine that is being unshelved
true if the request is handled in the listener.
StatusException - if the arguments are incorrect or any other error needs to be returned
to the client. Specifically, Bad_ConditionNotShelved, if the Alarm is not in
OneshotShelved or TimedShelved state.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||