com.prosysopc.ua.client.nodes

Class UaMethodImpl

java.lang.Object

com.prosysopc.ua.nodes.AbstractUaNode

com.prosysopc.ua.client.nodes.UaNodeImpl

com.prosysopc.ua.client.nodes.UaMethodImpl

All Implemented Interfaces:

UaMethod, UaNode

public class UaMethodImpl
extends UaNodeImpl
implements UaMethod

Straight forward implementation of UaMethod.

It keeps all attributes in memory. Additionally, it manages the

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.nodes.UaNode

UaNode.Parameters

Field Summary

Fields inherited from class com.prosysopc.ua.client.nodes.UaNodeImpl

addressSpace, logger, references, supportedAttributesMap

Fields inherited from interface com.prosysopc.ua.nodes.UaMethod

INPUT_ARGUMENTS, OUTPUT_ARGUMENTS

Constructor Summary

Constructors

Modifier	Constructor and Description
	UaMethodImpl(AddressSpace addressSpace, NodeId nodeId, QualifiedName browseName, LocalizedText displayName)
	UaMethodImpl(AddressSpace addressSpace, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, LocalizedText description, AttributeWriteMask writeMask, AttributeWriteMask userWriteMask, UaClientReference[] references, UaProperty[] properties, Boolean executable, Boolean userExecutable)
	UaMethodImpl(AddressSpace addressSpace, NodeId nodeId, String name, Locale locale)
protected	UaMethodImpl(UaNode.Parameters parameters)

Method Summary

Modifier and Type	Method and Description
NodeAttributes	getAttributes() Returns the current attribute values of the node in a NodeAttributes structure.
protected NodeAttributes	getAttributes(MethodAttributes attributes)
protected void	getAttributesMap(Map<UnsignedInteger,Object> map)
Boolean	getExecutable() The Executable Attribute indicates if the Method is currently executable ('False' means not executable, 'True' means executable).
Argument[]	getInputArguments() The InputArguments Property is used to specify the arguments that shall be used by a client when calling the Method.
NodeClass	getNodeClass() The NodeClass Attribute identifies the NodeClass of a Node.
Argument[]	getOutputArguments() The OutputArguments Property specifies the result returned from the Method call.
Boolean	getUserExecutable() The UserExecutable Attribute indicates if the Method is currently executable taking user access rights into account ('False' means not executable, 'True' means executable).
protected void	initSupportedAttributes(List<UnsignedInteger> l)
protected void	readAttributeValue(UnsignedInteger attributeId, DataValue dataValue) Read the value of an attribute.
void	setAttributes(MethodAttributes methodAttributes)
void	setExecutable(Boolean executable)
void	setUserExecutable(Boolean userExecutable)
String	toString()
protected void	writeAttributeValue(UnsignedInteger attributeId, Object value, StatusCode statusCode, DateTime sourceTime, UnsignedShort sourcePicoseconds)

Methods inherited from class com.prosysopc.ua.client.nodes.UaNodeImpl

addComponent, addProperties, addProperty, addReference, addReference, addReference, addReference, afterAddReference, afterDeleteReference, assertTypeSupport, assertTypeSupport, beforeAddReference, deleteReference, deleteReference, deleteReference, deleteReference, deleteReferences, doAddProperty, equals, findPlaceholders, getAddressSpace, getAttributes, getAttributesMap, getBrowseName, getComponent, getComponents, getDescription, getDescription, getDisplayName, getDisplayName, getMethod, getNodeId, getNodeVersion, getNodeVersionNode, getProperties, getProperty, getPropertyValue, getReference, getReferenceList, getReferences, getSupportedAttributes, getUaNodeId, getUserWriteMask, getWriteMask, hashCode, hasProperty, hasTypeDefinition, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, referenceTypeInherits, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setNodeVersion, setPropertyValue, setReferences, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute

Methods inherited from class com.prosysopc.ua.nodes.AbstractUaNode

getForwardReferences, getInverseReferences, getReferences, getReferences, getReferencesAsList, getUserData, referenceTypeInherits, setUserData

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.prosysopc.ua.nodes.UaNode

addComponent, addOrganizes, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributesMap, getBrowseName, getBrowsePaths, getComponent, getComponents, getDescription, getDisplayName, getForwardReferences, getInverseReferences, getMethod, getNodeId, getNodeVersionNode, getOrganizedNode, getOrganizedNodes, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUaBrowsePaths, getUaNodeId, getUserData, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserData, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute

Constructor Detail

UaMethodImpl

