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

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

Class IVlanIdTypeNode

java.lang.Object

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

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

org.eclipse.milo.opcua.sdk.client.model.objects.BaseObjectTypeNode

org.eclipse.milo.opcua.sdk.client.model.objects.BaseInterfaceTypeNode

org.eclipse.milo.opcua.sdk.client.model.objects.IVlanIdTypeNode

All Implemented Interfaces:

BaseInterfaceType, BaseObjectType, IVlanIdType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

public class IVlanIdTypeNode
extends BaseInterfaceTypeNode
implements IVlanIdType

Field Summary

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

client

Constructor Summary

Constructors

Constructor

Description

IVlanIdTypeNode(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.unsigned.UByte eventNotifier)

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	getVlanId()	Get the local value of the VlanId Node.
BaseDataVariableTypeNode	getVlanIdNode()	Get the VlanId BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getVlanIdNodeAsync()	Asynchronous implementation of IVlanIdType.getVlanIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	readVlanId()	Read the value of the VlanId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort>	readVlanIdAsync()	An asynchronous implementation of IVlanIdType.readVlanId().
void	setVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)	Set the local value of the VlanId Node.
void	writeVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)	Write a new value for the VlanId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeVlanIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort vlanId)	An asynchronous implementation of IVlanIdType.writeVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).

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

callMethod, callMethod, callMethodAsync, callMethodAsync, getAttributeValue, getEventNotifier, getIconAsync, getMethod, getMethod, getMethodAsync, getMethodAsync, getNamingRuleAsync, getNodeVersionAsync, getObjectComponent, getObjectComponent, getObjectComponent, getObjectComponentAsync, getObjectComponentAsync, getObjectComponentAsync, getTypeDefinition, getTypeDefinitionAsync, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readEventNotifier, setAttributeValue, setEventNotifier, setIconAsync, setNamingRuleAsync, setNodeVersionAsync, writeEventNotifier

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

getEventNotifier, setEventNotifier

Constructor Details

IVlanIdTypeNode

public IVlanIdTypeNode(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.unsigned.UByte eventNotifier)

Method Details

getVlanId

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getVlanId()
                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: IVlanIdType

Get the local value of the VlanId Node.

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

Specified by:

getVlanId in interface IVlanIdType

Returns:

the local value of the VlanId Node.

Throws:

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

setVlanId

public void setVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: IVlanIdType

Set the local value of the VlanId Node.

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

Specified by:

setVlanId in interface IVlanIdType

Parameters:

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

Throws:

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

readVlanId

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort readVlanId()
                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: IVlanIdType

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

Specified by:

readVlanId in interface IVlanIdType

Returns:

the UShort value read from the server.

Throws:

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

writeVlanId

public void writeVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: IVlanIdType

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

Specified by:

writeVlanId in interface IVlanIdType

Parameters:

value - the UShort value to write to the server.

Throws:

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

readVlanIdAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> readVlanIdAsync()

Description copied from interface: IVlanIdType

An asynchronous implementation of IVlanIdType.readVlanId().

Specified by:

readVlanIdAsync in interface IVlanIdType

Returns:

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

writeVlanIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeVlanIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort vlanId)

Description copied from interface: IVlanIdType

An asynchronous implementation of IVlanIdType.writeVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).

Specified by:

writeVlanIdAsync in interface IVlanIdType

Returns:

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

getVlanIdNode

public BaseDataVariableTypeNode getVlanIdNode()
                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: IVlanIdType

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

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

Specified by:

getVlanIdNode in interface IVlanIdType

Returns:

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

getVlanIdNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getVlanIdNodeAsync()

Description copied from interface: IVlanIdType

Asynchronous implementation of IVlanIdType.getVlanIdNode().

Specified by:

getVlanIdNodeAsync in interface IVlanIdType

Returns:

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