com.prosysopc.ua.nodes
Interface UaReferenceType

All Superinterfaces:
UaNode, UaType
All Known Implementing Classes:
UaReferenceTypeImpl, UaReferenceTypeNode

public interface UaReferenceType
extends UaType

Interface definition of the OPC UA reference type.

References are defined as instances of ReferenceType Nodes. ReferenceType Nodes are visible in the AddressSpace and are defined using the ReferenceType NodeClass. In contrast, a Reference is an inherent part of a Node and no NodeClass is used to represent References.

The BrowseName of a ReferenceType shall be unique in a server. It is not allowed that two different ReferenceTypes have the same BrowseName.

The IsAbstract Attribute indicates if the ReferenceType is abstract. Abstract ReferenceTypes can not be instantiated and are used only for organizational reasons, e.g. to specify some general semantics or constrains that are inherited to its subtypes.

The Symmetric Attribute is used to indicate whether or not the meaning of the ReferenceType is the same for both the SourceNode and TargetNode.

If a ReferenceType is symmetric, the InverseName Attribute shall be omitted. Examples of symmetric ReferenceTypes are 'Connects To' and 'Communicates With'. Both imply the same semantic coming from the SourceNode or the TargetNode. Therefore both directions are considered to be forward References.

If the ReferenceType is non-symmetric and not abstract, the InverseName Attribute shall be set. The InverseName Attribute specifies the meaning of the ReferenceType as seen from the TargetNode. Examples of non-symmetric ReferenceTypes include 'Contains' and 'Contained In', and 'Receives From' and 'Sends To'.

References that use the InverseName, such as 'Contained In' References, are referred to as inverse References.

(OPC UA Specification, Part 3.)

See Also:
UaType, UaVariableType, UaObjectType, UaDataType, UaClientReference

Method Summary
 org.opcfoundation.ua.builtintypes.LocalizedText getInverseName()
          The inverse name of the Reference, i.e. the meaning of the ReferenceType as seen from the TargetNode.
 Boolean getSymmetric()
          A boolean Attribute with the following values: true the meaning of the ReferenceType is the same as seen from both the SourceNode and the TargetNode.
 void setInverseName(org.opcfoundation.ua.builtintypes.LocalizedText inverseName)
           
 void setSymmetric(Boolean symmetric)
           
 
Methods inherited from interface com.prosysopc.ua.nodes.UaType
addSubType, getIsAbstract, getJavaClass, getSuperType, hasSuperType, inheritsFrom, inheritsFrom, setIsAbstract, setJavaClass, setSuperType
 
Methods inherited from interface com.prosysopc.ua.nodes.UaNode
addComponent, addProperty, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributes, getBrowseName, getComponent, getComponents, getDescription, getDisplayName, getForwardReferences, getInverseReferences, getMethod, getNodeClass, getNodeId, getNodeVersion, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute
 

Method Detail

getInverseName

org.opcfoundation.ua.builtintypes.LocalizedText getInverseName()
The inverse name of the Reference, i.e. the meaning of the ReferenceType as seen from the TargetNode.

Returns:
the current value of InverseName

getSymmetric

Boolean getSymmetric()
A boolean Attribute with the following values:
true the meaning of the ReferenceType is the same as seen from both the SourceNode and the TargetNode.
false the meaning of the ReferenceType as seen from the TargetNode is the inverse of that as seen from the SourceNode.

Returns:
the current value of Symmetric

setInverseName

void setInverseName(org.opcfoundation.ua.builtintypes.LocalizedText inverseName)
Parameters:
inverseName - the InverseName to set
See Also:
getInverseName()

setSymmetric

void setSymmetric(Boolean symmetric)
Parameters:
symmetric - the value of Symmetric to set
See Also:
getSymmetric()


Copyright © 2018. All rights reserved.