A relationship element is used to define a relationship between two elements being either referable (model reference) or external (global reference).

Hierarchy

Implemented by

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.

first: Reference

Reference to the first element in the relationship taking the role of the subject.

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.

second: Reference

Reference to the second element in the relationship taking the role of the object.

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.

Methods

Generated using TypeDoc