Package com.plccom.opc.ua.client.application.model.nodes

Class UaNode

java.lang.Object

com.plccom.opc.ua.client.application.model.nodes.UaNode

Direct Known Subclasses:

UaDataTypeNode, UaMethodNode, UaObjectNode, UaReferenceTypeNode, UaVariableNode, UaVariableTypeNode, UaViewNode

public class UaNode
extends Object

PLCcom sdk UANode Implementation for Opc Ua, with the UaNode object you can read or write Attributes or values from cache or directly from connected ua server

Author:

Indi.An GmbH, www.indi-an.com, support@indi-an.com

Constructor Summary

Constructors

Constructor	Description
UaNode(UaClient client, com.plccom.opc.ua.builtintypes.NodeId nodeId)	Standard constructor for a UaNode instances

Method Summary

Modifier and Type	Method	Description
com.plccom.opc.ua.builtintypes.QualifiedName	getBrowseName()	Returns the attribute browse name from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.LocalizedText	getDescription()	returns the attribute description of this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.LocalizedText	getDisplayName()	Returns the attribute display name from cache or directly from connected ua server
com.plccom.opc.ua.core.NodeClass	getNodeClass()	Returns the attribute node class from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.NodeId	getNodeId()	Returns the attribute nodeid from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.UnsignedInteger	getUserWriteMask()	Returns the attribute user write mask of this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.UnsignedInteger	getWriteMask()	Returns the attribute write mask of this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.DataValue	readBrowseName()	Reads the complete datavalue of attribute browsename this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.DataValue	readDescription()	Reads the complete datavalue of attribute description this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.DataValue	readDisplayName()	Reads the complete datavalue of attribute displayname this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.DataValue	readNodeClass()	Reads the complete datavalue of attribute nodeclass this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.DataValue	readNodeId()	Reads the complete datavalue of attribute nodeid this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.DataValue	readUserWriteMask()	Reads the complete datavalue of attribute userwritemask this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.DataValue	readWriteMask()	Reads the complete datavalue of attribute writemask this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.StatusCode	setBrowseName(com.plccom.opc.ua.builtintypes.QualifiedName browseName)	Sets the attribute browsename of this node at connected ua server and refreshing the nodecache
com.plccom.opc.ua.builtintypes.StatusCode	setDescription(com.plccom.opc.ua.builtintypes.LocalizedText description)	Sets the attribute description of this node at connected ua server and refreshing the nodecache
com.plccom.opc.ua.builtintypes.StatusCode	setDisplayName(com.plccom.opc.ua.builtintypes.LocalizedText displayName)	Sets the attribute displayname of this node at connected ua server and refreshing the nodecache
com.plccom.opc.ua.builtintypes.StatusCode	setNodeClass(com.plccom.opc.ua.core.NodeClass nodeClass)	Sets the attribute nodeclass of this node at connected ua server and refreshing the nodecache
com.plccom.opc.ua.builtintypes.StatusCode	setNodeId(com.plccom.opc.ua.builtintypes.NodeId nodeId)	Sets the attribute nodeid of this node at connected ua server and refreshing the nodecache
com.plccom.opc.ua.builtintypes.StatusCode	setUserWriteMask(com.plccom.opc.ua.builtintypes.UnsignedInteger userWriteMask)	Sets the attribute userwritemask of this node at connected ua server and refreshing the nodecache
com.plccom.opc.ua.builtintypes.StatusCode	setWriteMask(com.plccom.opc.ua.builtintypes.UnsignedInteger writeMask)	Sets the attribute writemask of this node at connected ua server and refreshing the nodecache
com.plccom.opc.ua.builtintypes.StatusCode	writeBrowseName(com.plccom.opc.ua.builtintypes.DataValue value)	Writes the browsename attribute
com.plccom.opc.ua.builtintypes.StatusCode	writeDescription(com.plccom.opc.ua.builtintypes.DataValue value)	Writes the description attribute
com.plccom.opc.ua.builtintypes.StatusCode	writeDisplayName(com.plccom.opc.ua.builtintypes.DataValue value)	Writes the displayname attribute
com.plccom.opc.ua.builtintypes.StatusCode	writeNodeClass(com.plccom.opc.ua.builtintypes.DataValue value)	Writes the nodeclass attribute
com.plccom.opc.ua.builtintypes.StatusCode	writeNodeId(com.plccom.opc.ua.builtintypes.DataValue value)	Writes the nodeid attribute
com.plccom.opc.ua.builtintypes.StatusCode	writeUserWriteMask(com.plccom.opc.ua.builtintypes.DataValue value)	Writes the userwritemask attribute
com.plccom.opc.ua.builtintypes.StatusCode	writeWriteMask(com.plccom.opc.ua.builtintypes.DataValue value)	Writes the writemask attribute

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UaNode

public UaNode(UaClient client,
              com.plccom.opc.ua.builtintypes.NodeId nodeId)

Standard constructor for a UaNode instances

Parameters:

client - a client instance

nodeId - the based nodeId

Method Detail

getNodeId

public com.plccom.opc.ua.builtintypes.NodeId getNodeId()
                                                throws com.plccom.opc.ua.common.ServiceFaultException,
                                                       com.plccom.opc.ua.common.ServiceResultException

Returns the attribute nodeid from cache or directly from connected ua server

Returns:

the based nodeid

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

getNodeClass

public com.plccom.opc.ua.core.NodeClass getNodeClass()
                                              throws com.plccom.opc.ua.common.ServiceFaultException,
                                                     com.plccom.opc.ua.common.ServiceResultException

Returns the attribute node class from cache or directly from connected ua server

Returns:

the node class

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

getBrowseName

public com.plccom.opc.ua.builtintypes.QualifiedName getBrowseName()
                                                           throws com.plccom.opc.ua.common.ServiceFaultException,
                                                                  com.plccom.opc.ua.common.ServiceResultException

Returns the attribute browse name from cache or directly from connected ua server

Returns:

the browse name

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

getDisplayName

public com.plccom.opc.ua.builtintypes.LocalizedText getDisplayName()
                                                            throws com.plccom.opc.ua.common.ServiceFaultException,
                                                                   com.plccom.opc.ua.common.ServiceResultException

Returns the attribute display name from cache or directly from connected ua server

Returns:

the display name

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

getDescription

public com.plccom.opc.ua.builtintypes.LocalizedText getDescription()
                                                            throws com.plccom.opc.ua.common.ServiceFaultException,
                                                                   com.plccom.opc.ua.common.ServiceResultException

returns the attribute description of this node from cache or directly from connected ua server

Returns:

the description of this node

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

getWriteMask

public com.plccom.opc.ua.builtintypes.UnsignedInteger getWriteMask()
                                                            throws com.plccom.opc.ua.common.ServiceFaultException,
                                                                   com.plccom.opc.ua.common.ServiceResultException

Returns the attribute write mask of this node from cache or directly from connected ua server

Returns:

the write mask of this node

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

getUserWriteMask

public com.plccom.opc.ua.builtintypes.UnsignedInteger getUserWriteMask()
                                                                throws com.plccom.opc.ua.common.ServiceFaultException,
                                                                       com.plccom.opc.ua.common.ServiceResultException

Returns the attribute user write mask of this node from cache or directly from connected ua server

Returns:

the user write mask of this node

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

setNodeId

public com.plccom.opc.ua.builtintypes.StatusCode setNodeId(com.plccom.opc.ua.builtintypes.NodeId nodeId)
                                                    throws com.plccom.opc.ua.common.ServiceResultException

Sets the attribute nodeid of this node at connected ua server and refreshing the nodecache

Parameters:

nodeId - the nodeId

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

setNodeClass

public com.plccom.opc.ua.builtintypes.StatusCode setNodeClass(com.plccom.opc.ua.core.NodeClass nodeClass)
                                                       throws com.plccom.opc.ua.common.ServiceResultException

Sets the attribute nodeclass of this node at connected ua server and refreshing the nodecache

Parameters:

nodeClass - the node class

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

setBrowseName

public com.plccom.opc.ua.builtintypes.StatusCode setBrowseName(com.plccom.opc.ua.builtintypes.QualifiedName browseName)
                                                        throws com.plccom.opc.ua.common.ServiceResultException

Sets the attribute browsename of this node at connected ua server and refreshing the nodecache

Parameters:

browseName - the browse name

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

setDisplayName

public com.plccom.opc.ua.builtintypes.StatusCode setDisplayName(com.plccom.opc.ua.builtintypes.LocalizedText displayName)
                                                         throws com.plccom.opc.ua.common.ServiceResultException

Sets the attribute displayname of this node at connected ua server and refreshing the nodecache

Parameters:

displayName - the display name

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

setDescription

public com.plccom.opc.ua.builtintypes.StatusCode setDescription(com.plccom.opc.ua.builtintypes.LocalizedText description)
                                                         throws com.plccom.opc.ua.common.ServiceResultException

Sets the attribute description of this node at connected ua server and refreshing the nodecache

Parameters:

description - the description

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

setWriteMask

public com.plccom.opc.ua.builtintypes.StatusCode setWriteMask(com.plccom.opc.ua.builtintypes.UnsignedInteger writeMask)
                                                       throws com.plccom.opc.ua.common.ServiceResultException

Sets the attribute writemask of this node at connected ua server and refreshing the nodecache

Parameters:

writeMask - the write mask

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

setUserWriteMask

public com.plccom.opc.ua.builtintypes.StatusCode setUserWriteMask(com.plccom.opc.ua.builtintypes.UnsignedInteger userWriteMask)
                                                           throws com.plccom.opc.ua.common.ServiceResultException

Sets the attribute userwritemask of this node at connected ua server and refreshing the nodecache

Parameters:

userWriteMask - the user write mask

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

readNodeId

