com.digitalpetri.opcua.sdk.core.nodes

Interface Node

All Known Subinterfaces:

DataTypeNode, MethodNode, ObjectNode, ObjectTypeNode, ReferenceTypeNode, VariableNode, VariableTypeNode, ViewNode

All Known Implementing Classes:

AddressSpaceFileNode, AggregateConfigurationNode, AggregateFunctionNode, AnalogItemNode, ArrayItemNode, BaseConditionClassNode, BaseDataVariableNode, BaseObjectNode, BaseVariableNode, BuildInfoNode, CertificateDirectoryNode, ConditionVariableNode, CubeItemNode, DataItemNode, DataTypeDescriptionNode, DataTypeDictionaryNode, DataTypeEncodingNode, DataTypeSystemNode, DerivedVariableNode, DirectoryNode, DiscreteItemNode, ExclusiveLimitStateMachineNode, FileNode, FiniteStateMachineNode, FiniteStateVariableNode, FiniteTransitionVariableNode, FolderNode, HistoricalDataConfigurationNode, HistoryServerCapabilitiesNode, ImageItemNode, InitialStateNode, LockNode, MaintenanceConditionClassNode, ModellingRuleNode, MultiStateDiscreteNode, MultiStateValueDiscreteNode, NamespaceArrayNode, NamespaceMetadataNode, NamespacesNode, NDimensionArrayItemNode, NonTransparentNetworkRedundancyNode, NonTransparentRedundancyNode, OperationLimitsNode, OptionSetNode, ProcessConditionClassNode, ProgramDiagnosticNode, ProgramStateMachineNode, PropertyNode, SamplingIntervalDiagnosticsArrayNode, SamplingIntervalDiagnosticsNode, ServerArrayNode, ServerCapabilitiesNode, ServerConfigurationNode, ServerDiagnosticsNode, ServerDiagnosticsSummaryNode, ServerNode, ServerRedundancyNode, ServerStatusNode, ServerVendorCapabilityNode, SessionDiagnosticsArrayNode, SessionDiagnosticsObjectNode, SessionDiagnosticsVariableNode, SessionsDiagnosticsSummaryNode, SessionSecurityDiagnosticsArrayNode, SessionSecurityDiagnosticsNode, ShelvedStateMachineNode, StateMachineNode, StateNode, StateVariableNode, SubscriptionDiagnosticsArrayNode, SubscriptionDiagnosticsNode, SystemConditionClassNode, TransitionNode, TransitionVariableNode, TransparentRedundancyNode, TrustListNode, TwoStateDiscreteNode, TwoStateVariableNode, UaDataTypeNode, UaFolderNode, UaMethodNode, UaNode, UaObjectNode, UaObjectTypeNode, UaPropertyNode, UaReferenceTypeNode, UaVariableNode, UaVariableTypeNode, UaViewNode, VendorServerInfoNode, XYArrayItemNode, YArrayItemNode

public interface Node

Method Summary

