org.eclipse.milo.opcua.sdk.client.model.types.variables

Interface BuildInfoType

All Superinterfaces:

BaseDataVariableType, BaseVariableType, Node, VariableNode

All Known Implementing Classes:

BuildInfoTypeNode

public interface BuildInfoType
extends BaseDataVariableType

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	getBuildDate() Get the local value of the BuildDate Node.
BaseDataVariableType	getBuildDateNode() Get the BuildDate BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getBuildDateNodeAsync() Asynchronous implementation of getBuildDateNode().
String	getBuildNumber() Get the local value of the BuildNumber Node.
BaseDataVariableType	getBuildNumberNode() Get the BuildNumber BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getBuildNumberNodeAsync() Asynchronous implementation of getBuildNumberNode().
String	getManufacturerName() Get the local value of the ManufacturerName Node.
BaseDataVariableType	getManufacturerNameNode() Get the ManufacturerName BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getManufacturerNameNodeAsync() Asynchronous implementation of getManufacturerNameNode().
String	getProductName() Get the local value of the ProductName Node.
BaseDataVariableType	getProductNameNode() Get the ProductName BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getProductNameNodeAsync() Asynchronous implementation of getProductNameNode().
String	getProductUri() Get the local value of the ProductUri Node.
BaseDataVariableType	getProductUriNode() Get the ProductUri BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getProductUriNodeAsync() Asynchronous implementation of getProductUriNode().
String	getSoftwareVersion() Get the local value of the SoftwareVersion Node.
BaseDataVariableType	getSoftwareVersionNode() Get the SoftwareVersion BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getSoftwareVersionNodeAsync() Asynchronous implementation of getSoftwareVersionNode().
org.eclipse.milo.opcua.stack.core.types.builtin.DateTime	readBuildDate() Read the value of the BuildDate Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime>	readBuildDateAsync() An asynchronous implementation of readBuildDate().
String	readBuildNumber() Read the value of the BuildNumber Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readBuildNumberAsync() An asynchronous implementation of readBuildNumber().
String	readManufacturerName() Read the value of the ManufacturerName Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readManufacturerNameAsync() An asynchronous implementation of readManufacturerName().
String	readProductName() Read the value of the ProductName Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readProductNameAsync() An asynchronous implementation of readProductName().
String	readProductUri() Read the value of the ProductUri Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readProductUriAsync() An asynchronous implementation of readProductUri().
String	readSoftwareVersion() Read the value of the SoftwareVersion Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readSoftwareVersionAsync() An asynchronous implementation of readSoftwareVersion().
void	setBuildDate(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime buildDate) Set the local value of the BuildDate Node.
void	setBuildNumber(String buildNumber) Set the local value of the BuildNumber Node.
void	setManufacturerName(String manufacturerName) Set the local value of the ManufacturerName Node.
void	setProductName(String productName) Set the local value of the ProductName Node.
void	setProductUri(String productUri) Set the local value of the ProductUri Node.
void	setSoftwareVersion(String softwareVersion) Set the local value of the SoftwareVersion Node.
void	writeBuildDate(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime buildDate) Write a new value for the BuildDate Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeBuildDateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime buildDate) An asynchronous implementation of writeBuildDate(DateTime).
void	writeBuildNumber(String buildNumber) Write a new value for the BuildNumber Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeBuildNumberAsync(String buildNumber) An asynchronous implementation of writeBuildNumber(String).
void	writeManufacturerName(String manufacturerName) Write a new value for the ManufacturerName Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeManufacturerNameAsync(String manufacturerName) An asynchronous implementation of writeManufacturerName(String).
void	writeProductName(String productName) Write a new value for the ProductName Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeProductNameAsync(String productName) An asynchronous implementation of writeProductName(String).
void	writeProductUri(String productUri) Write a new value for the ProductUri Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeProductUriAsync(String productUri) An asynchronous implementation of writeProductUri(String).
void	writeSoftwareVersion(String softwareVersion) Write a new value for the SoftwareVersion Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSoftwareVersionAsync(String softwareVersion) An asynchronous implementation of writeSoftwareVersion(String).

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

