Module org.eclipse.milo.opcua.sdk.client

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

Class AnalogUnitTypeNode

java.lang.Object

org.eclipse.milo.opcua.sdk.client.nodes.UaNode

org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

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

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

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

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

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

All Implemented Interfaces:

AnalogUnitType, BaseAnalogType, BaseDataVariableType, BaseVariableType, DataItemType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

public class AnalogUnitTypeNode
extends BaseAnalogTypeNode
implements AnalogUnitType

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

client

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.AnalogUnitType

ENGINEERING_UNITS

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.BaseAnalogType

ENGINEERING_UNITS, EU_RANGE, INSTRUMENT_RANGE

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.DataItemType

DEFINITION, VALUE_PRECISION

Constructor Summary

Constructors

Constructor

Description

AnalogUnitTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType, Integer valueRank, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel, Double minimumSamplingInterval, Boolean historizing, org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.structured.EUInformation	getEngineeringUnits()	Get the local value of the EngineeringUnits Node.
PropertyTypeNode	getEngineeringUnitsNode()	Get the EngineeringUnits PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getEngineeringUnitsNodeAsync()	Asynchronous implementation of BaseAnalogType.getEngineeringUnitsNode().
org.eclipse.milo.opcua.stack.core.types.structured.EUInformation	readEngineeringUnits()	Read the value of the EngineeringUnits Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EUInformation>	readEngineeringUnitsAsync()	Get the value of the VariableNodeProperties.EngineeringUnits Property, if it exists.
void	setEngineeringUnits(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)	Set the local value of the EngineeringUnits Node.
void	writeEngineeringUnits(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)	Write a new value for the EngineeringUnits Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEngineeringUnitsAsync(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation engineeringUnits)	Set the value of the VariableNodeProperties.EngineeringUnits Property, if it exists.

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.variables.BaseAnalogTypeNode

getEuRange, getEuRangeNode, getEuRangeNodeAsync, getInstrumentRange, getInstrumentRangeNode, getInstrumentRangeNodeAsync, readEuRange, readEuRangeAsync, readInstrumentRange, readInstrumentRangeAsync, setEuRange, setInstrumentRange, writeEuRange, writeEuRangeAsync, writeInstrumentRange, writeInstrumentRangeAsync

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.variables.DataItemTypeNode

getDefinition, getDefinitionNode, getDefinitionNodeAsync, getValuePrecision, getValuePrecisionNode, getValuePrecisionNodeAsync, readDefinition, readDefinitionAsync, readValuePrecision, readValuePrecisionAsync, setDefinition, setValuePrecision, writeDefinition, writeDefinitionAsync, writeValuePrecision, writeValuePrecisionAsync

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

getAccessLevel, getAccessLevelEx, getArrayDimensions, getAttributeValue, getDataType, getHistorizing, getMinimumSamplingInterval, getTypeDefinition, getTypeDefinitionAsync, getUserAccessLevel, getValue, getValueRank, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readAccessLevel, readAccessLevelEx, readAllowNullsAsync, readArrayDimensions, readDataType, readDataTypeVersionAsync, readDictionaryFragmentAsync, readHistorizing, readLocalTimeAsync, readMaxArrayLengthAsync, readMaxStringLengthAsync, readMinimumSamplingInterval, readNodeVersionAsync, readUserAccessLevel, readValue, readValueAsTextAsync, readValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setAttributeValue, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValue, setValueRank, writeAccessLevel, writeAccessLevelEx, writeAllowNullsAsync, writeArrayDimensions, writeDataType, writeDataTypeVersionAsync, writeDictionaryFragmentAsync, writeHistorizing, writeLocalTimeAsync, writeMaxArrayLengthAsync, writeMaxStringLengthAsync, writeMinimumSamplingInterval, writeNodeVersionAsync, writeUserAccessLevel, writeValue, writeValue, writeValueAsTextAsync, writeValueRank

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, writeUserWriteMask, writeWriteMask

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.BaseAnalogType

getEuRange, getEuRangeNode, getEuRangeNodeAsync, getInstrumentRange, getInstrumentRangeNode, getInstrumentRangeNodeAsync, readEuRange, readEuRangeAsync, readInstrumentRange, readInstrumentRangeAsync, setEuRange, setInstrumentRange, writeEuRange, writeEuRangeAsync, writeInstrumentRange, writeInstrumentRangeAsync

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.DataItemType

