com.prosysopc.ua.client.nodes

Class UaObjectImpl

java.lang.Object

com.prosysopc.ua.nodes.AbstractUaNode

com.prosysopc.ua.client.nodes.UaNodeImpl

com.prosysopc.ua.client.nodes.UaInstanceImpl

com.prosysopc.ua.client.nodes.UaObjectImpl

All Implemented Interfaces:

UaInstance, UaNode, UaObject

Direct Known Subclasses:

BaseObjectTypeImpl

public class UaObjectImpl
extends UaInstanceImpl
implements UaObject

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.client.nodes.UaNodeImpl

addressSpace, references, supportedAttributesMap

Constructor Summary

Constructors

Modifier	Constructor and Description
	UaObjectImpl(AddressSpace addressSpace, NodeId nodeId, NodeClass nodeClass, QualifiedName browseName, LocalizedText displayName, LocalizedText description, AttributeWriteMask writeMask, AttributeWriteMask userWriteMask, UaClientReference[] references, UaProperty[] properties, EventNotifierType eventNotifier)
	UaObjectImpl(AddressSpace addressSpace, NodeId nodeId, QualifiedName browseName, LocalizedText displayName) Create a new object node
	UaObjectImpl(AddressSpace addressSpace, NodeId nodeId, String name, Locale locale) Create a new object node with name.
protected	UaObjectImpl(UaNode.Parameters parameters)

Method Summary

Modifier and Type	Method and Description
UaReference	addComponent(UaNode node) Adds a new component to the Object.
protected <T> T	call(NodeId methodId, MethodArgumentTransformer<T> outputTransformer, Object... inputArgs) Helper method for generated code.
Variant[]	call(NodeId methodId, Object... args) Call a method for this object in the server.
Variant[]	call(NodeId methodId, Variant[] variantArgs) Call a method for this object in the server.
protected <T> AsyncResult<T>	callAsync(NodeId methodId, MethodArgumentTransformer<T> outputTransformer, Object... inputArgs) Helper method for generated code.
AsyncResult<Object[]>	callAsync(NodeId nodeId, Object... inputArgs) Call a method on the object asynchronously.
AsyncResult<Object[]>	callAsync(NodeId methodId, Variant[] variantArgs) Call a method for this object in the server.
Object[]	callMethod(NodeId methodId, Object... inputArgs) Call a method on the object.
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)
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	setAttributes(ObjectAttributes objectAttributes)
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.client.nodes.UaInstanceImpl

getTypeDefinition, getTypeDefinitionId, setTypeDefinition, setTypeDefinitionId, setTypeDefinitionId

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

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.UaInstance

getTypeDefinition, getTypeDefinitionId, setTypeDefinition, setTypeDefinitionId, setTypeDefinitionId

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

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

UaObjectImpl

public UaObjectImpl(AddressSpace addressSpace,
                    NodeId nodeId,
                    NodeClass nodeClass,
                    QualifiedName browseName,
                    LocalizedText displayName,
                    LocalizedText description,
                    AttributeWriteMask writeMask,
                    AttributeWriteMask userWriteMask,
                    UaClientReference[] references,
                    UaProperty[] properties,
                    EventNotifierType eventNotifier)

UaObjectImpl

public UaObjectImpl(AddressSpace addressSpace,
                    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

UaObjectImpl

public UaObjectImpl(AddressSpace addressSpace,
                    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

UaObjectImpl

protected UaObjectImpl(UaNode.Parameters parameters)

Method Detail

addComponent

public UaReference addComponent(UaNode node)
                         throws IllegalArgumentException

Adds a new component to the Object. Creates a new HasComponent reference with target set to the node. The node must be a data variable, object or method.

Specified by:

addComponent in interface UaNode

Overrides:

addComponent in class UaNodeImpl

Parameters:

node - the component node

Returns:

the HasComponent reference that was added (or existed already)

Throws:

IllegalArgumentException - if the node is not of the correct class (see above)

See Also:

UaNode.addReference(UaNode, NodeId, boolean)

call

public Variant[] call(NodeId methodId,
                      Object... args)
               throws MethodCallStatusException,
                      ServiceException

Call a method for this object in the server.

This is a shortcut to UaClient.call(NodeId, NodeId, Variant...).

Parameters:

methodId - the method to call

args - values for the method input arguments: they will be converted to variants before making the call.

Returns:

the output arguments if the method call succeeds

Throws:

ServiceException - if the call fails due to connection problems, etc.

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

call

public Variant[] call(NodeId methodId,
                      Variant[] variantArgs)
               throws ServiceException,
                      MethodCallStatusException

Call a method for this object in the server.

This is a shortcut to UaClient.call(NodeId, NodeId, Variant...).

Parameters:

methodId - the method to call

variantArgs - values for the method input arguments

Returns:

the output arguments if the method call succeeds

Throws:

ServiceException - if the call fails due to connection problems, etc.

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

callAsync

public AsyncResult<Object[]> callAsync(NodeId nodeId,
                                       Object... inputArgs)

Call a method on the object asynchronously.

Parameters:

methodId - id of the method

inputArgs - input arguments for the method call

Returns:

AsyncResult, which can be monitored for the return of the call. The response is provided as and Object array, which contains the Variant values returned by the server to objects that can be used directly. If the method call fails, the error contains the respective ServiceResultException.

callAsync

public AsyncResult<Object[]> callAsync(NodeId methodId,
                                       Variant[] variantArgs)

Call a method for this object in the server.

This is a shortcut to UaClient.call(NodeId, NodeId, Variant...).

Parameters:

methodId - the method to call

variantArgs - values for the method input arguments

Returns:

AsyncResult, which can be monitored for the return of the call. The response is provided as and Object array, which contains the Variant values returned by the server to objects that can be used directly. If the method call fails, the error contains the respective ServiceResultException.

callMethod

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

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:

ServiceException - if the call fails due to connection problems, etc.

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

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

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 UaNodeImpl

Returns:

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

setAttributes

public void setAttributes(ObjectAttributes objectAttributes)

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 UaInstanceImpl

call

protected <T> T call(NodeId methodId,
                     MethodArgumentTransformer<T> outputTransformer,
                     Object... inputArgs)
              throws MethodCallStatusException,
                     ServiceException

Helper method for generated code.

Throws:

MethodCallStatusException

ServiceException

callAsync

protected <T> AsyncResult<T> callAsync(NodeId methodId,
                                       MethodArgumentTransformer<T> outputTransformer,
                                       Object... inputArgs)

Helper method for generated code.

getAttributes

protected NodeAttributes getAttributes(ObjectAttributes 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