DataSpecificationIec61360🔗

Content of data specification template for concept descriptions for properties, values and value lists conformant to IEC 61360.

IEC61360 requires also a globally unique identifier for a concept description. This ID is not part of the data specification template. Instead the ConceptDescription.id as inherited via Identifiable is used. Same holds for administrative information like the version and revision.

ConceptDescription.idShort and DataSpecificationIec61360.shortName are very similar. However, in this case the decision was to add DataSpecificationIec61360.shortName explicitly to the data specification. Same holds for ConceptDescription.displayName and DataSpecificationIec61360.preferredName. Same holds for ConceptDescription.description and DataSpecificationIec61360.definition.

Constraint AASc-010🔗: If DataSpecificationIec61360.value is not empty then DataSpecificationIec61360.valueList shall be empty and vice versa.
Constraint AASc-009🔗: If DataSpecificationIec61360.dataType one of: DataTypeIec61360.IntegerMeasure, DataTypeIec61360.RealMeasure, DataTypeIec61360.RationalMeasure, DataTypeIec61360.IntegerCurrency, DataTypeIec61360.RealCurrency, then DataSpecificationIec61360.unit or DataSpecificationIec61360.unitId shall be defined.

Inheritances 🔗

DataSpecificationContent

Properties 🔗

preferredName: List[LangString] 🔗

Preferred name

Constraint AASc-002🔗: DataSpecificationIec61360.preferredName shall be provided at least in English.

shortName: Optional[List[LangString]] 🔗

Short name

unit: Optional[NonEmptyString] 🔗

Unit

unitId: Optional[Reference] 🔗

Unique unit id

DataSpecificationIec61360.unit and DataSpecificationIec61360.unitId need to be consistent if both attributes are set

It is recommended to use a global reference.

Although the DataSpecificationIec61360.unitId is a global reference there might exist a ConceptDescription with data specification DataSpecificationPhysicalUnit with the same ID.

sourceOfDefinition: Optional[NonEmptyString] 🔗

Source of definition

symbol: Optional[NonEmptyString] 🔗

Symbol

dataType: Optional[DataTypeIec61360] 🔗

Data Type

definition: Optional[List[LangString]] 🔗

Definition in different languages

valueFormat: Optional[NonEmptyString] 🔗

Value Format

valueList: Optional[ValueList] 🔗

List of allowed values

value: Optional[str] 🔗

Value

levelType: Optional[LevelType] 🔗

Set of levels.

Invariants 🔗

Constraint AASc-010: If value is not empty then value list shall be empty and vice versa.

(
    (
        (
            (self.value is not None)
            and (self.valueList is None)
        )
    )
    or (
        (
            (self.value is None)
            and (self.valueList is not None)
            and len(self.valueList.valueReferencePairs) >= 1
        )
    )
)

Constraint AASc-009: If data type is a an integer, real or rational with a measure or currency, unit or unit ID shall be defined.

not (
    (
        (self.dataType is not None)
        and (self.dataType in Iec61360DataTypesWithUnit)
    )
)
or (
    (
        (self.unit is not None)
        or (self.unitId is not None)
    )
)

Definition must be either not set or have at least one item

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

Definition specifies no duplicate languages

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

Short name must be either not set or have at least one item

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

Short name specifies no duplicate languages

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

Preferred name must have at least one item
```
len(self.preferredName) >= 1
```

Preferred name specifies no duplicate languages

LangStringsHaveUniqueLanguages(
    self.preferredName
)

Constraint AASc-002: preferred name shall be provided at least in English.

any(
    IsBcp47ForEnglish(
        langString.language
    )
    for langString in self.preferredName
)