getAccessLevel, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Method Detail

getProductUri

String getProductUri()
              throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ProductUri Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the ProductUri Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ProductUri Node.

setProductUri

void setProductUri(String productUri)
            throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ProductUri Node.

The value is only updated locally; it is not written to the server.

Parameters:

productUri - the local value to set for the ProductUri Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ProductUri Node.

readProductUri

String readProductUri()
               throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the ProductUri Node from the server and update the local value if the operation succeeds.

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeProductUri

void writeProductUri(String productUri)
              throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the ProductUri Node to the server and update the local value if the operation succeeds.

Parameters:

productUri - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readProductUriAsync

CompletableFuture<? extends String> readProductUriAsync()

An asynchronous implementation of readProductUri().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeProductUriAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeProductUriAsync(String productUri)

An asynchronous implementation of writeProductUri(String).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getProductUriNode

BaseDataVariableType getProductUriNode()
                                throws org.eclipse.milo.opcua.stack.core.UaException

Get the ProductUri BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the ProductUri BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getProductUriNodeAsync

CompletableFuture<? extends BaseDataVariableType> getProductUriNodeAsync()

Asynchronous implementation of getProductUriNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getManufacturerName

String getManufacturerName()
                    throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ManufacturerName Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the ManufacturerName Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ManufacturerName Node.

setManufacturerName

void setManufacturerName(String manufacturerName)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ManufacturerName Node.

The value is only updated locally; it is not written to the server.

Parameters:

manufacturerName - the local value to set for the ManufacturerName Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ManufacturerName Node.

readManufacturerName

String readManufacturerName()
                     throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the ManufacturerName Node from the server and update the local value if the operation succeeds.

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeManufacturerName

void writeManufacturerName(String manufacturerName)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the ManufacturerName Node to the server and update the local value if the operation succeeds.

Parameters:

manufacturerName - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readManufacturerNameAsync

CompletableFuture<? extends String> readManufacturerNameAsync()

An asynchronous implementation of readManufacturerName().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeManufacturerNameAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeManufacturerNameAsync(String manufacturerName)

An asynchronous implementation of writeManufacturerName(String).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getManufacturerNameNode

BaseDataVariableType getManufacturerNameNode()
                                      throws org.eclipse.milo.opcua.stack.core.UaException

Get the ManufacturerName BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the ManufacturerName BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getManufacturerNameNodeAsync

CompletableFuture<? extends BaseDataVariableType> getManufacturerNameNodeAsync()

Asynchronous implementation of getManufacturerNameNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getProductName

String getProductName()
               throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ProductName Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the ProductName Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ProductName Node.

setProductName

void setProductName(String productName)
             throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ProductName Node.

The value is only updated locally; it is not written to the server.

Parameters:

productName - the local value to set for the ProductName Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ProductName Node.

readProductName

String readProductName()
                throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the ProductName Node from the server and update the local value if the operation succeeds.

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeProductName

void writeProductName(String productName)
               throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the ProductName Node to the server and update the local value if the operation succeeds.

Parameters:

productName - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readProductNameAsync

CompletableFuture<? extends String> readProductNameAsync()

An asynchronous implementation of readProductName().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeProductNameAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeProductNameAsync(String productName)

An asynchronous implementation of writeProductName(String).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getProductNameNode

BaseDataVariableType getProductNameNode()
                                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the ProductName BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the ProductName BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getProductNameNodeAsync

CompletableFuture<? extends BaseDataVariableType> getProductNameNodeAsync()

Asynchronous implementation of getProductNameNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getSoftwareVersion

String getSoftwareVersion()
                   throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the SoftwareVersion Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the SoftwareVersion Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SoftwareVersion Node.

setSoftwareVersion

void setSoftwareVersion(String softwareVersion)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the SoftwareVersion Node.

