com.prosysopc.ua.server

Class MonitoredDataItem

java.lang.Object

com.prosysopc.ua.MonitoredItemBase

com.prosysopc.ua.server.MonitoredItem

com.prosysopc.ua.server.MonitoredDataItem

public class MonitoredDataItem
extends MonitoredItem

Server side MonitoredItem, that is used for data changes monitoring, i.e. for any all Attributes except Attributes.EventNotifier.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MonitoredDataItem.AggregateFilterConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
protected MonitoredDataItem.AggregateFilterConfiguration	aggregateFilter
protected DataChangeListener	dataChangeListener
protected static DataValue	DELAY_SAMPLE

Fields inherited from class com.prosysopc.ua.server.MonitoredItem

links, node, subscription

Fields inherited from class com.prosysopc.ua.MonitoredItemBase

attributeId, clientHandle, dataEncoding, discardOldest, maxQueueSize, monitoredItemId, monitoringMode, nodeId, prevMonitoringMode, queueSize

Constructor Summary

Constructors

Constructor and Description
MonitoredDataItem(ServiceContext serviceContext, Subscription subscription, UnsignedInteger monitoredItemId, NodeId nodeId, UnsignedInteger attributeId, NumericRange indexRange, MonitoringMode monitoringMode) Creates a new MonitoredDataItem with the given parameters.

Method Summary

Modifier and Type	Method and Description
protected void	addNewSample(DataValue value, boolean mayReplaceLastSample)
protected DataValue	applyIndexRange(DataValue value)
protected void	assignEuRange(DataValue dataValue)
protected boolean	checkAggregate(DateTime currentTime)
protected boolean	checkDeadband(DataValue lastValue, DataValue value, DeadbandType deadbandType)
protected boolean	checkDeadband(DeadbandType deadbandType, Object lastValue, Object value)
protected void	clearQueue()
AggregateFilter	getAggregateFilter()
protected MonitoredDataItem.AggregateFilterConfiguration	getAggregateFilterConfiguration()
DataChangeFilter	getDataChangeFilter()
DataChangeTrigger	getDataChangeTrigger()
DeadbandType	getDeadbandType() DeadbandType defines how the getDeadbandValue() should be used.
double	getDeadbandValue() Deadband defines the minimum change that is required for the monitored value before a data change notifications should be sent to the client.
protected long	getDefaultQueueSize()
Range	getEuRange() The range defined for the monitoredItem
UaProperty	getEuRangeProperty() The property that defines the EuRange
NumericRange	getIndexRange() The range of array indexes to monitor with the monitored item.
DataValue	getLastValue()
protected DataValue	getNextSample(boolean isTrigger)
protected DataValue	getPrevValue()
protected BlockingDeque<DataValue>	getQueue()
double	getSamplingInterval() The SamplingInterval.
protected static long	getServerTimestampInMillis(DataValue lrv)
protected static long	getSourceTimestampInMillis(DataValue lrv)
protected double	getValueRange()
protected boolean	hasAggregateFilter()
boolean	hasMoreSamples()
protected void	initAggregateFilter()
protected boolean	isAccessible() Return true if the current Session of the item was allowed to access the node, note that this is calculated once per session activation and any changes in user access levels later is not taken into account.
protected boolean	isInSameSamplingInterval(DataValue value, DataValue prevSample, DataValue lastValue) Check if the new sample belongs to the same samplingInterval as lastValue, i.e.
protected void	monitoringModeChanged()
void	notifyDataChange(DataValue value) Report a new data change to the item.
void	notifyDataChange(DataValue value, boolean applyIndexRange) Report a new data change to the item.
protected void	notifyDataChange(DataValue value, boolean applyIndexRange, boolean cloneValue) Handle reporting of new data change to the item.
void	notifyResendData() Resend the lastValue - as a response to a ResendData request from the client.
void	onDataChange(UaNode sender, DataValue prevValue, DataValue value) Deprecated. use notifyDataChange(DataValue) instead.
protected void	plugNodeListener()
protected void	setDataChangeFilter(DataChangeFilter filter)
void	setEuRange(Range range) Define the EuRange corresponding to the monitored item.
void	setEuRangeProperty(UaProperty euRangeProperty) The property that defines the EuRange for the monitoredItem.
protected void	setIndexRange(NumericRange indexRange)
protected void	setLastValue(DataValue value, boolean updatePrevValue)
protected DataValue	setOverflowBit(DataValue value)
void	setSamplingInterval(double samplingInterval) The interval that defines the fastest rate at which the MonitoredItem(s) should be accessed and evaluated.
protected void	startSampling(boolean sendInitialValues) Start sampling for the item.
protected void	unPlugNodeListener()
protected void	updateAccessible(Session session)
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.server.MonitoredItem

addLink, close, equals, getMaxQueueSize, getNode, getServiceContext, getSubscription, getTimestampsToReturn, hashCode, removeLink, setClientHandle, setFilter, setFilterResult, setMaxQueueSize, setNode, setServiceContext, setTimestampsToReturn

Methods inherited from class com.prosysopc.ua.MonitoredItemBase

