A submodel element list is an ordered list of submodel elements.

Remarks

The numbering starts with zero (0).

Constraint AASd-107: If a first level child element in a SubmodelElementList has a semanticId it shall be identical to semanticIdListElement.

Constraint AASd-114: If two first level child elements in a SubmodelElementList have a semanticId then they shall be identical.

Constraint AASd-115: If a first level child element in a SubmodelElementList does not specify a semanticId then the value is assumed to be identical to semanticIdListElement.

Constraint AASd-120: The idShort of a ISubmodelElement being a direct child of a SubmodelElementList shall not be specified.

Constraint AASd-108: All first level child elements in a SubmodelElementList shall have the same submodel element type as specified in typeValueListElement.

Constraint AASd-109: If typeValueListElement is equal to Property or Range valueTypeListElement shall be set and all first level child elements in the SubmodelElementList shall have the value type as specified in valueTypeListElement.

Hierarchy

  • Class
    • SubmodelElementList

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.

orderRelevant: boolean

Defines whether order in list is relevant. If orderRelevant = False then the list is representing a set or a bag.

Remarks

Default: True

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.

semanticIdListElement: Reference

Semantic ID the submodel elements contained in the list match to.

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.

typeValueListElement: AasSubmodelElements

The submodel element type of the submodel elements contained in the list.

Submodel element contained in the list.

Remarks

The list is ordered.

valueTypeListElement: DataTypeDefXsd

The value type of the submodel element contained in the list.

Methods

  • Returns

    orderRelevant if set or the default value otherwise.

    Returns boolean

Generated using TypeDoc