getDefinition, getDefinitionNode, getDefinitionNodeAsync, getValuePrecision, getValuePrecisionNode, getValuePrecisionNodeAsync, readDefinition, readDefinitionAsync, readValuePrecision, readValuePrecisionAsync, setDefinition, setValuePrecision, writeDefinition, writeDefinitionAsync, writeValuePrecision, writeValuePrecisionAsync

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

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

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

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

Constructor Details

AnalogUnitTypeNode

public AnalogUnitTypeNode(OpcUaClient client,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
 org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass,
 org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions,
 org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType,
 Integer valueRank,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel,
 Double minimumSamplingInterval,
 Boolean historizing,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Details

getEngineeringUnits

public org.eclipse.milo.opcua.stack.core.types.structured.EUInformation getEngineeringUnits()
                                                                                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: BaseAnalogType

Get the local value of the EngineeringUnits Node.

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

Specified by:

getEngineeringUnits in interface AnalogUnitType

Specified by:

getEngineeringUnits in interface BaseAnalogType

Overrides:

getEngineeringUnits in class BaseAnalogTypeNode

Returns:

the local value of the EngineeringUnits Node.

Throws:

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

setEngineeringUnits

public void setEngineeringUnits(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: BaseAnalogType

Set the local value of the EngineeringUnits Node.

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

Specified by:

setEngineeringUnits in interface AnalogUnitType

Specified by:

setEngineeringUnits in interface BaseAnalogType

Overrides:

setEngineeringUnits in class BaseAnalogTypeNode

Parameters:

value - the local value to set for the EngineeringUnits Node.

Throws:

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

readEngineeringUnits

public org.eclipse.milo.opcua.stack.core.types.structured.EUInformation readEngineeringUnits()
                                                                                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: BaseAnalogType

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

Specified by:

readEngineeringUnits in interface AnalogUnitType

Specified by:

readEngineeringUnits in interface BaseAnalogType

Overrides:

readEngineeringUnits in class BaseAnalogTypeNode

Returns:

the EUInformation value read from the server.

Throws:

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

writeEngineeringUnits

public void writeEngineeringUnits(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation value)
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: BaseAnalogType

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

Specified by:

writeEngineeringUnits in interface AnalogUnitType

Specified by:

writeEngineeringUnits in interface BaseAnalogType

Overrides:

writeEngineeringUnits in class BaseAnalogTypeNode

Parameters:

value - the EUInformation value to write to the server.

Throws:

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

readEngineeringUnitsAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EUInformation> readEngineeringUnitsAsync()

Description copied from class: UaVariableNode

Get the value of the VariableNodeProperties.EngineeringUnits Property, if it exists.

Specified by:

readEngineeringUnitsAsync in interface AnalogUnitType

Specified by:

readEngineeringUnitsAsync in interface BaseAnalogType

Overrides:

readEngineeringUnitsAsync in class BaseAnalogTypeNode

Returns:

the value of the EngineeringUnits Property, if it exists.

See Also:

• VariableNodeProperties

writeEngineeringUnitsAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEngineeringUnitsAsync(org.eclipse.milo.opcua.stack.core.types.structured.EUInformation engineeringUnits)

Description copied from class: UaVariableNode

Set the value of the VariableNodeProperties.EngineeringUnits Property, if it exists.

Specified by:

writeEngineeringUnitsAsync in interface AnalogUnitType

Specified by:

writeEngineeringUnitsAsync in interface BaseAnalogType

Overrides:

writeEngineeringUnitsAsync in class BaseAnalogTypeNode

Parameters:

engineeringUnits - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

• VariableNodeProperties

getEngineeringUnitsNode

public PropertyTypeNode getEngineeringUnitsNode()
                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: BaseAnalogType

Get the EngineeringUnits PropertyType Node, or null if it does not exist.

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

Specified by:

getEngineeringUnitsNode in interface AnalogUnitType

Specified by:

getEngineeringUnitsNode in interface BaseAnalogType

Overrides:

getEngineeringUnitsNode in class BaseAnalogTypeNode

Returns:

the EngineeringUnits PropertyType 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.

getEngineeringUnitsNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getEngineeringUnitsNodeAsync()

Description copied from interface: BaseAnalogType

Asynchronous implementation of BaseAnalogType.getEngineeringUnitsNode().

Specified by:

getEngineeringUnitsNodeAsync in interface AnalogUnitType

Specified by:

getEngineeringUnitsNodeAsync in interface BaseAnalogType

Overrides:

getEngineeringUnitsNodeAsync in class BaseAnalogTypeNode

Returns:

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