A property is a data element that has a multi-language value.

Constraint AASd-012: If both the value and the valueId are present then for each string in a specific language the meaning must be the same as specified in valueId.

Hierarchy

  • Class
    • MultiLanguageProperty

Implements

Constructors

Properties

category: string

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.

Remarks

Note: The category is not identical to the semantic definition (IHasSemantics) 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.

description: LangStringTextType[]

Description or comments on the element.

Remarks

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.

displayName: LangStringNameType[]

Display name. Can be provided in several languages.

embeddedDataSpecifications: EmbeddedDataSpecification[]

Embedded data specification.

extensions: Extension[]

An extension of the element.

idShort: string

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.

Remarks

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

qualifiers: Qualifier[]

Additional qualification of a qualifiable element.

Constraint AASd-021: Every qualifiable can only have one qualifier with the same type.

semanticId: Reference

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

Remarks

Note: It is recommended to use a global reference.

supplementalSemanticIds: Reference[]

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

Remarks

Note: It is recommended to use a global reference.

The value of the property instance.

valueId: Reference

Reference to the global unique ID of a coded value.

Remarks

Note: It is recommended to use a global reference.

Methods

  • Iterate recursively over the instances referenced from this instance.

    Returns

    Iterator over the referenced instances

    Returns IterableIterator<Class>

  • Iterate over the instances referenced from this instance.

    We do not recurse into the referenced instances.

    Returns

    Iterator over the referenced instances

    Returns IterableIterator<Class>

Generated using TypeDoc