public UaMethodImpl(AddressSpace addressSpace,
                    NodeId nodeId,
                    QualifiedName browseName,
                    LocalizedText displayName)

UaMethodImpl

public UaMethodImpl(AddressSpace addressSpace,
                    NodeId nodeId,
                    QualifiedName browseName,
                    LocalizedText displayName,
                    LocalizedText description,
                    AttributeWriteMask writeMask,
                    AttributeWriteMask userWriteMask,
                    UaClientReference[] references,
                    UaProperty[] properties,
                    Boolean executable,
                    Boolean userExecutable)

UaMethodImpl

public UaMethodImpl(AddressSpace addressSpace,
                    NodeId nodeId,
                    String name,
                    Locale locale)

Parameters:

nodeId -

name -

locale -

UaMethodImpl

protected UaMethodImpl(UaNode.Parameters parameters)

Method Detail

getAttributes

public NodeAttributes getAttributes()

Description copied from interface: UaNode

Returns the current attribute values of the node in a NodeAttributes structure.

Specified by:

getAttributes in interface UaNode

getExecutable

public Boolean getExecutable()

Description copied from interface: UaMethod

The Executable Attribute indicates if the Method is currently executable ('False' means not executable, 'True' means executable). The Executable Attribute does not take any user access rights into account, i.e. although the Method is executable this may be restricted to a certain user / user group.

Specified by:

getExecutable in interface UaMethod

Returns:

the current value of executable.

getInputArguments

public Argument[] getInputArguments()
                             throws MethodArgumentException

Description copied from interface: UaMethod

The InputArguments Property is used to specify the arguments that shall be used by a client when calling the Method.

Specified by:

getInputArguments in interface UaMethod

Returns:

the InputArguments of the method. Should provide an empty list, if no arguments are defined.

Throws:

MethodArgumentException - if the property does not contain valid argument values

getNodeClass

public final NodeClass getNodeClass()

Description copied from interface: UaNode

The NodeClass Attribute identifies the NodeClass of a Node.

Specified by:

getNodeClass in interface UaNode

Overrides:

getNodeClass in class UaNodeImpl

Returns:

the Node Class of the node. This is hard-coded and cannot be changed.

getOutputArguments

public Argument[] getOutputArguments()
                              throws MethodArgumentException

Description copied from interface: UaMethod

The OutputArguments Property specifies the result returned from the Method call.

Specified by:

getOutputArguments in interface UaMethod

Returns:

the OutputArguments of the method. Should provide an empty list, if no arguments are defined.

Throws:

MethodArgumentException - if the property does not contain valid argument values

getUserExecutable

public Boolean getUserExecutable()

Description copied from interface: UaMethod

The UserExecutable Attribute indicates if the Method is currently executable taking user access rights into account ('False' means not executable, 'True' means executable).

Specified by:

getUserExecutable in interface UaMethod

Returns:

the current value of user executable.

setAttributes

public void setAttributes(MethodAttributes methodAttributes)

setExecutable

public void setExecutable(Boolean executable)

Specified by:

setExecutable in interface UaMethod

Parameters:

executable - value to set for executable

See Also:

UaMethod.getExecutable()

setUserExecutable

public void setUserExecutable(Boolean userExecutable)

Specified by:

setUserExecutable in interface UaMethod

Parameters:

userExecutable - value to set for user executable

See Also:

UaMethod.getUserExecutable()

toString

public String toString()

Overrides:

toString in class UaNodeImpl

getAttributes

protected NodeAttributes getAttributes(MethodAttributes attributes)

getAttributesMap

protected void getAttributesMap(Map<UnsignedInteger,Object> map)

Overrides:

getAttributesMap in class UaNodeImpl

initSupportedAttributes

protected void initSupportedAttributes(List<UnsignedInteger> l)

Overrides:

initSupportedAttributes in class UaNodeImpl

readAttributeValue

protected void readAttributeValue(UnsignedInteger attributeId,
                                  DataValue dataValue)
                           throws StatusException

Description copied from class: UaNodeImpl

Read the value of an attribute.

Overrides:

readAttributeValue in class UaNodeImpl

Parameters:

attributeId - the ID of the attribute to read.

dataValue - the DataValue structure in which the value is set.

Throws:

StatusException - on failure

writeAttributeValue

protected void writeAttributeValue(UnsignedInteger attributeId,
                                   Object value,
                                   StatusCode statusCode,
                                   DateTime sourceTime,
                                   UnsignedShort sourcePicoseconds)
                            throws StatusException

Overrides:

writeAttributeValue in class UaNodeImpl

Throws:

StatusException