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

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

Class BitFieldTypeNode

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.BitFieldTypeNode

All Implemented Interfaces:

BaseDataVariableType, BaseVariableType, BitFieldType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

public class BitFieldTypeNode
extends BaseDataVariableTypeNode
implements BitFieldType

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.BitFieldType

BIT_FIELDS_DEFINITIONS

Constructor Summary

Constructors

Constructor

Description

BitFieldTypeNode(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.BitFieldDefinition[]	getBitFieldsDefinitions()	Get the local value of the BitFieldsDefinitions Node.
PropertyTypeNode	getBitFieldsDefinitionsNode()	Get the BitFieldsDefinitions PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getBitFieldsDefinitionsNodeAsync()	Asynchronous implementation of BitFieldType.getBitFieldsDefinitionsNode().
org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]	readBitFieldsDefinitions()	Read the value of the BitFieldsDefinitions Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]>	readBitFieldsDefinitionsAsync()	An asynchronous implementation of BitFieldType.readBitFieldsDefinitions().
void	setBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] value)	Set the local value of the BitFieldsDefinitions Node.
void	writeBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] value)	Write a new value for the BitFieldsDefinitions Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeBitFieldsDefinitionsAsync(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] bitFieldsDefinitions)	An asynchronous implementation of BitFieldType.writeBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]).

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, readEngineeringUnitsAsync, 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, writeEngineeringUnitsAsync, 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.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

BitFieldTypeNode

public BitFieldTypeNode(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

getBitFieldsDefinitions

public org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] getBitFieldsDefinitions()
                                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: BitFieldType

Get the local value of the BitFieldsDefinitions Node.

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

Specified by:

getBitFieldsDefinitions in interface BitFieldType

Returns:

the local value of the BitFieldsDefinitions Node.

Throws:

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

setBitFieldsDefinitions

public void setBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] value)
                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: BitFieldType

Set the local value of the BitFieldsDefinitions Node.

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

Specified by:

setBitFieldsDefinitions in interface BitFieldType

Parameters:

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

Throws:

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

readBitFieldsDefinitions

public org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] readBitFieldsDefinitions()
                                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: BitFieldType

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

Specified by:

readBitFieldsDefinitions in interface BitFieldType

Returns:

the BitFieldDefinition value read from the server.

Throws:

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

writeBitFieldsDefinitions

public void writeBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] value)
                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: BitFieldType

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

Specified by:

writeBitFieldsDefinitions in interface BitFieldType

Parameters:

value - the BitFieldDefinition value to write to the server.

Throws:

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

readBitFieldsDefinitionsAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]> readBitFieldsDefinitionsAsync()

Description copied from interface: BitFieldType

An asynchronous implementation of BitFieldType.readBitFieldsDefinitions().

Specified by:

readBitFieldsDefinitionsAsync in interface BitFieldType

Returns:

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

writeBitFieldsDefinitionsAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeBitFieldsDefinitionsAsync(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[] bitFieldsDefinitions)

Description copied from interface: BitFieldType

An asynchronous implementation of BitFieldType.writeBitFieldsDefinitions(org.eclipse.milo.opcua.stack.core.types.structured.BitFieldDefinition[]).

Specified by:

writeBitFieldsDefinitionsAsync in interface BitFieldType

Returns:

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

getBitFieldsDefinitionsNode

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

Description copied from interface: BitFieldType

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

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

Specified by:

getBitFieldsDefinitionsNode in interface BitFieldType

Returns:

the BitFieldsDefinitions 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.

getBitFieldsDefinitionsNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getBitFieldsDefinitionsNodeAsync()

Description copied from interface: BitFieldType

Asynchronous implementation of BitFieldType.getBitFieldsDefinitionsNode().

Specified by:

getBitFieldsDefinitionsNodeAsync in interface BitFieldType

Returns:

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