public com.plccom.opc.ua.builtintypes.DataValue readNodeId()
                                                    throws com.plccom.opc.ua.common.ServiceFaultException,
                                                           com.plccom.opc.ua.common.ServiceResultException

Reads the complete datavalue of attribute nodeid this node from cache or directly from connected ua server

Returns:

a datavalue object with the attribute node

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

readNodeClass

public com.plccom.opc.ua.builtintypes.DataValue readNodeClass()
                                                       throws com.plccom.opc.ua.common.ServiceFaultException,
                                                              com.plccom.opc.ua.common.ServiceResultException

Reads the complete datavalue of attribute nodeclass this node from cache or directly from connected ua server

Returns:

a datavalue object with the attribute node

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

readBrowseName

public com.plccom.opc.ua.builtintypes.DataValue readBrowseName()
                                                        throws com.plccom.opc.ua.common.ServiceFaultException,
                                                               com.plccom.opc.ua.common.ServiceResultException

Reads the complete datavalue of attribute browsename this node from cache or directly from connected ua server

Returns:

a datavalue object with the attribute node

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

readDisplayName

public com.plccom.opc.ua.builtintypes.DataValue readDisplayName()
                                                         throws com.plccom.opc.ua.common.ServiceFaultException,
                                                                com.plccom.opc.ua.common.ServiceResultException

Reads the complete datavalue of attribute displayname this node from cache or directly from connected ua server

Returns:

a datavalue object with the attribute node

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

readDescription

public com.plccom.opc.ua.builtintypes.DataValue readDescription()
                                                         throws com.plccom.opc.ua.common.ServiceFaultException,
                                                                com.plccom.opc.ua.common.ServiceResultException

Reads the complete datavalue of attribute description this node from cache or directly from connected ua server

Returns:

a datavalue object with the attribute node

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

readWriteMask

public com.plccom.opc.ua.builtintypes.DataValue readWriteMask()
                                                       throws com.plccom.opc.ua.common.ServiceFaultException,
                                                              com.plccom.opc.ua.common.ServiceResultException

Reads the complete datavalue of attribute writemask this node from cache or directly from connected ua server

Returns:

a datavalue object with the attribute node

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

readUserWriteMask

public com.plccom.opc.ua.builtintypes.DataValue readUserWriteMask()
                                                           throws com.plccom.opc.ua.common.ServiceFaultException,
                                                                  com.plccom.opc.ua.common.ServiceResultException

Reads the complete datavalue of attribute userwritemask this node from cache or directly from connected ua server

Returns:

a datavalue object with the attribute node

Throws:

com.plccom.opc.ua.common.ServiceFaultException - on error while executing the operation

com.plccom.opc.ua.common.ServiceResultException - on communication error

writeNodeId

public com.plccom.opc.ua.builtintypes.StatusCode writeNodeId(com.plccom.opc.ua.builtintypes.DataValue value)
                                                      throws com.plccom.opc.ua.common.ServiceResultException

Writes the nodeid attribute

Parameters:

value - a datavalue object with informations to write

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

writeNodeClass

public com.plccom.opc.ua.builtintypes.StatusCode writeNodeClass(com.plccom.opc.ua.builtintypes.DataValue value)
                                                         throws com.plccom.opc.ua.common.ServiceResultException

Writes the nodeclass attribute

Parameters:

value - a datavalue object with informations to write

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

writeBrowseName

public com.plccom.opc.ua.builtintypes.StatusCode writeBrowseName(com.plccom.opc.ua.builtintypes.DataValue value)
                                                          throws com.plccom.opc.ua.common.ServiceResultException

Writes the browsename attribute

Parameters:

value - a datavalue object with informations to write

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

writeDisplayName

public com.plccom.opc.ua.builtintypes.StatusCode writeDisplayName(com.plccom.opc.ua.builtintypes.DataValue value)
                                                           throws com.plccom.opc.ua.common.ServiceResultException

Writes the displayname attribute

Parameters:

value - a datavalue object with informations to write

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

writeDescription

public com.plccom.opc.ua.builtintypes.StatusCode writeDescription(com.plccom.opc.ua.builtintypes.DataValue value)
                                                           throws com.plccom.opc.ua.common.ServiceResultException

Writes the description attribute

Parameters:

value - a datavalue object with informations to write

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

writeWriteMask

public com.plccom.opc.ua.builtintypes.StatusCode writeWriteMask(com.plccom.opc.ua.builtintypes.DataValue value)
                                                         throws com.plccom.opc.ua.common.ServiceResultException

Writes the writemask attribute

Parameters:

value - a datavalue object with informations to write

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

writeUserWriteMask

public com.plccom.opc.ua.builtintypes.StatusCode writeUserWriteMask(com.plccom.opc.ua.builtintypes.DataValue value)
                                                             throws com.plccom.opc.ua.common.ServiceResultException

Writes the userwritemask attribute

Parameters:

value - a datavalue object with informations to write

Returns:

a StatusCode object with result of actual operation

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error