Administrative information of an identifiable element.
Note: Some of the administrative information like the version number might need to be part of the identification.
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.
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 to be used to determine if an Referable (including its aggregated child elements) has changed.
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 or comments on the element.
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.
Display name. Can be provided in several languages.
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:
Embedded data specification.
An extension of the element.
The globally unique identification of the element.
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.
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.
Reference to an external definition the concept is compatible to or was derived from.
Note: It is recommended to use a global reference.
Note: Compare to is-case-of relationship in ISO 13584-32 & IEC EN 61360"
Dispatch visitor on this instance.
to visit this instance
Dispatch visitor with context on this instance.
type of the context
to visit this instance
to be passed along to the dispatched visitor method
category if set or the default value otherwise.
Yield from description if it is set, or yield nothing.
Yield from displayName if it is set, or yield nothing.
Yield from embeddedDataSpecifications if it is set, or yield nothing.
Yield from extensions if it is set, or yield nothing.
Dispatch the transformer on this instance.
transformation of this instance
T - type of the transformation result
to transform this instance
Dispatch the transformer on this instance in context.
transformation of this instance
T - type of the transformation result
ContextT - type of the transformation context
to transform this instance
to be passed along to the transformer
Generated using TypeDoc
The semantics of a property or other elements that may have a semantic description is defined by a concept description.
Remarks
The description of the concept should follow a standardized schema (realized as data specification template).
Constraint
AASd-051: A ConceptDescription shall have one of the following categoriesVALUE,PROPERTY,REFERENCE,DOCUMENT,CAPABILITY,RELATIONSHIP,COLLECTION,FUNCTION,EVENT,ENTITY,APPLICATION_CLASS,QUALIFIER,VIEW.Default:
PROPERTY.Constraint
AASc-004: For a ConceptDescription with categoryPROPERTYorVALUEusing data specification IEC61360, the dataType is mandatory and shall be one of:DATE,STRING,STRING_TRANSLATABLE,INTEGER_MEASURE,INTEGER_COUNT,INTEGER_CURRENCY,REAL_MEASURE,REAL_COUNT,REAL_CURRENCY,BOOLEAN,RATIONAL,RATIONAL_MEASURE,TIME,TIMESTAMP.Constraint
AASc-005: For a ConceptDescription with categoryREFERENCEusing data specification IEC61360, the dataType is mandatory and shall be one of:STRING,IRI,IRDI.Constraint
AASc-006: For a ConceptDescription with categoryDOCUMENTusing data specification IEC61360, the dataType is mandatory and shall be defined.Constraint
AASc-007: For a ConceptDescription with categoryQUALIFIER_TYPEusing data specification IEC61360, the dataType is mandatory and shall beConstraint
AASc-008: For all ConceptDescription's with a category except categoryVALUEusing data specification IEC61360, definition is mandatory and shall be defined at least in English.Constraint
AASc-003: For a ConceptDescription with categoryVALUEusing data specification IEC61360, the value shall be set.