Package de.iip_ecosphere.platform.connectors.opcuav1

Class OpcUaConnector.OpcUaModelAccess

java.lang.Object

de.iip_ecosphere.platform.connectors.model.AbstractModelAccess

de.iip_ecosphere.platform.connectors.opcuav1.OpcUaConnector.OpcUaModelAccess

All Implemented Interfaces:

de.iip_ecosphere.platform.connectors.model.ModelAccess

Enclosing class:

OpcUaConnector<CO,CI>

protected class OpcUaConnector.OpcUaModelAccess
extends de.iip_ecosphere.platform.connectors.model.AbstractModelAccess

Implements the model access for OPC UA.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested classes/interfaces inherited from class de.iip_ecosphere.platform.connectors.model.AbstractModelAccess

de.iip_ecosphere.platform.connectors.model.AbstractModelAccess.NotificationChangedListener

Field Summary

Fields

Modifier and Type	Field	Description
private OpcUaConnector.NodeCacheEntry	base
private String	basePath
private OpcUaConnector.OpcInputConverter	inputConverter
private Map<String,OpcUaConnector.NodeCacheEntry>	nodes
private OpcUaConnector.OpcOutputConverter	outputConverter
private OpcUaConnector<CO,CI>.OpcUaModelAccess	parent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpcUaModelAccess()	Creates the instance and binds the listener to the creating connector instance.
protected	OpcUaModelAccess(OpcUaConnector.NodeCacheEntry base, String basePath, OpcUaConnector<CO,CI>.OpcUaModelAccess parent, Map<String,OpcUaConnector.NodeCacheEntry> nodes)	Creates the instance and binds the listener to the creating connector instance.

Method Summary

Modifier and Type	Method	Description
private void	browseNode(String indent, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId browseRoot)	Just for testing, see Identifiers.RootFolder.
Object	call(String qName, Object... args)
Object	get(String qName)
Object	get(String qName, int lifetime)
de.iip_ecosphere.platform.connectors.ConnectorParameter	getConnectorParameter()
private org.eclipse.milo.opcua.stack.core.types.builtin.ExpandedNodeId	getEncodingId(Class<?> cls)	Returns the encodingId of a custom type.
de.iip_ecosphere.platform.connectors.model.ModelInputConverter	getInputConverter()	Returns the input converter instance.
de.iip_ecosphere.platform.connectors.model.ModelOutputConverter	getOutputConverter()	Returns the output converter instance.
String	getQSeparator()
<T> T	getStruct(String qName, Class<T> type)
void	monitor(int notificationInterval, String... qName)
void	monitorModelChanges(int notificationInterval)
private void	onEvent(org.eclipse.milo.opcua.sdk.client.api.subscriptions.UaMonitoredItem item, org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] var)	Is called when a monitoring event occurs.
private void	onSubscriptionValue(org.eclipse.milo.opcua.sdk.client.api.subscriptions.UaMonitoredItem item, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)	Is called on changing a monitored item.
void	registerCustomType(Class<?> cls)
private OpcUaConnector.NodeCacheEntry	retrieveCacheEntry(String qName)	Retrieves a node starting at the root of the OPC UA model based on the node's qualified name qName.
void	retrieveChildsOfChildNodes(String currentPath, List<? extends org.eclipse.milo.opcua.sdk.client.nodes.UaNode> parentNodes)	Retrieving/caching child nodes via path.
private void	retrieveChildsOfChildNodes(List<? extends org.eclipse.milo.opcua.sdk.client.nodes.UaNode> parentNodes)	Retrieving/caching child nodes via NodeIDs.
private org.eclipse.milo.opcua.sdk.client.nodes.UaNode	retrieveNode(String qName)	Retrieves a node starting at current recursively following the path given by qName.
private org.eclipse.milo.opcua.sdk.client.nodes.UaNode	retrieveNode(org.eclipse.milo.opcua.sdk.client.nodes.UaNode current, String qName, String constqName)	Retrieves a node starting at current recursively following the path given by qName.
private org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode	retrieveVariableNode(String qName, OpcUaConnector.NodeCacheEntry entry)	Retrieves an OPC UA variable node from a cache node entry.
void	set(String qName, Object value)
void	setStruct(String qName, Object value)
OpcUaConnector<CO,CI>.OpcUaModelAccess	stepInto(String name)
OpcUaConnector<CO,CI>.OpcUaModelAccess	stepOut()
String	topInstancesQName()

Methods inherited from class de.iip_ecosphere.platform.connectors.model.AbstractModelAccess

iqName, isDetailNotifiedItemEnabled, monitor, monitorModelChanges, qName, setDetailNotifiedItem, useNotifications, useNotifications

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.iip_ecosphere.platform.connectors.model.ModelAccess

dispose, getBoolean, getByte, getDouble, getFloat, getFloatIndex, getInt, getLong, getLongIndex, getMultiValue, getShort, getString, setBoolean, setByte, setDouble, setFloat, setFloatIndex, setInt, setLong, setLongIndex, setMultiValue, setMultiValue, setShort, setString

Field Details

nodes

private Map<String,OpcUaConnector.NodeCacheEntry> nodes

base

private OpcUaConnector.NodeCacheEntry base

basePath

private String basePath

parent

private OpcUaConnector<CO,CI>.OpcUaModelAccess parent

inputConverter

private OpcUaConnector.OpcInputConverter inputConverter

outputConverter

private OpcUaConnector.OpcOutputConverter outputConverter

Constructor Details

OpcUaModelAccess

protected OpcUaModelAccess()

Creates the instance and binds the listener to the creating connector instance.

OpcUaModelAccess

