Reference🔗

Properties 🔗

type: ReferenceTypes 🔗

Type of the reference.

Denotes, whether reference is a global reference or a model reference.

referredSemanticId: Optional[Reference] 🔗

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

For global references there typically is no semantic ID.

It is recommended to use a global reference.

keys: List[Key] 🔗

Unique references in their name space.

Invariants 🔗

• Keys must contain at least one item.
  

  len(self.keys) >= 1

• Constraint AASd-121: For References the type of the first key shall be one of Globally identifiables.
  

  not (len(self.keys) >= 1)
  or (self.keys[0].type in GloballyIdentifiables)

• Constraint AASd-122: For global references the type of the first key shall be one of Generic globally identifiables.
  

  not (
      (
          self.type == ReferenceTypes.GlobalReference
          and len(self.keys) >= 1
      )
  )
  or (self.keys[0].type in GenericGloballyIdentifiables)

• Constraint AASd-123: For model references the type of the first key shall be one of AAS identifiables
  

  not (
      (
          self.type == ReferenceTypes.ModelReference
          and len(self.keys) >= 1
      )
  )
  or (self.keys[0].type in AasIdentifiables)

• Constraint AASd-124: For global references the last key shall be either one of Generic globally identifiables or one of Generic fragment keys.
  

  not (
      (
          self.type == ReferenceTypes.GlobalReference
          and len(self.keys) >= 1
      )
  )
  or (
      (
          (self.keys[-1].type in GenericGloballyIdentifiables)
          or (self.keys[-1].type in GenericFragmentKeys)
      )
  )

• Constraint AASd-125: For model references with more than one key, the type of the keys following the first key shall be one of Fragment keys.
  

  not (
      (
          self.type == ReferenceTypes.ModelReference
          and len(self.keys) > 1
      )
  )
  or (
      all(
          self.keys[i].type in FragmentKeys
          for i in range(
              1,
              len(self.keys)
          )
      )
  )

• Constraint AASd-126: For model references with more than one key, the 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.
  

  not (
      (
          self.type == ReferenceTypes.ModelReference
          and len(self.keys) > 1
      )
  )
  or (
      all(
          not (self.keys[i].type in GenericFragmentKeys)
          for i in range(
              0,
              len(self.keys) - 1
          )
      )
  )

• Constraint AASd-127: For model references with more than one key, a key with type Fragment reference shall be preceded by a key with type File or Blob.
  

  not (
      (
          self.type == ReferenceTypes.ModelReference
          and len(self.keys) > 1
          and self.keys[-1].type == KeyTypes.FragmentReference
      )
  )
  or (
      (
          self.keys[-2].type == KeyTypes.File
          or self.keys[-2].type == KeyTypes.Blob
      )
  )

• Constraint AASd-128: For model references, the value of a key preceded by a key with type Submodel element list is an integer number denoting the position in the array of the submodel element list.
  

  not (
      (
          self.type == ReferenceTypes.ModelReference
          and len(self.keys) > 2
      )
  )
  or (
      all(
          not (self.keys[i].type == KeyTypes.SubmodelElementList)
          or MatchesXsPositiveInteger(
              self.keys[i + 1].value
          )
          for i in range(
              0,
              len(self.keys) - 1
          )
      )
  )

Usages