com.inductiveautomation.ignition.gateway.opc

Interface OPCManager

All Superinterfaces:

ExtensionPointManager

public interface OPCManager
extends ExtensionPointManager

The public interface for the entire OPC system for conusmers of OPC data.

Method Summary

Modifier and Type	Method and Description
void	addOPCServerType(OPCServerType type) Adds a new kind of OPC Server to the system.
java.util.List<OPCBrowseElement>	browse(ServerNodeId nodeId) Browse the nodes immediately under the given node
void	cancelSubscription(java.lang.String subscriptionName) Cancels the subscription.
void	enableAutoCancel(java.lang.String subscriptionName) Once set, the subscription will be canceled as soon as all nodes are unsubscribed from it.
SROPCServer.State	getServerState(java.lang.String name) Returns the state of a named server.
SubscriptionModel	getSubscriptionModel()
java.util.List<QualifiedValue>	read(java.util.List<ServerNodeId> nodes) Reads the values addressed by the given nodes
void	removeOPCServerType(OPCServerType type) Removes a type of OPC Server from the system
void	setSubscriptionRate(java.lang.String subscriptionName, int newRate) Sets the desired subscription rate for the named subscription.
void	subscribe(java.util.List<? extends SubscribableNode> nodes) Subscribes to the given nodes.
void	unsubscribe(java.util.List<? extends SubscribableNode> nodes) Unsubscribes previously subscribed nodes
java.util.List<Quality>	write(java.util.List<OPCWriteRequest> values) Writes the values to their node ids

Methods inherited from interface com.inductiveautomation.ignition.gateway.model.ExtensionPointManager

getExtensionPoint, getExtensionPoints

Method Detail

getServerState

SROPCServer.State getServerState(java.lang.String name)

Returns the state of a named server. If the server does not exist, SROPCServer.State.UNKNOWN will be returned.

Parameters:

name - Name of the server.

Returns:

Server state, or SROPCServer.State.UNKNOWN if the server doesn't exist.

subscribe

void subscribe(java.util.List<? extends SubscribableNode> nodes)

Subscribes to the given nodes. Nodes may span various servers.

unsubscribe

void unsubscribe(java.util.List<? extends SubscribableNode> nodes)

Unsubscribes previously subscribed nodes

setSubscriptionRate

void setSubscriptionRate(java.lang.String subscriptionName,
                         int newRate)

Sets the desired subscription rate for the named subscription. Use to define a new subscription, or to alter a previously defined subscription. This rate will persist until cancelSubscription(String) is called.

Parameters:

subscriptionName - The name of the subscription. Will implicitly define any previously unknown subscriptions.

newRate - The new desired rate, in milliseconds.

cancelSubscription

void cancelSubscription(java.lang.String subscriptionName)

Cancels the subscription. If there are any subscribed nodes in this subscription, they will be unsubscribed. Any knowledge about this subscription, including its desired rate, will be purged.

enableAutoCancel

void enableAutoCancel(java.lang.String subscriptionName)

Once set, the subscription will be canceled as soon as all nodes are unsubscribed from it.

Parameters:

subscriptionName -

read

java.util.List<QualifiedValue> read(java.util.List<ServerNodeId> nodes)

Reads the values addressed by the given nodes

write

java.util.List<Quality> write(java.util.List<OPCWriteRequest> values)

Writes the values to their node ids

browse

java.util.List<OPCBrowseElement> browse(ServerNodeId nodeId)
                                 throws java.lang.Exception

Browse the nodes immediately under the given node

Throws:

java.lang.Exception

addOPCServerType

void addOPCServerType(OPCServerType type)
               throws java.lang.Exception

Adds a new kind of OPC Server to the system.

Throws:

java.lang.Exception

removeOPCServerType

void removeOPCServerType(OPCServerType type)
                  throws java.lang.Exception

Removes a type of OPC Server from the system

Throws:

java.lang.Exception

getSubscriptionModel

SubscriptionModel getSubscriptionModel()

Returns:

the SubscriptionModel managed by the OPC system. This is the same instance that is provided to SROPCServer.startup(SubscriptionModel).