Class UaObjectNode
java.lang.Object
org.eclipse.milo.opcua.sdk.client.nodes.UaNode
org.eclipse.milo.opcua.sdk.client.nodes.UaObjectNode
- All Implemented Interfaces:
org.eclipse.milo.opcua.sdk.core.nodes.Node,org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
- Direct Known Subclasses:
BaseObjectTypeNode
public class UaObjectNode
extends UaNode
implements org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
-
Field Summary
-
Constructor Summary
ConstructorsConstructorDescriptionUaObjectNode(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.builtin.unsigned.UByte eventNotifier) Construct aUaObjectNodeusing only attributes defined prior to OPC UA 1.04.UaObjectNode(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) Construct aUaObjectNodeusing all attributes, including those defined by OPC UA 1.04. -
Method Summary
Modifier and TypeMethodDescriptionorg.eclipse.milo.opcua.stack.core.types.builtin.Variant[]callMethod(String methodName, org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] inputs) Call the method namedmethodNameon this Object, if it exists, usinginputsas the input argument values.org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]callMethod(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName methodName, org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] inputs) Call the method namedmethodNameon this Object, if it exists, usinginputsas the input argument values.CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]>callMethodAsync(String methodName, org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] inputs) Call the method namedmethodNameon this Object, if it exists, usinginputsas the input argument values.CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]>callMethodAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName methodName, org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] inputs) Call the method namedmethodNameon this Object, if it exists, usinginputsas the input argument values.protected org.eclipse.milo.opcua.stack.core.types.builtin.DataValuegetAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId) org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByteCompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString>Get the value of theObjectNodeProperties.IconProperty, if it exists.Get the method namedmethodNameon this Object, if it exists.getMethod(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName methodName) Get the method namedmethodNameon this Object, if it exists.getMethodAsync(String methodName) Get the method namedmethodNameon this Object, if it exists.getMethodAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName methodName) Get the method namedmethodNameon this Object, if it exists.CompletableFuture<org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType>Get the value of theObjectNodeProperties.NamingRuleProperty, if it exists.Get the value of theObjectNodeProperties.NodeVersionProperty, if it exists.getObjectComponent(String name) Get theUaObjectNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.getObjectComponent(String namespaceUri, String name) Get theUaObjectNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.getObjectComponent(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName) Get theUaObjectNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.CompletableFuture<? extends UaObjectNode>CompletableFuture<? extends UaObjectNode>getObjectComponentAsync(String namespaceUri, String name) CompletableFuture<? extends UaObjectNode>getObjectComponentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName) CompletableFuture<? extends UaObjectTypeNode>getVariableComponent(String name) Get theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.getVariableComponent(String namespaceUri, String name) Get theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.getVariableComponent(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName) Get theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.CompletableFuture<? extends UaVariableNode>CompletableFuture<? extends UaVariableNode>getVariableComponentAsync(String namespaceUri, String name) CompletableFuture<? extends UaVariableNode>getVariableComponentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName) org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByteRead the EventNotifier attribute for this Node from the server and update the local attribute if the operation succeeds.protected voidsetAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value) voidsetEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier) CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>setIconAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString icon) Set the value of theObjectNodeProperties.IconProperty, if it exists.CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>setNamingRuleAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType namingRule) Set the value of theObjectNodeProperties.NamingRuleProperty, if it exists.CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>setNodeVersionAsync(String nodeVersion) Set the value of theObjectNodeProperties.NodeVersionProperty, if it exists.voidwriteEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier) Write a new EventNotifier attribute for this Node to the server and update the local attribute if the operation succeeds.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, writeWriteMaskMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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
-
Constructor Details
-
UaObjectNode
public UaObjectNode(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.builtin.unsigned.UByte eventNotifier) Construct aUaObjectNodeusing only attributes defined prior to OPC UA 1.04. -
UaObjectNode
public UaObjectNode(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) Construct aUaObjectNodeusing all attributes, including those defined by OPC UA 1.04.
-
-
Method Details
-
getEventNotifier
public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte getEventNotifier()The returned attribute is the most recently seen value; it is not read live from the server.
- Specified by:
getEventNotifierin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.ObjectNode- See Also:
-
setEventNotifier
public void setEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier) The attribute is only updated locally; it is not written to the server.
- Specified by:
setEventNotifierin interfaceorg.eclipse.milo.opcua.sdk.core.nodes.ObjectNode- See Also:
-
readEventNotifier
public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte readEventNotifier() throws org.eclipse.milo.opcua.stack.core.UaExceptionRead the EventNotifier attribute for this Node from the server and update the local attribute if the operation succeeds.- Returns:
- the
UByteread from the server. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.s
-
writeEventNotifier
public void writeEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier) throws org.eclipse.milo.opcua.stack.core.UaException Write a new EventNotifier attribute for this Node to the server and update the local attribute if the operation succeeds.- Parameters:
eventNotifier- theUByteto write to the server.- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if a service- or operation-level error occurs.
-
callMethod
public org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] callMethod(String methodName, org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] inputs) throws org.eclipse.milo.opcua.stack.core.UaException Call the method namedmethodNameon this Object, if it exists, usinginputsas the input argument values.- Parameters:
methodName- the name of the method to call.inputs- the input argument values.- Returns:
- the method's output argument values if the call was successful.
- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an operation- or service-level error occurs or if a method namedmethodNamecould not be found.
-
callMethod
public org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] callMethod(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName methodName, org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] inputs) throws org.eclipse.milo.opcua.stack.core.UaException Call the method namedmethodNameon this Object, if it exists, usinginputsas the input argument values.- Parameters:
methodName- the name of the method to call.inputs- the input argument values.- Returns:
- the method's output argument values if the call was successful.
- Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an operation- or service-level error occurs or if a method namedmethodNamecould not be found.
-
callMethodAsync
public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]> callMethodAsync(String methodName, org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] inputs) Call the method namedmethodNameon this Object, if it exists, usinginputsas the input argument values.This call completes asynchronously.
- Parameters:
methodName- the name of the method to call.inputs- the input argument values.- Returns:
- a
CompletableFuturethat completes successfully with the method's output argument values if the call was successful, or completes exceptionally if an operation- or service-level error occurs or if a method namedmethodNamecould not be found.
-
callMethodAsync
public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]> callMethodAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName methodName, org.eclipse.milo.opcua.stack.core.types.builtin.Variant[] inputs) Call the method namedmethodNameon this Object, if it exists, usinginputsas the input argument values.This call completes asynchronously.
- Parameters:
methodName- the name of the method to call.inputs- the input argument values.- Returns:
- a
CompletableFuturethat completes successfully with the method's output argument values if the call was successful, or completes exceptionally if an operation- or service-level error occurs or if a method namedmethodNamecould not be found.
-
getMethod
Get the method namedmethodNameon this Object, if it exists.- Parameters:
methodName- the name of the method.- Returns:
- a
UaMethodfor the method namedmethodName. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an operation- or service-level error occurs or a method namedmethodNamecould not be found.
-
getMethod
public UaMethod getMethod(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName methodName) throws org.eclipse.milo.opcua.stack.core.UaException Get the method namedmethodNameon this Object, if it exists.- Parameters:
methodName- the name of the method.- Returns:
- a
UaMethodfor the method namedmethodName. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if an operation- or service-level error occurs or a method namedmethodNamecould not be found.
-
getMethodAsync
Get the method namedmethodNameon this Object, if it exists.This call completes asynchronously.
- Parameters:
methodName- the name of the method.- Returns:
- a
CompletableFuturethat completes successfully with aUaMethodor completes exceptionally if an operation- or service-level error occurs or if a method namedmethodNamecould not be found.
-
getMethodAsync
public CompletableFuture<UaMethod> getMethodAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName methodName) Get the method namedmethodNameon this Object, if it exists.This call completes asynchronously.
- Parameters:
methodName- the name of the method.- Returns:
- a
CompletableFuturethat completes successfully with aUaMethodor completes exceptionally if an operation- or service-level error occurs or if a method namedmethodNamecould not be found.
-
getObjectComponent
public UaObjectNode getObjectComponent(String name) throws org.eclipse.milo.opcua.stack.core.UaException Get theUaObjectNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.- Parameters:
name- the browse name of theUaObjectNodecomponent.- Returns:
- the
UaObjectNodecomponent, if it exists. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if the node could not be found or an operation- or service-level error occurs.
-
getObjectComponent
public UaObjectNode getObjectComponent(String namespaceUri, String name) throws org.eclipse.milo.opcua.stack.core.UaException Get theUaObjectNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.- Parameters:
namespaceUri- the namespace URI the browse name belongs to.name- the browse name of theUaObjectNodecomponent.- Returns:
- the
UaObjectNodecomponent, if it exists. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if the node could not be found or an operation- or service-level error occurs.
-
getObjectComponent
public UaObjectNode getObjectComponent(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName) throws org.eclipse.milo.opcua.stack.core.UaException Get theUaObjectNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.- Parameters:
browseName- the browse name of theUaObjectNodecomponent.- Returns:
- the
UaObjectNodecomponent, if it exists. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if the node could not be found or an operation- or service-level error occurs.
-
getObjectComponentAsync
-
getObjectComponentAsync
public CompletableFuture<? extends UaObjectNode> getObjectComponentAsync(String namespaceUri, String name) -
getObjectComponentAsync
public CompletableFuture<? extends UaObjectNode> getObjectComponentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName) -
getVariableComponent
public UaVariableNode getVariableComponent(String name) throws org.eclipse.milo.opcua.stack.core.UaException Get theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.- Parameters:
name- the browse name of theUaVariableNodecomponent.- Returns:
- the
UaVariableNodecomponent, if it exists. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if the node could not be found or an operation- or service-level error occurs.
-
getVariableComponent
public UaVariableNode getVariableComponent(String namespaceUri, String name) throws org.eclipse.milo.opcua.stack.core.UaException Get theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.- Parameters:
namespaceUri- the namespace URI the browse name belongs to.name- the browse name of theUaVariableNodecomponent.- Returns:
- the
UaVariableNodecomponent, if it exists. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if the node could not be found or an operation- or service-level error occurs.
-
getVariableComponent
public UaVariableNode getVariableComponent(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName) throws org.eclipse.milo.opcua.stack.core.UaException Get theUaVariableNodereferenced by a HasComponent reference type with a browse name ofname, if it exists.- Parameters:
browseName- the browse name of theUaVariableNodecomponent.- Returns:
- the
UaVariableNodecomponent, if it exists. - Throws:
org.eclipse.milo.opcua.stack.core.UaException- if the node could not be found or an operation- or service-level error occurs.
-
getVariableComponentAsync
-
getVariableComponentAsync
public CompletableFuture<? extends UaVariableNode> getVariableComponentAsync(String namespaceUri, String name) -
getVariableComponentAsync
public CompletableFuture<? extends UaVariableNode> getVariableComponentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName) -
getTypeDefinition
- Throws:
org.eclipse.milo.opcua.stack.core.UaException
-
getTypeDefinitionAsync
-
getNodeVersionAsync
Get the value of theObjectNodeProperties.NodeVersionProperty, if it exists.- Returns:
- the value of the NodeVersion Property, if it exists.
- See Also:
-
ObjectNodeProperties
-
getIconAsync
Get the value of theObjectNodeProperties.IconProperty, if it exists.- Returns:
- the value of the Icon Property, if it exists.
- See Also:
-
ObjectNodeProperties
-
getNamingRuleAsync
public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType> getNamingRuleAsync()Get the value of theObjectNodeProperties.NamingRuleProperty, if it exists.- Returns:
- the value of the NamingRule Property, if it exists.
- See Also:
-
ObjectNodeProperties
-
setNodeVersionAsync
public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> setNodeVersionAsync(String nodeVersion) Set the value of theObjectNodeProperties.NodeVersionProperty, if it exists.- Parameters:
nodeVersion- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof the write operation. - See Also:
-
ObjectNodeProperties
-
setIconAsync
public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> setIconAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString icon) Set the value of theObjectNodeProperties.IconProperty, if it exists.- Parameters:
icon- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof the write operation. - See Also:
-
ObjectNodeProperties
-
setNamingRuleAsync
public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> setNamingRuleAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.NamingRuleType namingRule) Set the value of theObjectNodeProperties.NamingRuleProperty, if it exists.- Parameters:
namingRule- the value to set.- Returns:
- a
CompletableFuturethat completes with theStatusCodeof the write operation. - See Also:
-
ObjectNodeProperties
-
getAttributeValue
protected org.eclipse.milo.opcua.stack.core.types.builtin.DataValue getAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId) - Overrides:
getAttributeValuein classUaNode
-
setAttributeValue
protected void setAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value) - Overrides:
setAttributeValuein classUaNode
-