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

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

Class AudioVariableTypeNode

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

All Implemented Interfaces:

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

public class AudioVariableTypeNode
extends BaseDataVariableTypeNode
implements AudioVariableType

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

AGENCY_ID, LIST_ID, VERSION_ID

Constructor Summary

Constructors

Constructor

Description

AudioVariableTypeNode(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
String	getAgencyId()	Get the local value of the AgencyId Node.
PropertyTypeNode	getAgencyIdNode()	Get the AgencyId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getAgencyIdNodeAsync()	Asynchronous implementation of AudioVariableType.getAgencyIdNode().
String	getListId()	Get the local value of the ListId Node.
PropertyTypeNode	getListIdNode()	Get the ListId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getListIdNodeAsync()	Asynchronous implementation of AudioVariableType.getListIdNode().
String	getVersionId()	Get the local value of the VersionId Node.
PropertyTypeNode	getVersionIdNode()	Get the VersionId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getVersionIdNodeAsync()	Asynchronous implementation of AudioVariableType.getVersionIdNode().
String	readAgencyId()	Read the value of the AgencyId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readAgencyIdAsync()	An asynchronous implementation of AudioVariableType.readAgencyId().
String	readListId()	Read the value of the ListId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readListIdAsync()	An asynchronous implementation of AudioVariableType.readListId().
String	readVersionId()	Read the value of the VersionId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readVersionIdAsync()	An asynchronous implementation of AudioVariableType.readVersionId().
void	setAgencyId(String value)	Set the local value of the AgencyId Node.
void	setListId(String value)	Set the local value of the ListId Node.
void	setVersionId(String value)	Set the local value of the VersionId Node.
void	writeAgencyId(String value)	Write a new value for the AgencyId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeAgencyIdAsync(String agencyId)	An asynchronous implementation of AudioVariableType.writeAgencyId(java.lang.String).
void	writeListId(String value)	Write a new value for the ListId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeListIdAsync(String listId)	An asynchronous implementation of AudioVariableType.writeListId(java.lang.String).
void	writeVersionId(String value)	Write a new value for the VersionId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeVersionIdAsync(String versionId)	An asynchronous implementation of AudioVariableType.writeVersionId(java.lang.String).

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

AudioVariableTypeNode

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

getListId

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

Description copied from interface: AudioVariableType

Get the local value of the ListId Node.

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

Specified by:

getListId in interface AudioVariableType

Returns:

the local value of the ListId Node.

Throws:

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

setListId

public void setListId(String value)
               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AudioVariableType

Set the local value of the ListId Node.

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

Specified by:

setListId in interface AudioVariableType

Parameters:

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

Throws:

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

readListId

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

Description copied from interface: AudioVariableType

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

Specified by:

readListId in interface AudioVariableType

Returns:

the String value read from the server.

Throws:

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

writeListId

public void writeListId(String value)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AudioVariableType

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

Specified by:

writeListId in interface AudioVariableType

Parameters:

value - the String value to write to the server.

Throws:

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

readListIdAsync

public CompletableFuture<? extends String> readListIdAsync()

Description copied from interface: AudioVariableType

An asynchronous implementation of AudioVariableType.readListId().

Specified by:

readListIdAsync in interface AudioVariableType

Returns:

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

writeListIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeListIdAsync(String listId)

Description copied from interface: AudioVariableType

An asynchronous implementation of AudioVariableType.writeListId(java.lang.String).

Specified by:

writeListIdAsync in interface AudioVariableType

Returns:

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

getListIdNode

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

Description copied from interface: AudioVariableType

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

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

Specified by:

getListIdNode in interface AudioVariableType

Returns:

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

getListIdNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getListIdNodeAsync()

Description copied from interface: AudioVariableType

Asynchronous implementation of AudioVariableType.getListIdNode().

Specified by:

getListIdNodeAsync in interface AudioVariableType

Returns:

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

getAgencyId

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

Description copied from interface: AudioVariableType

Get the local value of the AgencyId Node.

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

Specified by:

getAgencyId in interface AudioVariableType

Returns:

the local value of the AgencyId Node.

Throws:

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

setAgencyId

public void setAgencyId(String value)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AudioVariableType

Set the local value of the AgencyId Node.

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

Specified by:

setAgencyId in interface AudioVariableType

Parameters:

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

Throws:

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

readAgencyId

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

Description copied from interface: AudioVariableType

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

Specified by:

readAgencyId in interface AudioVariableType

Returns:

the String value read from the server.

Throws:

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

writeAgencyId

public void writeAgencyId(String value)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AudioVariableType

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

Specified by:

writeAgencyId in interface AudioVariableType

Parameters:

value - the String value to write to the server.

Throws:

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

readAgencyIdAsync

public CompletableFuture<? extends String> readAgencyIdAsync()

Description copied from interface: AudioVariableType

An asynchronous implementation of AudioVariableType.readAgencyId().

Specified by:

readAgencyIdAsync in interface AudioVariableType

Returns:

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

writeAgencyIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeAgencyIdAsync(String agencyId)

Description copied from interface: AudioVariableType

An asynchronous implementation of AudioVariableType.writeAgencyId(java.lang.String).

Specified by:

writeAgencyIdAsync in interface AudioVariableType

Returns:

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

getAgencyIdNode

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

Description copied from interface: AudioVariableType

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

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

Specified by:

getAgencyIdNode in interface AudioVariableType

Returns:

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

getAgencyIdNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getAgencyIdNodeAsync()

Description copied from interface: AudioVariableType

Asynchronous implementation of AudioVariableType.getAgencyIdNode().

Specified by:

getAgencyIdNodeAsync in interface AudioVariableType

Returns:

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

getVersionId

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

Description copied from interface: AudioVariableType

Get the local value of the VersionId Node.

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

Specified by:

getVersionId in interface AudioVariableType

Returns:

the local value of the VersionId Node.

Throws:

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

setVersionId

public void setVersionId(String value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AudioVariableType

Set the local value of the VersionId Node.

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

Specified by:

setVersionId in interface AudioVariableType

Parameters:

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

Throws:

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

readVersionId

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

Description copied from interface: AudioVariableType

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

Specified by:

readVersionId in interface AudioVariableType

Returns:

the String value read from the server.

Throws:

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

writeVersionId

public void writeVersionId(String value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AudioVariableType

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

Specified by:

writeVersionId in interface AudioVariableType

Parameters:

value - the String value to write to the server.

Throws:

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

readVersionIdAsync

public CompletableFuture<? extends String> readVersionIdAsync()

Description copied from interface: AudioVariableType

An asynchronous implementation of AudioVariableType.readVersionId().

Specified by:

readVersionIdAsync in interface AudioVariableType

Returns:

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

writeVersionIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeVersionIdAsync(String versionId)

Description copied from interface: AudioVariableType

An asynchronous implementation of AudioVariableType.writeVersionId(java.lang.String).

Specified by:

writeVersionIdAsync in interface AudioVariableType

Returns:

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

getVersionIdNode

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

Description copied from interface: AudioVariableType

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

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

Specified by:

getVersionIdNode in interface AudioVariableType

Returns:

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

getVersionIdNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getVersionIdNodeAsync()

Description copied from interface: AudioVariableType

Asynchronous implementation of AudioVariableType.getVersionIdNode().

Specified by:

getVersionIdNodeAsync in interface AudioVariableType

Returns:

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