getAttributeId, getClientHandle, getDataEncoding, getFilter, getFilterResult, getMonitoredItemId, getMonitoringMode, getNodeId, getNodeIdAsString, getPrevMonitoringMode, getQueueSize, getUserData, isDiscardOldest, setDiscardOldest, setMonitoredItemId, setMonitoringMode, setQueueSize, setQueueSize, setUserData, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DELAY_SAMPLE

protected static final DataValue DELAY_SAMPLE

aggregateFilter

protected MonitoredDataItem.AggregateFilterConfiguration aggregateFilter

dataChangeListener

protected DataChangeListener dataChangeListener

Constructor Detail

MonitoredDataItem

public MonitoredDataItem(ServiceContext serviceContext,
                         Subscription subscription,
                         UnsignedInteger monitoredItemId,
                         NodeId nodeId,
                         UnsignedInteger attributeId,
                         NumericRange indexRange,
                         MonitoringMode monitoringMode)

Creates a new MonitoredDataItem with the given parameters.

Method Detail

getServerTimestampInMillis

protected static long getServerTimestampInMillis(DataValue lrv)

getSourceTimestampInMillis

protected static long getSourceTimestampInMillis(DataValue lrv)

getAggregateFilter

public AggregateFilter getAggregateFilter()

Returns:

the aggregateFilter defined for the monitored item

getDataChangeFilter

public DataChangeFilter getDataChangeFilter()

Returns:

the dataChangeFilter defined for the monitored item

getDataChangeTrigger

public DataChangeTrigger getDataChangeTrigger()

Returns:

the dataChangeTrigger defined for the monitored item

getDeadbandType

public DeadbandType getDeadbandType()

DeadbandType defines how the getDeadbandValue() should be used.

Returns:

the deadbandType

See Also:

getDeadbandValue()

getDeadbandValue

public double getDeadbandValue()

Deadband defines the minimum change that is required for the monitored value before a data change notifications should be sent to the client.

The value is applied depending on the getDeadbandType():

• Absolute: the value defines the minimum absolute change in value
• Percent: the value defines a percentage of the EU Range as defined by getEuRange()

Returns:

the deadbandValue

getEuRange

public Range getEuRange()

The range defined for the monitoredItem

Returns:

the euRange

See Also:

setEuRange(Range), setEuRangeProperty(UaProperty)

getEuRangeProperty

public UaProperty getEuRangeProperty()

The property that defines the EuRange

Returns:

the euRangeProperty

See Also:

setEuRange(Range), setEuRangeProperty(UaProperty)

getIndexRange

public NumericRange getIndexRange()

The range of array indexes to monitor with the monitored item.

Overrides:

getIndexRange in class MonitoredItemBase

Returns:

the indexRange

getLastValue

public DataValue getLastValue()

getSamplingInterval

public double getSamplingInterval()

Description copied from class: MonitoredItemBase

The SamplingInterval. This is only used for the monitored data items. For event items it is always 0.

Overrides:

getSamplingInterval in class MonitoredItemBase

Returns:

the requested sampling interval in milliseconds. If negative, then the publishingInterval of the Subscription is used.

hasMoreSamples

public boolean hasMoreSamples()

Returns:

true if the sample queue has more samples that have not been processed.

notifyDataChange

public void notifyDataChange(DataValue value)

Report a new data change to the item.

This method is used for non-UaNode items from your application to report value changes in the monitored item. UaNode-based items will monitor the nodes automatically.

The value will be checked against the filter and deadband defined by the client to determine if it really needs to be sent. getIndexRange() will be applied to the value, if defined.

Parameters:

value - the new value for the item.

See Also:

notifyDataChange(DataValue, boolean)

notifyDataChange

public void notifyDataChange(DataValue value,
                             boolean applyIndexRange)

Report a new data change to the item.

This method is used for non-UaNode items from your application to report value changes in the monitored item. UaNode-based items will monitor the nodes automatically.

The value will be checked against the filter and deadband defined by the client to determine if it really needs to be sent. You can define whether getIndexRange() should be applied to the value.

Parameters:

value - the new value for the item.

applyIndexRange - whether the getIndexRange() defined for the item should be applied to the value. Default is true, but if you have already applied the range before calling this method to notify the change, use false.

See Also:

notifyDataChange(DataValue)

notifyResendData

public void notifyResendData()

Resend the lastValue - as a response to a ResendData request from the client.

onDataChange

@Deprecated
public void onDataChange(UaNode sender,
                                      DataValue prevValue,
                                      DataValue value)

Deprecated. use notifyDataChange(DataValue) instead.

Report a new data change to the item.

This method is used for non-UaNode items from your application to report value changes in the monitored item. UaNode-based items will monitor the nodes automatically.

Parameters:

sender - not used

prevValue - not used

value - the new value for the item.

setEuRange

public void setEuRange(Range range)

Define the EuRange corresponding to the monitored item. The range is required to support Deadband of type Deadband.Percent.

You can define the range for each item when they are created, in NodeManager.afterCreateMonitoredDataItem(ServiceContext, Subscription, MonitoredDataItem) or NodeManagerListener.onAfterCreateMonitoredDataItem(ServiceContext, Subscription, MonitoredDataItem) .

