An entity is a submodel element that is used to model entities.

Constraint AASd-014: Either the attribute globalAssetId or specificAssetId of an Entity must be set if entityType is set to SelfManagedEntity. They are not existing otherwise.

Hierarchy

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.

checksum: string

Checksum to be used to determine if an Referable (including its aggregated child elements) has changed.

Remarks

The checksum is calculated by the user's tool environment. The checksum has no semantic meaning for an asset administration shell model and there is no requirement for asset administration shell tools to manage the checksum

description: LangString[]

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: LangString[]

Display name. Can be provided in several languages.

Remarks

If no display name is defined in the language requested by the application, then the display name is selected in the following order if available:

  • the preferred name in the requested language of the concept description defining the semantics of the element
  • If there is a default language list defined in the application, then the corresponding preferred name in the language is chosen according to this order.
  • the English preferred name of the concept description defining the semantics of the element
  • the short name of the concept description
  • the idShort of the element
embeddedDataSpecifications: EmbeddedDataSpecification[]

Embedded data specification.

entityType: EntityType

Describes whether the entity is a co-managed entity or a self-managed entity.

extensions: Extension[]

An extension of the element.

globalAssetId: Reference

Global identifier of the asset the entity is representing.

Remarks

Note: This is a global reference.

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.

Kind of the element: either type or instance.

Remarks

Default: Instance

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.

specificAssetId: SpecificAssetId

Reference to a specific asset ID representing a supplementary identifier of the asset represented by the Asset Administration Shell.

statements: ISubmodelElement[]

Describes statements applicable to the entity by a set of submodel elements, typically with a qualified value.

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