The value is only updated locally; it is not written to the server.

Parameters:

softwareVersion - the local value to set for the SoftwareVersion Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SoftwareVersion Node.

readSoftwareVersion

String readSoftwareVersion()
                    throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the SoftwareVersion Node from the server and update the local value if the operation succeeds.

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeSoftwareVersion

void writeSoftwareVersion(String softwareVersion)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the SoftwareVersion Node to the server and update the local value if the operation succeeds.

Parameters:

softwareVersion - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readSoftwareVersionAsync

CompletableFuture<? extends String> readSoftwareVersionAsync()

An asynchronous implementation of readSoftwareVersion().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeSoftwareVersionAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSoftwareVersionAsync(String softwareVersion)

An asynchronous implementation of writeSoftwareVersion(String).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getSoftwareVersionNode

BaseDataVariableType getSoftwareVersionNode()
                                     throws org.eclipse.milo.opcua.stack.core.UaException

Get the SoftwareVersion BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the SoftwareVersion BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getSoftwareVersionNodeAsync

CompletableFuture<? extends BaseDataVariableType> getSoftwareVersionNodeAsync()

Asynchronous implementation of getSoftwareVersionNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getBuildNumber

String getBuildNumber()
               throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the BuildNumber Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the BuildNumber Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the BuildNumber Node.

setBuildNumber

void setBuildNumber(String buildNumber)
             throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the BuildNumber Node.

The value is only updated locally; it is not written to the server.

Parameters:

buildNumber - the local value to set for the BuildNumber Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the BuildNumber Node.

readBuildNumber

String readBuildNumber()
                throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the BuildNumber Node from the server and update the local value if the operation succeeds.

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeBuildNumber

void writeBuildNumber(String buildNumber)
               throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the BuildNumber Node to the server and update the local value if the operation succeeds.

Parameters:

buildNumber - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readBuildNumberAsync

CompletableFuture<? extends String> readBuildNumberAsync()

An asynchronous implementation of readBuildNumber().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeBuildNumberAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeBuildNumberAsync(String buildNumber)

An asynchronous implementation of writeBuildNumber(String).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getBuildNumberNode

BaseDataVariableType getBuildNumberNode()
                                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the BuildNumber BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the BuildNumber BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getBuildNumberNodeAsync

CompletableFuture<? extends BaseDataVariableType> getBuildNumberNodeAsync()

Asynchronous implementation of getBuildNumberNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

getBuildDate

org.eclipse.milo.opcua.stack.core.types.builtin.DateTime getBuildDate()
                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the BuildDate Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the BuildDate Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the BuildDate Node.

setBuildDate

void setBuildDate(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime buildDate)
           throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the BuildDate Node.

The value is only updated locally; it is not written to the server.

Parameters:

buildDate - the local value to set for the BuildDate Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the BuildDate Node.

readBuildDate

org.eclipse.milo.opcua.stack.core.types.builtin.DateTime readBuildDate()
                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the BuildDate Node from the server and update the local value if the operation succeeds.

Returns:

the DateTime value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeBuildDate

void writeBuildDate(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime buildDate)
             throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the BuildDate Node to the server and update the local value if the operation succeeds.

Parameters:

buildDate - the DateTime value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readBuildDateAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.DateTime> readBuildDateAsync()

An asynchronous implementation of readBuildDate().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeBuildDateAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeBuildDateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.DateTime buildDate)

An asynchronous implementation of writeBuildDate(DateTime).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getBuildDateNode

BaseDataVariableType getBuildDateNode()
                               throws org.eclipse.milo.opcua.stack.core.UaException

Get the BuildDate BaseDataVariableType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the BuildDate BaseDataVariableType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getBuildDateNodeAsync

CompletableFuture<? extends BaseDataVariableType> getBuildDateNodeAsync()

Asynchronous implementation of getBuildDateNode().

Returns:

a CompletableFuture that completes successfully with the ? extends BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.