protected OpcUaModelAccess(OpcUaConnector.NodeCacheEntry base,
 String basePath,
 OpcUaConnector<CO,CI>.OpcUaModelAccess parent,
 Map<String,OpcUaConnector.NodeCacheEntry> nodes)

Creates the instance and binds the listener to the creating connector instance.

Parameters:

base - the context node to resolve non-nested names on

basePath - the base path this context represente

parent - the parent to return to in stepOut()

nodes - the (parent) nodes cache to use

Method Details

topInstancesQName

public String topInstancesQName()

getQSeparator

public String getQSeparator()

getInputConverter

public de.iip_ecosphere.platform.connectors.model.ModelInputConverter getInputConverter()

Returns the input converter instance.

Returns:

the input converter

getOutputConverter

public de.iip_ecosphere.platform.connectors.model.ModelOutputConverter getOutputConverter()

Returns the output converter instance.

Returns:

the output converter

call

public Object call(String qName,
 Object... args)
            throws IOException

Throws:

IOException

browseNode

private void browseNode(String indent,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId browseRoot)

Just for testing, see Identifiers.RootFolder.

Parameters:

indent - output indent

browseRoot - the node id to start browsing at

retrieveVariableNode

private org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode retrieveVariableNode(String qName,
 OpcUaConnector.NodeCacheEntry entry)
                                                                             throws org.eclipse.milo.opcua.stack.core.UaException,
IOException

Retrieves an OPC UA variable node from a cache node entry.

Parameters:

qName - the qualified node name (for exception message)

entry - the cache entry to read the variable node from

Returns:

the variable node

Throws:

IOException - if no node can be found for qName or if the found node is not a variable node

org.eclipse.milo.opcua.stack.core.UaException - if accessing/browsing the OPC UA model fails

retrieveCacheEntry

private OpcUaConnector.NodeCacheEntry retrieveCacheEntry(String qName)
                                                  throws org.eclipse.milo.opcua.stack.core.UaException,
IOException

Retrieves a node starting at the root of the OPC UA model based on the node's qualified name qName. Takes into account the nodes cache.

Parameters:

qName - the qualified node name

Returns:

the node

Throws:

IOException - if no node can be found for qName

org.eclipse.milo.opcua.stack.core.UaException - if accessing/browsing the OPC UA model fails

retrieveNode

private org.eclipse.milo.opcua.sdk.client.nodes.UaNode retrieveNode(String qName)
                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Retrieves a node starting at current recursively following the path given by qName.

Parameters:

qName - the qualified node name

Returns:

the node or null for none found

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if accessing/browsing the OPC UA model fails

retrieveNode

private org.eclipse.milo.opcua.sdk.client.nodes.UaNode retrieveNode(org.eclipse.milo.opcua.sdk.client.nodes.UaNode current,
 String qName,
 String constqName)
                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Retrieves a node starting at current recursively following the path given by qName.

Parameters:

current - the current node to start searching for, may be null for top-level

qName - the qualified node name

constqName - the initial qualified node name of first method call

Returns:

the node or null for none found

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if accessing/browsing the OPC UA model fails

retrieveChildsOfChildNodes

public void retrieveChildsOfChildNodes(String currentPath,
 List<? extends org.eclipse.milo.opcua.sdk.client.nodes.UaNode> parentNodes)

Retrieving/caching child nodes via path.

Parameters:

currentPath - the current path to be attached

parentNodes - the parent nodes to process

retrieveChildsOfChildNodes

private void retrieveChildsOfChildNodes(List<? extends org.eclipse.milo.opcua.sdk.client.nodes.UaNode> parentNodes)

Retrieving/caching child nodes via NodeIDs.

Parameters:

parentNodes - the parent nodes to process

get

public Object get(String qName)
           throws IOException

Throws:

IOException

get

public Object get(String qName,
 int lifetime)
           throws IOException

Throws:

IOException

set

public void set(String qName,
 Object value)
         throws IOException

Throws:

IOException

getStruct

public <T> T getStruct(String qName,
 Class<T> type)
                throws IOException

Throws:

IOException

setStruct

public void setStruct(String qName,
 Object value)
               throws IOException

Throws:

IOException

getEncodingId

private org.eclipse.milo.opcua.stack.core.types.builtin.ExpandedNodeId getEncodingId(Class<?> cls)
                                                                              throws IOException

Returns the encodingId of a custom type.

Parameters:

cls - the type class

Returns:

the encodingId

Throws:

IOException - if the encodingID cannot be found

registerCustomType

public void registerCustomType(Class<?> cls)
                        throws IOException

Throws:

IOException

getConnectorParameter

public de.iip_ecosphere.platform.connectors.ConnectorParameter getConnectorParameter()

Specified by:

getConnectorParameter in class de.iip_ecosphere.platform.connectors.model.AbstractModelAccess

monitor

public void monitor(int notificationInterval,
 String... qName)
             throws IOException

Throws:

IOException

monitorModelChanges

public void monitorModelChanges(int notificationInterval)
                         throws IOException

Throws:

IOException

onSubscriptionValue

private void onSubscriptionValue(org.eclipse.milo.opcua.sdk.client.api.subscriptions.UaMonitoredItem item,
 org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)

Is called on changing a monitored item.

Parameters:

item - the monitored item

value - the new data value

onEvent

private void onEvent(org.eclipse.milo.opcua.sdk.client.api.subscriptions.UaMonitoredItem item,
 org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] var)

Is called when a monitoring event occurs.

Parameters:

item - the monitored item

var - the changed values/variants

stepInto

public OpcUaConnector<CO,CI>.OpcUaModelAccess stepInto(String name)
                                                throws IOException

Throws:

IOException

stepOut

public OpcUaConnector<CO,CI>.OpcUaModelAccess stepOut()