If the monitoredItem is linked to an UaVariable (in MonitoredItem.getNode()), the range is looked among the properties of the variable. The property is then assigned to RangeProperty (with setEuRangeProperty(UaProperty).

Instead of Range you may also define RangeProperty, if it is not assigned automatically.

Parameters:

range - the range to set setEuRangeProperty(UaProperty)

setEuRangeProperty

public void setEuRangeProperty(UaProperty euRangeProperty)

The property that defines the EuRange for the monitoredItem. If you define the property, EuRange is assigned from the property value.

Parameters:

euRangeProperty - the euRangeProperty to set

See Also:

setEuRange(Range)

setSamplingInterval

public void setSamplingInterval(double samplingInterval)

The interval that defines the fastest rate at which the MonitoredItem(s) should be accessed and evaluated. This interval is defined in milliseconds.

The value 0 indicates that the Server should use the fastest practical rate.

The value -1 indicates that the default sampling interval defined by the publishing rate of the Subscription is used.

The Server uses this parameter to assign the MonitoredItems to a sampling interval that it supports.

The value can be modified at NodeManager#afterCreateMonitoredDataItem() or NodeManagerListener#onAfterCreateMonitoredDataItem() - and the updated value is returned as a revised value back to the client.

Parameters:

samplingInterval - the interval in milliseconds

addNewSample

protected void addNewSample(DataValue value,
                            boolean mayReplaceLastSample)

Parameters:

value -

mayReplaceLastSample -

applyIndexRange

protected DataValue applyIndexRange(DataValue value)

assignEuRange

protected void assignEuRange(DataValue dataValue)

Parameters:

dataValue -

checkAggregate

protected boolean checkAggregate(DateTime currentTime)

checkDeadband

protected boolean checkDeadband(DataValue lastValue,
                                DataValue value,
                                DeadbandType deadbandType)

checkDeadband

protected boolean checkDeadband(DeadbandType deadbandType,
                                Object lastValue,
                                Object value)

clearQueue

protected void clearQueue()

getAggregateFilterConfiguration

protected MonitoredDataItem.AggregateFilterConfiguration getAggregateFilterConfiguration()

getDefaultQueueSize

protected long getDefaultQueueSize()

Specified by:

getDefaultQueueSize in class MonitoredItemBase

Returns:

getNextSample

protected DataValue getNextSample(boolean isTrigger)

Returns:

the next sample in the queue or last sampled value (if no queue)

getPrevValue

protected DataValue getPrevValue()

getQueue

protected BlockingDeque<DataValue> getQueue()

getValueRange

protected double getValueRange()

Returns:

hasAggregateFilter

protected boolean hasAggregateFilter()

initAggregateFilter

protected void initAggregateFilter()

isAccessible

protected boolean isAccessible()

Return true if the current Session of the item was allowed to access the node, note that this is calculated once per session activation and any changes in user access levels later is not taken into account. If the Session didn't have access, returns false.

isInSameSamplingInterval

protected boolean isInSameSamplingInterval(DataValue value,
                                           DataValue prevSample,
                                           DataValue lastValue)

Check if the new sample belongs to the same samplingInterval as lastValue, i.e. timeDiff to prevSample is smaller than samplingInterval.

Parameters:

value - the new sample

prevSample - the previous sample that was recorded

lastValue - the last value that was recorded

Returns:

true if the new sample is closer to prevSample and lastValue than SamplingInterval

monitoringModeChanged

protected void monitoringModeChanged()
                              throws ServiceException

Overrides:

monitoringModeChanged in class MonitoredItem

Throws:

ServiceException

notifyDataChange

protected void notifyDataChange(DataValue value,
                                boolean applyIndexRange,
                                boolean cloneValue)

Handle reporting of new data change to the item.

plugNodeListener

protected void plugNodeListener()

Overrides:

plugNodeListener in class MonitoredItem

setDataChangeFilter

protected void setDataChangeFilter(DataChangeFilter filter)
                            throws ServiceException

Parameters:

filter -

Throws:

StatusException

ServiceException

setIndexRange

protected void setIndexRange(NumericRange indexRange)

Parameters:

indexRange -

setLastValue

protected void setLastValue(DataValue value,
                            boolean updatePrevValue)

Parameters:

value -

updatePrevValue -

setOverflowBit

protected DataValue setOverflowBit(DataValue value)

Parameters:

value -

Returns:

startSampling

protected void startSampling(boolean sendInitialValues)

Start sampling for the item. Note that the sendInitialValues refers to the TransferSubscriptions service call parameter and if this call is not made within the context of that it is true, but the MonitoringMode of the item can still be disabled.

unPlugNodeListener

protected void unPlugNodeListener()

Overrides:

unPlugNodeListener in class MonitoredItem

updateAccessible

protected void updateAccessible(Session session)

updateFilter

protected void updateFilter()

Description copied from class: MonitoredItemBase

React to changes in the filter.

Overrides:

updateFilter in class MonitoredItemBase

updateQueue

protected void updateQueue()

Update the queue, when it's size has changed.

Overrides:

updateQueue in class MonitoredItemBase