com.inductiveautomation.xopc.driver.api

Class AbstractTagDriver

java.lang.Object

com.inductiveautomation.xopc.driver.api.AbstractTagDriver

All Implemented Interfaces:

Driver

public abstract class AbstractTagDriver
extends java.lang.Object
implements Driver

Field Summary

Fields

Modifier and Type	Field and Description
protected DriverContext	driverContext
protected org.apache.log4j.Logger	log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTagDriver(DriverContext driverContext)

Method Summary

Modifier and Type	Method and Description
void	addDriverTag(DriverTag tag) Add a DriverTag.
void	browse(BrowseOperation browseOperation) Asynchronous browse operation.
void	buildNode(java.lang.String address, NodeId nodeId) For the given address, build an appropriate Node and at it to the UA address space.
protected java.lang.String	displayNameForNode(TagTree.TagTreeNode<?> node) Gets the text to use in Node.getDisplayName().
DriverTag	findDriverTag(java.lang.String address) Find and return the DriverTag with the given address.
protected java.util.EnumSet<AccessLevel>	getTagAccessLevel(DriverTag tag) DriverTags are readable by default and writable if they are instances of WritableDriverTag.
void	readItems(java.util.List<? extends ReadItem> items) Asynchronous read call for a list of items.
void	removeDriverTag(java.lang.String address) Removes the DriverTag at the given address.
void	shutdown() Called when a driver should cease all activities and shutdown any open connections.
void	writeItems(java.util.List<? extends WriteItem> items) Asynchronous write call for a list of items.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.xopc.driver.api.Driver

getDriverStatus

Field Detail

log

protected volatile org.apache.log4j.Logger log

driverContext

protected volatile DriverContext driverContext

Constructor Detail

AbstractTagDriver

protected AbstractTagDriver(DriverContext driverContext)

Method Detail

readItems

public void readItems(java.util.List<? extends ReadItem> items)

Description copied from interface: Driver

Asynchronous read call for a list of items. Read results are reported by calling ReadItem.setValue(DataValue).

Specified by:

readItems in interface Driver

writeItems

public void writeItems(java.util.List<? extends WriteItem> items)

Description copied from interface: Driver

Asynchronous write call for a list of items. Write results are reported by calling WriteItem.setWriteStatus(StatusCode).

Specified by:

writeItems in interface Driver

browse

public void browse(BrowseOperation browseOperation)

Description copied from interface: Driver

Asynchronous browse operation. When finished, call BrowseOperation.browseDone(StatusCode, List, Guid).

Specified by:

browse in interface Driver

shutdown

public void shutdown()

Description copied from interface: Driver

Called when a driver should cease all activities and shutdown any open connections. No further value updates should be processed.

Once a driver instance has been shutdown it will never be started/used again; a new instance will be created and used if needed.

Specified by:

shutdown in interface Driver

buildNode

public void buildNode(java.lang.String address,
                      NodeId nodeId)
               throws AddressNotFoundException

Description copied from interface: Driver

For the given address, build an appropriate Node and at it to the UA address space. See DriverContext.getNodeManager() and DriverContext.getNodeBuilderFactory() for more information.

If for any reason the node cannot be built AddressNotFoundException should be thrown.

Specified by:

buildNode in interface Driver

Parameters:

address - Address of the node that is to be built.

nodeId - The NodeId to use when building the Node for this address.

Throws:

AddressNotFoundException

addDriverTag

public void addDriverTag(DriverTag tag)

Add a DriverTag.

Parameters:

tag - The tag to add.

displayNameForNode

protected java.lang.String displayNameForNode(TagTree.TagTreeNode<?> node)

Gets the text to use in Node.getDisplayName(). Basically, this is whatever the address element is.

Parameters:

node -

Returns:

The display name to use for node.

getTagAccessLevel

protected java.util.EnumSet<AccessLevel> getTagAccessLevel(DriverTag tag)

DriverTags are readable by default and writable if they are instances of WritableDriverTag.

Parameters:

tag -

Returns:

The AccessLevels for this tag.

removeDriverTag

public void removeDriverTag(java.lang.String address)

Removes the DriverTag at the given address.

If the address points to a folder then the folder and all its children will be recursively removed.

Parameters:

address - The address to remove.

findDriverTag

public DriverTag findDriverTag(java.lang.String address)

Find and return the DriverTag with the given address.

Parameters:

address - The address of the DriverTag in to find.

Returns:

The DriverTag with the given address, or null if one cannot be found.