Package com.inductiveautomation.ignition.gateway.util

Class BasicWriteRequest

java.lang.Object

com.inductiveautomation.ignition.gateway.util.BasicWriteRequest

All Implemented Interfaces:

OPCWriteRequest

public class BasicWriteRequest
extends java.lang.Object
implements OPCWriteRequest

A basic implementation of OPCWriteRequest. Stores a ServerNodeId and Value.

Field Summary

Fields

Modifier and Type	Field	Description
protected IndexRange	indexRange
protected ServerNodeId	nodeId
protected java.lang.Object	value

Constructor Summary

Constructors

Constructor	Description
BasicWriteRequest(ServerNodeId nodeId, java.lang.Object value)	Constructor that takes the id of the item to write to, and the value.
BasicWriteRequest(ServerNodeId nodeId, java.lang.Object value, IndexRange indexRange)
BasicWriteRequest(java.lang.String serverName, java.lang.String itemPath, java.lang.Object value)	Convenience constructor to build a write request out of basic values.
BasicWriteRequest(java.lang.String serverName, java.lang.String itemPath, java.lang.Object value, IndexRange indexRange)

Method Summary

Modifier and Type	Method	Description
java.util.Optional<IndexRange>	getIndexRange()	If present, the node identified by OPCWriteRequest.getNodeId() is an array this value should be written to the element or elements at the given IndexRange.
ServerNodeId	getNodeId()	The id to write to
java.lang.Object	getValue()	The value to write
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

nodeId

protected ServerNodeId nodeId

value

protected java.lang.Object value

indexRange

protected IndexRange indexRange

Constructor Detail

BasicWriteRequest

public BasicWriteRequest(java.lang.String serverName,
                         java.lang.String itemPath,
                         java.lang.Object value)

Convenience constructor to build a write request out of basic values. Creates a server node id automatically, with a string based identifier in namespace 0. If a different namespace is required, the ServerNodeId should be constructed manually and passed to the other constructor.

BasicWriteRequest

public BasicWriteRequest(java.lang.String serverName,
                         java.lang.String itemPath,
                         java.lang.Object value,
                         @Nullable
                         IndexRange indexRange)

BasicWriteRequest

public BasicWriteRequest(ServerNodeId nodeId,
                         java.lang.Object value)

Constructor that takes the id of the item to write to, and the value.

BasicWriteRequest

public BasicWriteRequest(ServerNodeId nodeId,
                         java.lang.Object value,
                         IndexRange indexRange)

Method Detail

getNodeId

public ServerNodeId getNodeId()

Description copied from interface: OPCWriteRequest

The id to write to

Specified by:

getNodeId in interface OPCWriteRequest

getValue

public java.lang.Object getValue()

Description copied from interface: OPCWriteRequest

The value to write

Specified by:

getValue in interface OPCWriteRequest

getIndexRange

public java.util.Optional<IndexRange> getIndexRange()

Description copied from interface: OPCWriteRequest

If present, the node identified by OPCWriteRequest.getNodeId() is an array this value should be written to the element or elements at the given IndexRange.

Specified by:

getIndexRange in interface OPCWriteRequest

Returns:

if present, the IndexRange to write this value to.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object