stella.net.ads

Class AdsVariableMonitor

java.lang.Object

stella.net.AbstractVariableMonitor

stella.net.ads.AdsVariableMonitor

All Implemented Interfaces:

CacheCaster, CacheChangedCaster

public class AdsVariableMonitor
extends AbstractVariableMonitor

Author:

wooz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdsVariableMonitor.Test

Field Summary

Fields

Modifier and Type	Field and Description
private AdsSocketChannel	beckhoff The ADS socket driver for variables retrieval.
private boolean	fixedhandles If true, we cache the variable handles, thus speeding up by factor 3.
private Map<String,AdsValue>	known The entire set of variables known in the PLC.
private Map<String,Long>	permanent The cached handles retrieved only once for each variable list change.

Constructor Summary

Constructors

Constructor and Description
AdsVariableMonitor(AdsSocketChannel ads) Construct the monitor with a valid ADS-Socket driver.

Method Summary

Modifier and Type	Method and Description
boolean	addMonitoring(Collection<String> vars) Clears any cached variable handles, regardless of the permanent handles setting.
private Map<String,Long>	getAdsHandles(Collection<String> vars)
private Map<String,AdsValue>	getAdsTypes(Collection<String> vars)
private Map<String,Number>	getAdsValues(Map<String,Long> handles, Map<String,AdsValue> skel)
private Map<String,Object>	readBeckhoff(Collection<String> vars, Map<String,AdsValue> skel) Refreshing a list of variables in a Beckhoff-ADS context means querying the underlying socket and returning the result.
protected Map<String,Object>	refreshVariables(Collection<String> vars) Refreshing a list of variables in a Beckhoff-ADS context means querying the underlying socket and returning the result.
void	setKnown(Map<String,AdsValue> known) Sets the list of all known variables, can be deduced from the driver info.
void	setPersistentHandles(boolean cachehandles) If true, we allow caching of the ADS variable handles retrieved once.
private boolean	usedHandles(Collection<Long> handles)

Methods inherited from class stella.net.AbstractVariableMonitor

addCacheChangedListener, addCacheListener, getMonitored, getVariable, isRunning, removeCacheChangedListener, removeCacheListener, removeMonitoring, setLock, startMonitoring, stopMonitoring

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

beckhoff

private final AdsSocketChannel beckhoff

The ADS socket driver for variables retrieval.

known

private Map<String,AdsValue> known

The entire set of variables known in the PLC.

fixedhandles

private boolean fixedhandles

If true, we cache the variable handles, thus speeding up by factor 3.

permanent

private Map<String,Long> permanent

The cached handles retrieved only once for each variable list change.

Constructor Detail

AdsVariableMonitor

public AdsVariableMonitor(AdsSocketChannel ads)

Construct the monitor with a valid ADS-Socket driver.

Parameters:

props -

Method Detail

setPersistentHandles

public void setPersistentHandles(boolean cachehandles)

If true, we allow caching of the ADS variable handles retrieved once.

Parameters:

cachehandles - the cachehandles to set

addMonitoring

public boolean addMonitoring(Collection<String> vars)

Clears any cached variable handles, regardless of the permanent handles setting.

Overrides:

addMonitoring in class AbstractVariableMonitor

Parameters:

vars -

Returns:

setKnown

public void setKnown(Map<String,AdsValue> known)

Sets the list of all known variables, can be deduced from the driver info.

Parameters:

known - the known to set

refreshVariables

protected Map<String,Object> refreshVariables(Collection<String> vars)

Refreshing a list of variables in a Beckhoff-ADS context means querying the underlying socket and returning the result.

Specified by:

refreshVariables in class AbstractVariableMonitor

Parameters:

vars - Names of all variables that should be refreshed

Returns:

A mapping of variable names to their current values.

readBeckhoff

private Map<String,Object> readBeckhoff(Collection<String> vars,
                                        Map<String,AdsValue> skel)
                                 throws IOException

Refreshing a list of variables in a Beckhoff-ADS context means querying the underlying socket and returning the result.

Parameters:

vars -

skel -

Returns:

Throws:

IOException

getAdsTypes

private Map<String,AdsValue> getAdsTypes(Collection<String> vars)

getAdsHandles

private Map<String,Long> getAdsHandles(Collection<String> vars)
                                throws IOException

Throws:

IOException

getAdsValues

private Map<String,Number> getAdsValues(Map<String,Long> handles,
                                        Map<String,AdsValue> skel)
                                 throws IOException

Throws:

IOException

usedHandles

private boolean usedHandles(Collection<Long> handles)
                     throws IOException

Throws:

IOException