7 Common parameter type definitions ToC Previous Next

7.26 RelativePath ToC Previous Next

The components of this parameter are defined in Table 168.

Table 168 – RelativePath

Name Type Description
RelativePath structure Defines a sequence of References and BrowseNames to follow.
   elements [] RelativePath
Element
A sequence of References and BrowseNames to follow. This structure is defined in-line with the following indented items.
Each element in the sequence is processed by finding the targets and then using those targets as the starting nodes for the next element. The targets of the final element are the target of the RelativePath.
      referenceTypeId NodeId The type of reference to follow from the current node.
The current path cannot be followed any further if the referenceTypeId is not available on the Node instance.
If not specified then all References are included and the parameter includeSubtypes is ignored.
      isInverse Boolean Only inverse references shall be followed if this value is TRUE.
Only forward references shall be followed if this value is FALSE.
      includeSubtypes Boolean Indicates whether subtypes of the ReferenceType should be followed. Subtypes are included if this value is TRUE.
      targetName QualifiedName The BrowseName of the target node.
The final element may have an empty targetName. In this situation all targets of the references identified by the referenceTypeId are the targets of the RelativePath.
The targetName shall be specified for all other elements.
The current path cannot be followed any further if no targets with the specified BrowseName exist.

A RelativePath can be applied to any starting Node. The targets of the RelativePath are the set of Nodes that are found by sequentially following the elements in RelativePath.

A text format for the RelativePath can be found in Clause A.2. This format is used in examples that explain the Services that make use of the RelativePath structure.

Previous Next