Modifier and Type	Method and Description
com.digitalpetri.opcua.stack.core.types.builtin.QualifiedName	getBrowseName() See OPC-UA Part 3, section 5.2.4.
Optional<com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText>	getDescription() See OPC-UA Part 3, section 5.2.6.
com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText	getDisplayName() See OPC-UA Part 3, section 5.2.5.
com.digitalpetri.opcua.stack.core.types.enumerated.NodeClass	getNodeClass() See OPC-UA Part 3, section 5.2.3.
com.digitalpetri.opcua.stack.core.types.builtin.NodeId	getNodeId() See OPC-UA Part 3, section 5.2.2.
Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger>	getUserWriteMask() See OPC-UA Part 3, section 5.2.8.
Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger>	getWriteMask() See OPC-UA Part 3, section 5.2.7.
default boolean	hasAttribute(int attributeId)
default boolean	hasAttribute(com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger attributeId)
default com.digitalpetri.opcua.stack.core.types.builtin.DataValue	readAttribute(com.digitalpetri.opcua.stack.core.AttributeId attributeId) Read the specified attribute.
default com.digitalpetri.opcua.stack.core.types.builtin.DataValue	readAttribute(com.digitalpetri.opcua.stack.core.AttributeId attributeId, com.digitalpetri.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps, String indexRange) Read the specified attribute, applying timestamps and indexRange if specified.
default com.digitalpetri.opcua.stack.core.types.builtin.DataValue	readAttribute(int attribute) Read the specified attribute.
default com.digitalpetri.opcua.stack.core.types.builtin.DataValue	readAttribute(int attribute, com.digitalpetri.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps, String indexRange) Read the specified attribute.
default com.digitalpetri.opcua.stack.core.types.builtin.DataValue	readAttribute(com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger attribute) Read the specified attribute.
void	setBrowseName(com.digitalpetri.opcua.stack.core.types.builtin.QualifiedName browseName) Set the BrowseName attribute of this Node.
void	setDescription(Optional<com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText> description) Set the Description attribute of this Node.
void	setDisplayName(com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText displayName) Set the DisplayName attribute of this Node.
void	setNodeClass(com.digitalpetri.opcua.stack.core.types.enumerated.NodeClass nodeClass) Set the NodeClass attribute of this Node.
void	setNodeId(com.digitalpetri.opcua.stack.core.types.builtin.NodeId nodeId) Set the NodeId attribute of this Node.
void	setUserWriteMask(Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger> userWriteMask) Set the UserWriteMask attribute of this Node.
void	setWriteMask(Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger> writeMask) Set the WriteMask attribute of this Node.
default void	writeAttribute(NamespaceManager ns, com.digitalpetri.opcua.stack.core.AttributeId attributeId, com.digitalpetri.opcua.stack.core.types.builtin.DataValue value, String indexRange) Write to the specified attribute.
default void	writeAttribute(NamespaceManager ns, int attribute, com.digitalpetri.opcua.stack.core.types.builtin.DataValue value, String indexRange) Write to the specified attribute.
default void	writeAttribute(NamespaceManager ns, com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger attribute, com.digitalpetri.opcua.stack.core.types.builtin.DataValue value, String indexRange) Write to the specified attribute.

Method Detail

getNodeId

com.digitalpetri.opcua.stack.core.types.builtin.NodeId getNodeId()

See OPC-UA Part 3, section 5.2.2.

Returns:

the NodeId (NodeId) of this node.

getNodeClass

com.digitalpetri.opcua.stack.core.types.enumerated.NodeClass getNodeClass()

See OPC-UA Part 3, section 5.2.3.

Returns:

the NodeClass (NodeClass) of this node.

getBrowseName

com.digitalpetri.opcua.stack.core.types.builtin.QualifiedName getBrowseName()

See OPC-UA Part 3, section 5.2.4.

Returns:

the BrowseName (QualifiedName) of this node.

getDisplayName

com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText getDisplayName()

See OPC-UA Part 3, section 5.2.5.

Returns:

the DisplayName (QualifiedName) of this node.

getDescription

Optional<com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText> getDescription()

See OPC-UA Part 3, section 5.2.6.

Returns:

if this attribute is present, the Description (LocalizedText).

getWriteMask

Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger> getWriteMask()

See OPC-UA Part 3, section 5.2.7.

Returns:

if this attribute is present, the WriteMask (UInteger).

getUserWriteMask

Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger> getUserWriteMask()

See OPC-UA Part 3, section 5.2.8.

Returns:

if this attribute is present, the UserWriteMask (UInteger).

setNodeId

void setNodeId(com.digitalpetri.opcua.stack.core.types.builtin.NodeId nodeId)

Set the NodeId attribute of this Node.

Parameters:

nodeId - the NodeId to set.

setNodeClass

void setNodeClass(com.digitalpetri.opcua.stack.core.types.enumerated.NodeClass nodeClass)

Set the NodeClass attribute of this Node.

Parameters:

nodeClass - the NodeClass to set.

setBrowseName

void setBrowseName(com.digitalpetri.opcua.stack.core.types.builtin.QualifiedName browseName)

Set the BrowseName attribute of this Node.

Parameters:

browseName - the BrowseName to set.

setDisplayName

void setDisplayName(com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText displayName)

Set the DisplayName attribute of this Node.

Parameters:

displayName - the DisplayName to set.

setDescription

void setDescription(Optional<com.digitalpetri.opcua.stack.core.types.builtin.LocalizedText> description)

Set the Description attribute of this Node.

Parameters:

description - the Description to set.

setWriteMask

void setWriteMask(Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger> writeMask)

Set the WriteMask attribute of this Node.

Parameters:

writeMask - the WriteMask to set.

setUserWriteMask

void setUserWriteMask(Optional<com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger> userWriteMask)

Set the UserWriteMask attribute of this Node.

Parameters:

userWriteMask - the UserWriteMask to set.

hasAttribute

