com.prosysopc.ua.server.nodes

Class UaObjectNode

java.lang.Object

com.prosysopc.ua.nodes.AbstractUaNode

com.prosysopc.ua.server.nodes.ServerNode

com.prosysopc.ua.server.nodes.BaseNode

com.prosysopc.ua.server.nodes.UaInstanceNode

com.prosysopc.ua.server.nodes.UaObjectNode

All Implemented Interfaces:

UaInstance, UaNode, UaObject, UaCallable

Direct Known Subclasses:

AbstractGeneratedObjectNode

public class UaObjectNode
extends UaInstanceNode
implements UaObject, UaCallable

Straight forward implementation of UaObject.

It keeps all attributes in memory.

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.server.nodes.BaseNode

NODE_VERSION_PROPERTY_NAME, useQuickPropertyLookup

Fields inherited from class com.prosysopc.ua.server.nodes.ServerNode

eventListeners, INITIALIZATION_TIME, nodeManager, supportedAttributesMap

Constructor Summary

Constructors

Modifier	Constructor and Description
	UaObjectNode(NodeManagerUaNode nodeManager, NodeId nodeId, QualifiedName browseName, LocalizedText displayName) Create a new object node
	UaObjectNode(NodeManagerUaNode nodeManager, NodeId nodeId, String name, Locale locale) Create a new object node with name.
protected	UaObjectNode(UaNode.Parameters parameters)

Method Summary

Modifier and Type	Method and Description
void	addCallListener(CallableListener listener)
Object[]	callMethod(NodeId methodId, Object... inputArgs) Call a method on the object.
Variant[]	callMethod(ServiceContext serviceContext, NodeId methodId, Variant[] inputArguments, StatusCode[] inputArgumentResults, DiagnosticInfo[] inputArgumentDiagnosticInfos) Fallback implementation when no subtype handles the method call.
protected void	deleteIfNodeExists(NodeId nodeID)
NodeAttributes	getAttributes() Returns the current attribute values of the node in a NodeAttributes structure.
protected NodeAttributes	getAttributes(ObjectAttributes attributes)
protected void	getAttributesMap(Map<UnsignedInteger,Object> map)
protected ExpandedNodeId	getDefaultTypeDefinition()
EventNotifierType	getEventNotifier() Defines whether the node can be used to subscribe to events.
UaProperty	getIcon() The Icon Property provides an image that can be used by clients when displaying the Node.
NodeClass	getNodeClass() The NodeClass Attribute identifies the NodeClass of a Node.
protected void	initSupportedAttributes(List<UnsignedInteger> l)
protected void	readAttributeValue(UnsignedInteger attributeId, DataValue dataValue) Read the value of an attribute.
void	removeCallListener(CallableListener listener)
void	setAttributes(NodeAttributes nodeAttributes) Sets the attributes of the node.
void	setEventNotifier(EventNotifierType eventNotifier) Define which kind of events the object generates.
void	setIcon(UaProperty icon) Set the value of the Icon property.
String	toString()
protected void	writeAttributeValue(UnsignedInteger attributeId, Object value, StatusCode statusCode, DateTime sourceTime, UnsignedShort sourcePicoseconds)

Methods inherited from class com.prosysopc.ua.server.nodes.UaInstanceNode

addModellingRule, beforeAddReference, getTypeDefinition, getTypeDefinitionId, hasTypeDefinition, registerOverridePlainMethod, setTypeDefinition, setTypeDefinitionId, setTypeDefinitionId, supportsTypeDefinitionNode

Methods inherited from class com.prosysopc.ua.server.nodes.BaseNode

addPlainProperty, addPlainVariable, assertTypeSupport, assertTypeSupport, createNodeId, createNodeId, createReflectiveInstanceProperty, createReflectiveInstanceProperty, deleteReference, deleteReference, doAddProperty, getAttributes, getAttributesMap, getBrowseName, getComponent, getComponents, getDescription, getDescription, getDisplayName, getDisplayName, getMethod, getNodeVersion, getNodeVersionNode, getProperties, getProperty, getPropertyReference, getPropertyValue, getReferencesAsList, getStandardBrowseName, getStandardDisplayText, getUserWriteMask, getWriteMask, hasProperty, hasReference, hasUserWriteAccess, hasWriteAccess, incNodeVersion, initNodeVersion, isChildOfType, readAttribute, readAttribute, registerCallbackProperty, registerPlainInstanceProperty, registerPlainInstanceProperty, registerPlainProperty, registerPlainProperty, registerPlainVariable, registerPlainVariable, registerReflectiveInstanceProperty, registerReflectiveInstanceVariable, registerReflectiveProperty, registerReflectiveVariable, removeProperty, setAccessLevelRecursively, setAccessLevelRecursively, setAttribute, setBrowseName, setDescription, setDisplayName, setNodeVersion, setPropertyValue, setUserWriteMask, setWriteMask, writeAttribute

Methods inherited from class com.prosysopc.ua.server.nodes.ServerNode

addComponent, addDataChangeListener, addEventListener, addNewReference, addNewReference, addOrganizes, addProperties, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, afterAddReference, afterDeleteReference, dataChange, deleteReference, deleteReference, deleteReferences, doDeleteReference, equals, findPlaceholders, fireDataChange, fireEvent, fireEventInParents, getAddressSpace, getDefaultBrowseName, getNodeId, getNodeManager, getNodeSetExtensions, getReference, getReferenceList, getReferences, getSupportedAttributes, getTargetNodes, getUaNodeId, hashCode, isAddNotifierReferencesToServerObject, isFalseOrNull, isMandatory, isMonitoredForEvents, isTrueOrNull, isType, referenceTypeInherits, removeComponent, removeDataChangeListener, removeEventListener, setAddNotifierReferencesToServerObject, setNodeSetExtensions, setReferences, supportsAttribute, translateBrowsePathToNodeIds, validateHasEventSourceChain, validateHasEventSourceChain

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

