Referable🔗
(abstract)

Inheritances 🔗

• HasExtensions

Descendants 🔗

• SubmodelElement
• RelationshipElement
• AnnotatedRelationshipElement
• Identifiable
• AssetAdministrationShell
• EventElement
• BasicEventElement
• DataElement
• Blob
• Capability
• ConceptDescription
• Entity
• File
• MultiLanguageProperty
• Operation
• Property
• Range
• ReferenceElement
• Submodel
• SubmodelElementCollection
• SubmodelElementList

Properties 🔗

extensions: Optional[List[Extension]] 🔗

(From HasExtensions)

An extension of the element.

category: Optional[NameType] 🔗

The category is a value that gives further meta information w.r.t. to the class of the element. It affects the expected existence of attributes and the applicability of constraints.

The category is not identical to the semantic definition (HasSemantics) of an element. The category e.g. could denote that the element is a measurement value whereas the semantic definition of the element would denote that it is the measured temperature.

idShort: Optional[IdShortType] 🔗

In case of identifiables this attribute is a short name of the element. In case of referable this ID is an identifying string of the element within its name space.

In case the element is a property and the property has a semantic definition (HasSemantics.semanticId) conformant to IEC61360 the Referable.idShort is typically identical to the short name in English.

displayName: Optional[List[LangStringNameType]] 🔗

Display name. Can be provided in several languages.

description: Optional[List[LangStringTextType]] 🔗

Description or comments on the element.

The description can be provided in several languages.

If no description is defined, then the definition of the concept description that defines the semantics of the element is used.

Additional information can be provided, e.g., if the element is qualified and which qualifier types can be expected in which context or which additional data specification templates are provided.

Invariants 🔗

• Extensions must be either not set or have at least one item.
  (From HasExtensions)
  

  not (self.extensions is not None)
  or (len(self.extensions) >= 1)

• Constraint AASd-077: The name of an extension within Has-Extensions needs to be unique.
  (From HasExtensions)
  

  not (self.extensions is not None)
  or ExtensionNamesAreUnique(
      self.extensions
  )

• Description must be either not set or have at least one item.
  

  not (self.description is not None)
  or (len(self.description) >= 1)

• Description must specify unique languages.
  

  not (self.description is not None)
  or LangStringsHaveUniqueLanguages(
      self.description
  )

• Display name must be either not set or have at least one item.
  

  not (self.displayName is not None)
  or (len(self.displayName) >= 1)

• Display name must specify unique languages.
  

  not (self.displayName is not None)
  or LangStringsHaveUniqueLanguages(
      self.displayName
  )