ConceptDescription🔗

Inheritances 🔗

• Identifiable
• HasDataSpecification

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.

administration: Optional[AdministrativeInformation] 🔗

(From Identifiable)

Administrative information of an identifiable element.

Some of the administrative information like the version number might need to be part of the identification.

id: Identifier 🔗

(From Identifiable)

The globally unique identification of the element.

embeddedDataSpecifications: Optional[List[EmbeddedDataSpecification]] 🔗

(From HasDataSpecification)

Embedded data specification.

isCaseOf: Optional[List[Reference]] 🔗

Reference to an external definition the concept is compatible to or was derived from.

It is recommended to use a global reference.

Compare to is-case-of relationship in ISO 13584-32 & IEC EN 61360

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
  )

• 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)

• Is-case-of must be either not set or have at least one item.
  

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

• Constraint AASc-3a-008: For a concept description using data specification template IEC 61360, the definition is mandatory and shall be defined at least in English. Exception: The concept description describes a value.
  

  not (self.embeddedDataSpecifications is not None)
  or (
      (
          DataSpecificationIec61360sHaveDefinitionAtLeastInEnglish(
              self.embeddedDataSpecifications
          )
          or DataSpecificationIec61360sHaveValue(
              self.embeddedDataSpecifications
          )
      )
  )

• Constraint AASc-3a-007: For a concept description with category QUALIFIER_TYPE using data specification IEC 61360, the data type of the data specification is mandatory and shall be defined.
  

  not (
      (
          (self.category is not None)
          and self.category == 'QUALIFIER_TYPE'
          and (self.embeddedDataSpecifications is not None)
      )
  )
  or DataSpecificationIec61360sHaveDataType(
      self.embeddedDataSpecifications
  )

• Constraint AASc-3a-006: For a concept description with category DOCUMENT using data specification IEC 61360, the data type of the data specification shall be one of: FILE, BLOB, HTML.
  

  not (
      (
          (self.category is not None)
          and self.category == 'DOCUMENT'
          and (self.embeddedDataSpecifications is not None)
      )
  )
  or DataSpecificationIec61360sForDocumentHaveAppropriateDataType(
      self.embeddedDataSpecifications
  )

• Constraint AASc-3a-005: For a concept description with category REFERENCE using data specification IEC 61360, the data type of the data specification shall be one of: STRING, IRI, IRDI.
  

  not (
      (
          (self.category is not None)
          and self.category == 'REFERENCE'
          and (self.embeddedDataSpecifications is not None)
      )
  )
  or DataSpecificationIec61360sForReferenceHaveAppropriateDataType(
      self.embeddedDataSpecifications
  )

• Constraint AASc-3a-004: For a concept description with category PROPERTY or VALUE using data specification IEC 61360, the data type of the data specification is mandatory and shall be one of: DATE, STRING, STRING_TRANSLATABLE, INTEGER_MEASURE, INTEGER_COUNT, INTEGER_CURRENCY, REAL_MEASURE, REAL_COUNT, REAL_CURRENCY, BOOLEAN, RATIONAL, RATIONAL_MEASURE, TIME, TIMESTAMP.
  

  not (
      (
          (self.category is not None)
          and (
              (
                  self.category == 'PROPERTY'
                  or self.category == 'VALUE'
              )
          )
          and (self.embeddedDataSpecifications is not None)
      )
  )
  or DataSpecificationIec61360sForPropertyOrValueHaveAppropriateDataType(
      self.embeddedDataSpecifications
  )

Usages