default boolean hasAttribute(int attributeId)

Parameters:

attributeId - the id of the attribute in question.

Returns:

true if this Node has the attribute identified by attributeId.

hasAttribute

default boolean hasAttribute(com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger attributeId)

Parameters:

attributeId - the id of the attribute in question.

Returns:

true if this Node has the attribute identified by attributeId.

readAttribute

default com.digitalpetri.opcua.stack.core.types.builtin.DataValue readAttribute(com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger attribute)

Read the specified attribute.

If the attribute is not specified on this node, a value with status StatusCodes.Bad_AttributeIdInvalid will be returned.

Parameters:

attribute - the id of the attribute to read.

Returns:

the value of the specified attribute.

readAttribute

default com.digitalpetri.opcua.stack.core.types.builtin.DataValue readAttribute(int attribute)

Read the specified attribute.

If the attribute is not specified on this node, a value with status StatusCodes.Bad_AttributeIdInvalid will be returned.

Parameters:

attribute - the id of the attribute to read.

Returns:

the value of the specified attribute.

readAttribute

default com.digitalpetri.opcua.stack.core.types.builtin.DataValue readAttribute(int attribute,
                                                                                @Nullable
                                                                                com.digitalpetri.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps,
                                                                                @Nullable
                                                                                String indexRange)

Read the specified attribute.

If the attribute is not specified on this node, a value with status StatusCodes.Bad_AttributeIdInvalid will be returned.

Parameters:

attribute - the id of the attribute to read.

timestamps - the TimestampsToReturn.

indexRange - the index range to read. Must be a parseable by NumericRange.

Returns:

the value of the specified attribute.

readAttribute

default com.digitalpetri.opcua.stack.core.types.builtin.DataValue readAttribute(com.digitalpetri.opcua.stack.core.AttributeId attributeId)

Read the specified attribute.

If the attribute is not specified on this node, a value with status StatusCodes.Bad_AttributeIdInvalid will be returned.

Parameters:

attributeId - the id of the attribute to read.

Returns:

the value of the specified attribute.

readAttribute

default com.digitalpetri.opcua.stack.core.types.builtin.DataValue readAttribute(com.digitalpetri.opcua.stack.core.AttributeId attributeId,
                                                                                @Nullable
                                                                                com.digitalpetri.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps,
                                                                                @Nullable
                                                                                String indexRange)

Read the specified attribute, applying timestamps and indexRange if specified.

If the attribute is not specified on this node, a value with status StatusCodes.Bad_AttributeIdInvalid will be returned.

Parameters:

attributeId - the id of the attribute to read.

timestamps - the TimestampsToReturn.

indexRange - the index range to read. Must be a parseable by NumericRange.

Returns:

the value of the specified attribute.

writeAttribute

default void writeAttribute(NamespaceManager ns,
                            com.digitalpetri.opcua.stack.core.types.builtin.unsigned.UInteger attribute,
                            com.digitalpetri.opcua.stack.core.types.builtin.DataValue value,
                            String indexRange)
                     throws com.digitalpetri.opcua.stack.core.UaException

Write to the specified attribute.

Parameters:

ns - the NamespaceManager.

attribute - the id of the attribute to write.

value - the DataValue write.

indexRange - the index range to write. Must be a parseable by NumericRange.

Throws:

com.digitalpetri.opcua.stack.core.UaException

writeAttribute

default void writeAttribute(NamespaceManager ns,
                            int attribute,
                            com.digitalpetri.opcua.stack.core.types.builtin.DataValue value,
                            String indexRange)
                     throws com.digitalpetri.opcua.stack.core.UaException

Write to the specified attribute.

Parameters:

ns - the NamespaceManager.

attribute - the id of the attribute to write.

value - the DataValue write.

indexRange - the index range to write. Must be a parseable by NumericRange.

Throws:

com.digitalpetri.opcua.stack.core.UaException

writeAttribute

default void writeAttribute(NamespaceManager ns,
                            com.digitalpetri.opcua.stack.core.AttributeId attributeId,
                            com.digitalpetri.opcua.stack.core.types.builtin.DataValue value,
                            String indexRange)
                     throws com.digitalpetri.opcua.stack.core.UaException

Write to the specified attribute.

Parameters:

ns - the NamespaceManager.

attributeId - the AttributeId of the attribute to write.

value - the DataValue write.

indexRange - the index range to write. Must be a parseable by NumericRange.

Throws:

com.digitalpetri.opcua.stack.core.UaException