com.inductiveautomation.ignition.gateway.opc

Interface OpcSubscriptionNode

All Superinterfaces:

java.io.Serializable

public interface OpcSubscriptionNode
extends java.io.Serializable

An object that provides the information needed to subscribe to a node (the NodeSubscriptionDefinition), and receives the QualifiedValue when the subscribed node changes.

Method Summary

Modifier and Type	Method and Description
QualifiedValue	getLastSubscriptionValue() Retrieve the last value set by setValue(QualifiedValue) (possibly modified by a call to setQuality(StatusCode).
default java.lang.String	getNodeId()
NodeSubscriptionDefinition	getNodeSubscriptionDefinition() Retrieves the node subscription definition of what this node wants to subscribe to
default VersionedPropertySet	getProperties()
default java.lang.String	getServerName()
default ServerNodeId	getServerNodeId()
default java.lang.String	getSubscriptionName()
void	setQuality(QualityCode quality) Sets only the quality.
void	setValue(QualifiedValue value) Sets a new value for this subscribable node.

Method Detail

getNodeSubscriptionDefinition

NodeSubscriptionDefinition getNodeSubscriptionDefinition()

Retrieves the node subscription definition of what this node wants to subscribe to

getServerNodeId

default ServerNodeId getServerNodeId()

Returns:

this Node's ServerNodeId; the name of the OPC server it belongs to and its NodeId.

getServerName

default java.lang.String getServerName()

getNodeId

default java.lang.String getNodeId()

getSubscriptionName

default java.lang.String getSubscriptionName()

Returns:

the logical name of the subscription this Node belongs to.

getProperties

default VersionedPropertySet getProperties()

Returns:

a PropertySet containing configuration Property values for this node.

setValue

void setValue(QualifiedValue value)

Sets a new value for this subscribable node. This function can be called at any time, regardless of the nodes defined subscription rate. For example, if a driver provides a buffer of data, it can call this function for each value. Other settings in the system will dictate how the values are handled, such as whether each value is processed, or only the latest, after a period of time.

setQuality

void setQuality(QualityCode quality)

Sets only the quality. It is expected that the quality and timestamp will be updated, but the value will remain unchanged

getLastSubscriptionValue

QualifiedValue getLastSubscriptionValue()

Retrieve the last value set by setValue(QualifiedValue) (possibly modified by a call to setQuality(StatusCode). Used by the SubscriptionModel to feed the OPC status pane for diagnostic purposes.