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

Class UaMethodNode

java.lang.Object

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

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

public class UaMethodNode
extends UaNode

PLCcom sdk UaMethodNode Implementation for Opc Ua, with the UaMethodNode 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
UaMethodNode(UaClient client, com.plccom.opc.ua.builtintypes.NodeId nodeId)	Standard constructor for a UaMethodNode instances

Method Summary

Modifier and Type	Method	Description
Boolean	getExecutable()	Returns the attribute executable from cache or directly from connected ua server
Boolean	getUserExecutable()	Returns the attribute UserExecutable from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.DataValue	readExecutable()	Reads the complete datavalue of attribute Executable this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.DataValue	readUserExecutable()	Reads the complete datavalue of attribute UserExecutable this node from cache or directly from connected ua server
com.plccom.opc.ua.builtintypes.StatusCode	setExecutable(boolean executable)	Sets the attribute executable of this node at connected ua server and refreshing the nodecache
com.plccom.opc.ua.builtintypes.StatusCode	setUserExecutable(boolean userExecutable)	Sets the attribute nodeclass of this node at connected ua server and refreshing the nodecache
com.plccom.opc.ua.builtintypes.StatusCode	writeExecutable(com.plccom.opc.ua.builtintypes.DataValue value)	Writes the Executable attribute
com.plccom.opc.ua.builtintypes.StatusCode	writeUserExecutable(com.plccom.opc.ua.builtintypes.DataValue value)	Writes the UserExecutable attribute

Methods inherited from class com.plccom.opc.ua.client.application.model.nodes.UaNode

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, readBrowseName, readDescription, readDisplayName, readNodeClass, readNodeId, readUserWriteMask, readWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeUserWriteMask, writeWriteMask

Methods inherited from class java.lang.Object

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

Constructor Detail

UaMethodNode

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

Standard constructor for a UaMethodNode instances

Parameters:

client - a client instance

nodeId - the based nodeId

Method Detail

getExecutable

public Boolean getExecutable()
                      throws com.plccom.opc.ua.common.ServiceFaultException,
                             com.plccom.opc.ua.common.ServiceResultException

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

Returns:

the executable attribute

Throws:

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

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

getUserExecutable

public Boolean getUserExecutable()
                          throws com.plccom.opc.ua.common.ServiceFaultException,
                                 com.plccom.opc.ua.common.ServiceResultException

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

Returns:

the UserExecutable attribute

Throws:

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

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

setExecutable

public com.plccom.opc.ua.builtintypes.StatusCode setExecutable(boolean executable)
                                                        throws com.plccom.opc.ua.common.ServiceResultException

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

Parameters:

executable - the executable attribute

Returns:

a StatusCode object with result of actual operation

Throws:

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

setUserExecutable

public com.plccom.opc.ua.builtintypes.StatusCode setUserExecutable(boolean userExecutable)
                                                            throws com.plccom.opc.ua.common.ServiceResultException

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

Parameters:

userExecutable - the userExecutable attribute

Returns:

a StatusCode object with result of actual operation

Throws:

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

readExecutable

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

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

Returns:

a datavalue object with the attribute Executable

Throws:

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

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

readUserExecutable

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

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

Returns:

a datavalue object with the attribute UserExecutable

Throws:

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

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

writeExecutable

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

Writes the Executable 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

writeUserExecutable

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

Writes the UserExecutable 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