com.prosysopc.ua.client.nodes

Class UaViewImpl

java.lang.Object

com.prosysopc.ua.nodes.AbstractUaNode

com.prosysopc.ua.client.nodes.UaNodeImpl

com.prosysopc.ua.client.nodes.UaViewImpl

All Implemented Interfaces:

UaNode, UaView

public class UaViewImpl
extends UaNodeImpl
implements UaView

Straight forward implementation of UaView.

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, logger, references, supportedAttributesMap

Constructor Summary

Constructors

Modifier	Constructor and Description
	UaViewImpl(AddressSpace addressSpace, NodeId nodeId, QualifiedName browseName, LocalizedText displayName)
	UaViewImpl(AddressSpace addressSpace, NodeId nodeId, QualifiedName browseName, LocalizedText displayName, LocalizedText description, AttributeWriteMask writeMask, AttributeWriteMask userWriteMask, UaClientReference[] references, UaProperty[] properties, boolean containsNoLoops, EventNotifierType eventNotifier)
protected	UaViewImpl(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(ViewAttributes attributes)
protected void	getAttributesMap(Map<UnsignedInteger,Object> map)
Boolean	getContainsNoLoops() If set to true this Attribute indicates that following References in the context of the View contains no loops, i.e.
EventNotifierType	getEventNotifier() Defines whether the node can be used to subscribe to events.
NodeClass	getNodeClass() The NodeClass Attribute identifies the NodeClass of a Node.
UaProperty	getViewVersion() The version number for the View.
protected void	initSupportedAttributes(List<UnsignedInteger> l)
protected void	readAttributeValue(UnsignedInteger attributeId, DataValue dataValue) Read the value of an attribute.
void	setAttributes(ViewAttributes viewAttributes)
void	setContainsNoLoops(Boolean containsNoLoops) Set ContainsNoLoops Attribute value for this node.
void	setEventNotifier(EventNotifierType eventNotifier) Set EventNotifier Attribute value for this node.
protected void	setViewVersion(Integer viewVersion) Set the value of the ViewVersion 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.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

UaViewImpl

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

UaViewImpl

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

UaViewImpl

protected UaViewImpl(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

getContainsNoLoops

public Boolean getContainsNoLoops()

Description copied from interface: UaView

If set to true this Attribute indicates that following References in the context of the View contains no loops, i.e. starting from a Node 'A' contained in the View and following the forward References in the context of the View Node 'A' will not be reached again. It does not specify that there is only one path starting from the View Node to reach a Node contained in the View. If set to false this Attribute indicates that following References in the context of the View may lead to loops. (OPC UA Specification, Part 3.)

Specified by:

getContainsNoLoops in interface UaView

Returns:

whether the view contains loops or not.

getEventNotifier

public EventNotifierType getEventNotifier()

Description copied from interface: UaView

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 UaView

Returns:

the current value of the EventNotifier attribute

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.

getViewVersion

public UaProperty getViewVersion()

Description copied from interface: UaView

The version number for the View. When Nodes are added to or removed from a View, the value of the ViewVersion Property is updated. Clients may detect changes to the composition of a View using this Property. The value of the ViewVersion shall always be greater than 0. (OPC UA Specification, Part 3.)

Specified by:

getViewVersion in interface UaView

Returns:

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

setAttributes

public void setAttributes(ViewAttributes viewAttributes)

setContainsNoLoops

public void setContainsNoLoops(Boolean containsNoLoops)

Description copied from interface: UaView

Set ContainsNoLoops Attribute value for this node.

Specified by:

setContainsNoLoops in interface UaView

Parameters:

containsNoLoops - the value of containsNoLoops to set

See Also:

UaView.getContainsNoLoops()

setEventNotifier

public void setEventNotifier(EventNotifierType eventNotifier)

Description copied from interface: UaView

Set EventNotifier Attribute value for this node.

Specified by:

setEventNotifier in interface UaView

Parameters:

eventNotifier - the value of EventNotifier to set

See Also:

UaView.getEventNotifier()

toString

public String toString()

Overrides:

toString in class UaNodeImpl

getAttributes

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

setViewVersion

protected void setViewVersion(Integer viewVersion)
                       throws StatusException

Set the value of the ViewVersion property. Assumes that the property has already been defined.

Parameters:

viewVersion -

Throws:

StatusException

writeAttributeValue

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

Overrides:

writeAttributeValue in class UaNodeImpl

Throws:

StatusException