Reference to either a model element of the same or another AAS or to an external entity.

Remarks

A reference is an ordered list of keys.

A model reference is an ordered list of keys, each key referencing an element. The complete list of keys may for example be concatenated to a path that then gives unique access to an element.

An external reference is a reference to an external entity.

Constraint AASd-121: For Reference's the value of type of the first key of " keys shall be one of GLOBALLY_IDENTIFIABLES.

Constraint AASd-122: For external references, i.e. Reference's with type = ExternalReference, the value of type of the first key of keys shall be one of GENERIC_GLOBALLY_IDENTIFIABLES.

Constraint AASd-123: For model references, i.e. Reference's with type = ModelReference, the value of type of the first key of keys shall be one of AAS_IDENTIFIABLES.

Constraint AASd-124: For external references, i.e. Reference's with type = ExternalReference, the last key of keys shall be either one of GENERIC_GLOBALLY_IDENTIFIABLES or one of GENERIC_FRAGMENT_KEYS.

Constraint AASd-125: For model references, i.e. Reference's with type = ModelReference, with more than one key in keys the value of type of each of the keys following the first key of keys shall be one of FRAGMENT_KEYS.

Note: Constraint AASd-125 ensures that the shortest path is used.

Constraint AASd-126: For model references, i.e. Reference's with type = ModelReference, with more than one key in keys the value of type of the last key in the reference key chain may be one of GENERIC_FRAGMENT_KEYS or no key at all shall have a value out of GENERIC_FRAGMENT_KEYS.

Constraint AASd-127: For model references, i.e. Reference's with type = ModelReference, with more than one key in keys a key with type FragmentReference shall be preceded by a key with type File or Blob. All other AAS fragments, i.e. type values out of AAS_SUBMODEL_ELEMENTS_AS_KEYS, do not support fragments.

Note: Which kind of fragments are supported depends on the content type and the specification of allowed fragment identifiers for the corresponding resource being referenced via the reference.

Constraint AASd-128: For model references, i.e. Reference's with type = ModelReference, the value of a Key preceded by a Key with type = SubmodelElementList is an integer number denoting the position in the array of the submodel element list.

Hierarchy

Constructors

Properties

keys: Key[]

Unique references in their name space.

referredSemanticId: Reference

semanticId of the referenced model element (type = ModelReference).

Remarks

For external references there typically is no semantic ID.

Note: It is recommended to use a external reference.

Type of the reference.

Remarks

Denotes, whether reference is an external reference or a model reference.

Methods

  • Iterate recursively over the instances referenced from this instance.

    Returns

    Iterator over the referenced instances

    Returns IterableIterator<Class>

  • Iterate over the instances referenced from this instance.

    We do not recurse into the referenced instances.

    Returns

    Iterator over the referenced instances

    Returns IterableIterator<Class>

  • Dispatch the transformer on this instance.

    Returns

    transformation of this instance

    Param Type

    T - type of the transformation result

    Type Parameters

    • T

    Parameters

    Returns T

  • Dispatch the transformer on this instance in context.

    Returns

    transformation of this instance

    Param Type

    T - type of the transformation result

    Param Type

    ContextT - type of the transformation context

    Type Parameters

    • ContextT

    • T

    Parameters

    Returns T

Generated using TypeDoc