Entity🔗

Inheritances 🔗

• SubmodelElement

Properties 🔗

extensions: Optional[List[Extension]] 🔗

(From HasExtensions)

An extension of the element.

category: Optional[NameType] 🔗

(From Referable)

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] 🔗

(From Referable)

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]] 🔗

(From Referable)

Display name. Can be provided in several languages.

description: Optional[List[LangStringTextType]] 🔗

(From Referable)

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.

semanticId: Optional[Reference] 🔗

(From HasSemantics)

Identifier of the semantic definition of the element. It is called semantic ID of the element or also main semantic ID of the element.

It is recommended to use a global reference.

supplementalSemanticIds: Optional[List[Reference]] 🔗

(From HasSemantics)

Identifier of a supplemental semantic definition of the element. It is called supplemental semantic ID of the element.

It is recommended to use a global reference.

qualifiers: Optional[List[Qualifier]] 🔗

(From Qualifiable)

Additional qualification of a qualifiable element.

Constraint AASd-021🔗

Every qualifiable can only have one qualifier with the same Qualifier.type.

embeddedDataSpecifications: Optional[List[EmbeddedDataSpecification]] 🔗

(From HasDataSpecification)

Embedded data specification.

statements: Optional[List[SubmodelElement]] 🔗

Describes statements applicable to the entity by a set of submodel elements, typically with a qualified value.

entityType: EntityType 🔗

Describes whether the entity is a co-managed entity or a self-managed entity.

globalAssetId: Optional[Identifier] 🔗

Global identifier of the asset the entity is representing.

This is a global reference.

specificAssetIds: Optional[List[SpecificAssetId]] 🔗

Reference to a specific asset ID representing a supplementary identifier of the asset represented by the Asset Administration Shell.

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.
  (From Referable)
  

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

• Description must specify unique languages.
  (From Referable)
  

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

• Display name must be either not set or have at least one item.
  (From Referable)
  

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

• Display name must specify unique languages.
  (From Referable)
  

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

• Supplemental semantic IDs must be either not set or have at least one item.
  (From HasSemantics)
  

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

• Constraint AASd-118: If there are supplemental semantic IDs defined then there shall be also a main semantic ID.
  (From HasSemantics)
  

  not (self.supplementalSemanticIds is not None)
  or (self.semanticId is not None)

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

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

• Constraint AASd-021: Every qualifiable can only have one qualifier with the same type.
  (From Qualifiable)
  

  not (self.qualifiers is not None)
  or QualifierTypesAreUnique(
      self.qualifiers
  )

• Embedded data specifications must be either not set or have at least one item.
  (From HasDataSpecification)
  

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

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

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

• ID-shorts need to be defined for all the items of statements according to AASd-117 (ID-short of Referables not being a direct child of a Submodel element list shall be specified).
  

  not (self.statements is not None)
  or (
      all(
          item.idShort is not None
          for item in self.statements
      )
  )

• Constraint AASd-014: Either the attribute global asset ID or specific asset ID must be set if entity type is set to self-managed entity. They are not existing otherwise.
  

  (
      (
          (
              self.entityType == EntityType.SelfManagedEntity
              and (
                  (
                      (
                          (
                              (self.globalAssetId is not None)
                              and (self.specificAssetIds is None)
                          )
                      )
                      or (
                          (
                              (self.globalAssetId is None)
                              and (self.specificAssetIds is not None)
                              and len(self.specificAssetIds) >= 1
                          )
                      )
                  )
              )
          )
      )
      or (
          (
              self.entityType != EntityType.SelfManagedEntity
              and (self.globalAssetId is None)
              and (self.specificAssetIds is None)
          )
      )
  )

• Specific asset IDs must be either not set or have at least one item.
  

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