|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.prosysopc.ua.MonitoredItemBase
com.prosysopc.ua.client.MonitoredItem
public abstract class MonitoredItem
Clients define MonitoredItems to subscribe to data and Events. Each MonitoredItem identifies the item to be monitored and the Subscription to use to send Notifications. The item to be monitored may be any Node Attribute.
Notifications are data structures that describe the occurrence of data changes and Events. They are packaged into NotificationMessages for transfer to the Client. The Subscription periodically sends NotificationMessages at a user-specified publishing interval, and the cycle during which these messages are sent is called a publishing cycle.
Four primary parameters are defined for MonitoredItems that tell the Server how the item is to be sampled, evaluated and reported. These parameters are the sampling interval, the monitoring mode, the filter and the queue parameter.
| Field Summary | |
|---|---|
protected static org.slf4j.Logger |
logger
|
| Fields inherited from class com.prosysopc.ua.MonitoredItemBase |
|---|
attributeId, clientHandle, dataEncoding, discardOldest, maxQueueSize, monitoredItemId, monitoringMode, nodeId, queueSize |
| Constructor Summary | |
|---|---|
protected |
MonitoredItem(org.opcfoundation.ua.builtintypes.ExpandedNodeId expandedNodeId,
org.opcfoundation.ua.builtintypes.UnsignedInteger attributeId,
org.opcfoundation.ua.core.MonitoringMode monitoringMode)
Create a new monitored item in a subscription. |
protected |
MonitoredItem(org.opcfoundation.ua.builtintypes.NodeId nodeId,
org.opcfoundation.ua.builtintypes.UnsignedInteger attributeId,
org.opcfoundation.ua.core.MonitoringMode monitoringMode)
Create a new monitored item in a subscription. |
| Method Summary | |
|---|---|
protected void |
clearModified()
|
protected void |
clearMonitoringModeModified()
|
boolean |
equals(Object obj)
|
org.opcfoundation.ua.builtintypes.StatusCode |
getErrorCode()
Item error status. |
org.opcfoundation.ua.builtintypes.ExpandedNodeId |
getExpandedNodeId()
|
org.opcfoundation.ua.builtintypes.NodeId |
getNodeId()
|
Subscription |
getSubscription()
|
int |
hashCode()
|
boolean |
isModified()
|
boolean |
isMonitoringModeModified()
|
protected void |
itemChanged()
|
protected void |
monitoringModeChanged()
|
protected void |
setClientHandle(int i)
|
protected void |
setErrorCode(org.opcfoundation.ua.builtintypes.StatusCode statusCode)
|
protected void |
setFilterResult(org.opcfoundation.ua.core.MonitoringFilterResult filterResult)
|
protected void |
setMonitoredItemId(org.opcfoundation.ua.builtintypes.UnsignedInteger monitoredItemId)
|
protected void |
setRevisedQueueSize(org.opcfoundation.ua.builtintypes.UnsignedInteger revisedQueueSize)
|
protected void |
updateFilter()
React to changes in the filter. |
protected void |
updateQueue()
Update the queue, when it's size has changed. |
| Methods inherited from class com.prosysopc.ua.MonitoredItemBase |
|---|
close, getAttributeId, getClientHandle, getDataEncoding, getDefaultQueueSize, getFilter, getFilterResult, getIndexRange, getMonitoredItemId, getMonitoringMode, getQueueSize, getSamplingInterval, isDiscardOldest, setDiscardOldest, setFilter, setMonitoringMode, setQueueSize, setQueueSize, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected static org.slf4j.Logger logger
| Constructor Detail |
|---|
protected MonitoredItem(org.opcfoundation.ua.builtintypes.ExpandedNodeId expandedNodeId,
org.opcfoundation.ua.builtintypes.UnsignedInteger attributeId,
org.opcfoundation.ua.core.MonitoringMode monitoringMode)
nodeId - the NodeId of the node to monitorattributeId - the attribute to monitormonitoringMode - the initial monitoring mode for the item. Specifies whether sampling and
reporting are enabled or disabled for a MonitoredItem.
protected MonitoredItem(org.opcfoundation.ua.builtintypes.NodeId nodeId,
org.opcfoundation.ua.builtintypes.UnsignedInteger attributeId,
org.opcfoundation.ua.core.MonitoringMode monitoringMode)
nodeId - the NodeId of the node to monitorattributeId - the attribute to monitormonitoringMode - the initial monitoring mode for the item. Specifies whether sampling and
reporting are enabled or disabled for a MonitoredItem.| Method Detail |
|---|
public boolean equals(Object obj)
equals in class MonitoredItemBasepublic org.opcfoundation.ua.builtintypes.StatusCode getErrorCode()
public org.opcfoundation.ua.builtintypes.ExpandedNodeId getExpandedNodeId()
public org.opcfoundation.ua.builtintypes.NodeId getNodeId()
getNodeId in class MonitoredItemBasepublic Subscription getSubscription()
public int hashCode()
hashCode in class MonitoredItemBasepublic boolean isModified()
public boolean isMonitoringModeModified()
protected void clearModified()
protected void clearMonitoringModeModified()
protected void itemChanged()
throws ServiceException
ServiceException
protected void monitoringModeChanged()
throws ServiceException
monitoringModeChanged in class MonitoredItemBaseServiceExceptionprotected void setClientHandle(int i)
i - protected void setErrorCode(org.opcfoundation.ua.builtintypes.StatusCode statusCode)
statusCode - protected void setFilterResult(org.opcfoundation.ua.core.MonitoringFilterResult filterResult)
setFilterResult in class MonitoredItemBasefilterResult - protected void setMonitoredItemId(org.opcfoundation.ua.builtintypes.UnsignedInteger monitoredItemId)
setMonitoredItemId in class MonitoredItemBaseprotected void setRevisedQueueSize(org.opcfoundation.ua.builtintypes.UnsignedInteger revisedQueueSize)
revisedQueueSize -
protected void updateFilter()
throws ServiceException
MonitoredItemBase
updateFilter in class MonitoredItemBaseServiceException
protected void updateQueue()
throws ServiceException
MonitoredItemBase
updateQueue in class MonitoredItemBaseServiceException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||