getForwardReferences, getInverseReferences, getReferences, getReferences, 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.UaInstance

getTypeDefinition, getTypeDefinitionId, setTypeDefinition, setTypeDefinitionId, setTypeDefinitionId

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, setBrowseName, setDescription, setDisplayName, setReferences, setUserData, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute

Constructor Detail

UaObjectNode

public UaObjectNode(NodeManagerUaNode nodeManager,
                    NodeId nodeId,
                    QualifiedName browseName,
                    LocalizedText displayName)

Create a new object node

Parameters:

nodeId - The node identifier

browseName - The BrowseName of the node

displayName - The DisplayName of the node

UaObjectNode

public UaObjectNode(NodeManagerUaNode nodeManager,
                    NodeId nodeId,
                    String name,
                    Locale locale)

Create a new object node with name.

Parameters:

nodeId - The node identifier

name - The browse and display name of the object. The NamespaceIndex of the nodeId is also used for the BrowseName.

locale - The locale of the name, used for the DisplayName

UaObjectNode

protected UaObjectNode(UaNode.Parameters parameters)

Method Detail

addCallListener

public void addCallListener(CallableListener listener)

Specified by:

addCallListener in interface UaCallable

callMethod

public Object[] callMethod(NodeId methodId,
                           Object... inputArgs)
                    throws StatusException

Call a method on the object.

Specified by:

callMethod in interface UaObject

Parameters:

methodId - id of the method

inputArgs - input arguments for the method call

Returns:

output arguments for the method call

Throws:

StatusException - if the call fails due to invalid arguments or something like that.

callMethod

public Variant[] callMethod(ServiceContext serviceContext,
                            NodeId methodId,
                            Variant[] inputArguments,
                            StatusCode[] inputArgumentResults,
                            DiagnosticInfo[] inputArgumentDiagnosticInfos)
                     throws StatusException

Fallback implementation when no subtype handles the method call.

Specified by:

callMethod in interface UaCallable

Returns:

Throws:

StatusException

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

Specified by:

getAttributes in class BaseNode

getEventNotifier

public EventNotifierType getEventNotifier()

Description copied from interface: UaObject

Defines whether the node can be used to subscribe to events. The set can contain one or several of the following values.

Value	Description
SubscribeToEvents	Indicates if it can be used to subscribe to Events (0 means cannot be used to subscribe to Events, 1 means can be used to subscribe to Events).
HistoryRead	Indicates if the history of the Events is readable (0 means not readable, 1 means readable).
HistoryWrite	Indicates if the history of the Events is writable (0 means not writable, 1 means writable).

HistoryRead and HistoryWrite also indicate if the history of the Events is available via the OPC UA server.

Specified by:

getEventNotifier in interface UaObject

Returns:

the current value of the EventNotifier attribute

getIcon

public UaProperty getIcon()

Description copied from interface: UaObject

The Icon Property provides an image that can be used by clients when displaying the Node.

Specified by:

getIcon in interface UaObject

Returns:

the Icon property. This is an optional property, so it may be null, if the property is not defined.

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 BaseNode

Returns:

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

removeCallListener

public void removeCallListener(CallableListener listener)

Specified by:

removeCallListener in interface UaCallable

setAttributes

public void setAttributes(NodeAttributes nodeAttributes)

Description copied from interface: UaNode

Sets the attributes of the node.

Specified by:

setAttributes in interface UaNode

Overrides:

setAttributes in class BaseNode

setEventNotifier

public void setEventNotifier(EventNotifierType eventNotifier)

Description copied from interface: UaObject

Define which kind of events the object generates.

Specified by:

setEventNotifier in interface UaObject

Parameters:

eventNotifier - the set of event types that the object generates

setIcon

public void setIcon(UaProperty icon)
             throws StatusException

Description copied from interface: UaObject

Set the value of the Icon property. If the property already exists, the value is copied from the parameter.

Specified by:

setIcon in interface UaObject

Parameters:

icon - the Icon to set

Throws:

StatusException

See Also:

UaObject.getIcon()

toString

public String toString()

Overrides:

toString in class UaInstanceNode

deleteIfNodeExists

protected void deleteIfNodeExists(NodeId nodeID)

getAttributes

protected NodeAttributes getAttributes(ObjectAttributes attributes)

getAttributesMap

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

Overrides:

getAttributesMap in class BaseNode

getDefaultTypeDefinition

protected ExpandedNodeId getDefaultTypeDefinition()

Specified by:

getDefaultTypeDefinition in class UaInstanceNode

Returns:

initSupportedAttributes

protected void initSupportedAttributes(List<UnsignedInteger> l)

Overrides:

initSupportedAttributes in class ServerNode

readAttributeValue

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

Description copied from class: BaseNode

Read the value of an attribute.

Overrides:

readAttributeValue in class BaseNode

Parameters:

attributeId - the ID of the attribute to read.

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

Throws:

StatusException - if the attributeId is not valid for this (base) node implementation.

writeAttributeValue

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

Overrides:

writeAttributeValue in class BaseNode

Throws:

StatusException