Class ConceptDescription

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 AASc-3a-004: For a ConceptDescription with category PROPERTY or VALUE using 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.

Note: Note: categories are deprecated since V3.0 of Part 1a of the document series "Details of the Asset Administration Shell".

Constraint AASc-3a-005: For a ConceptDescription with category REFERENCE using data specification template IEC61360, the dataType shall be one of: STRING, IRI, IRDI.

Note: Note: categories are deprecated since V3.0 of Part 1a of the document series "Details of the Asset Administration Shell".

Constraint AASc-3a-006: For a ConceptDescription with category DOCUMENT using data specification IEC61360, the dataType shall be one of FILE, BLOB, HTML

Note: Categories are deprecated since V3.0 of Part 1a of the document series "Details of the Asset Administration Shell".

Constraint AASc-3a-007: For a ConceptDescription with category QUALIFIER_TYPE using data specification IEC61360, the dataType is mandatory and shall be defined.

Note: Categories are deprecated since V3.0 of Part 1a of the document series "Details of the Asset Administration Shell".

Constraint AASc-3a-008: For a ConceptDescription using data specification template IEC61360, definition is mandatory and shall be defined at least in English.

Exception: The concept description describes a value, i.e. value is defined.

Constraint AASc-3a-003: For a ConceptDescription using data specification template IEC61360, referenced via valueList valueId the value shall be set.

Hierarchy

Class
- ConceptDescription

Implements

Constructors

constructor

new ConceptDescription(id: string, extensions?: Extension[], category?: string, idShort?: string, displayName?: LangStringNameType[], description?: LangStringTextType[], administration?: AdministrativeInformation, embeddedDataSpecifications?: EmbeddedDataSpecification[], isCaseOf?: Reference[]): ConceptDescription
Parameters
- id: string
- extensions: Extension[] = null
- category: string = null
- idShort: string = null
- displayName: LangStringNameType[] = null
- description: LangStringTextType[] = null
- administration: AdministrativeInformation = null
- embeddedDataSpecifications: EmbeddedDataSpecification[] = null
- isCaseOf: Reference[] = null
Returns ConceptDescription
Overrides Class.constructor
- Defined in types.ts:8784

Properties

administration

administration: AdministrativeInformation

Administrative information of an identifiable element.

Remarks

Note: Some of the administrative information like the version number might need to be part of the identification.

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

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

displayName: LangStringNameType[]

Display name. Can be provided in several languages.

embeddedDataSpecifications

embeddedDataSpecifications: EmbeddedDataSpecification[]

Embedded data specification.

extensions

extensions: Extension[]

An extension of the element.

id

id: string

The globally unique identification of the element.

idShort

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.

isCaseOf

isCaseOf: Reference[]

Reference to an external definition the concept is compatible to or was derived from.

Remarks

Note: It is recommended to use a global reference.

Note: Compare to is-case-of relationship in ISO 13584-32 & IEC EN 61360

Methods

accept

accept(visitor: AbstractVisitor): void
Dispatch visitor on this instance.
Parameters
- visitor: AbstractVisitor
  
  to visit this instance
Returns void
Implementation of IHasDataSpecification.accept

Overrides Class.accept
- Defined in types.ts:8739

acceptWithContext

acceptWithContext<ContextT>(visitor: AbstractVisitorWithContext<ContextT>, context: ContextT): void
Dispatch visitor with context on this instance.
Type Parameters
- ContextT
  
  type of the context
Parameters
- visitor: AbstractVisitorWithContext<ContextT>
  
  to visit this instance
- context: ContextT
  
  to be passed along to the dispatched visitor method
Returns void
Implementation of IHasDataSpecification.acceptWithContext

Overrides Class.acceptWithContext
- Defined in types.ts:8750

descend

descend(): IterableIterator<Class>
Iterate recursively over the instances referenced from this instance.

Returns
Iterator over the referenced instances

Returns IterableIterator<Class>
Implementation of IHasDataSpecification.descend

Overrides Class.descend
- Defined in types.ts:8686

descendOnce

descendOnce(): 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>
Implementation of IHasDataSpecification.descendOnce

Overrides Class.descendOnce
- Defined in types.ts:8655

modelType

modelType(): ModelType
Indicate the runtime model type of the instance.

Returns ModelType
Implementation of IHasDataSpecification.modelType

Overrides Class.modelType
- Defined in types.ts:8504

overDescriptionOrEmpty

overDescriptionOrEmpty(): IterableIterator<LangStringTextType>
Yield from description if it is set, or yield nothing.

Returns IterableIterator<LangStringTextType>
Implementation of IIdentifiable.overDescriptionOrEmpty
- Defined in types.ts:8621

overDisplayNameOrEmpty

overDisplayNameOrEmpty(): IterableIterator<LangStringNameType>
Yield from displayName if it is set, or yield nothing.

Returns IterableIterator<LangStringNameType>
Implementation of IIdentifiable.overDisplayNameOrEmpty
- Defined in types.ts:8611

overEmbeddedDataSpecificationsOrEmpty

overEmbeddedDataSpecificationsOrEmpty(): IterableIterator<EmbeddedDataSpecification>
Yield from embeddedDataSpecifications if it is set, or yield nothing.

Returns IterableIterator<EmbeddedDataSpecification>
Implementation of IHasDataSpecification.overEmbeddedDataSpecificationsOrEmpty
- Defined in types.ts:8631

overExtensionsOrEmpty

overExtensionsOrEmpty(): IterableIterator<Extension>
Yield from extensions if it is set, or yield nothing.

Returns IterableIterator<Extension>
Implementation of IIdentifiable.overExtensionsOrEmpty
- Defined in types.ts:8601

overIsCaseOfOrEmpty

overIsCaseOfOrEmpty(): IterableIterator<Reference>
Yield from isCaseOf if it is set, or yield nothing.

Returns IterableIterator<Reference>
- Defined in types.ts:8641

transform

transform<T>(transformer: AbstractTransformer<T>): T
Dispatch the transformer on this instance.

Returns
transformation of this instance

Param Type
T - type of the transformation result
Type Parameters
- T
Parameters
- transformer: AbstractTransformer<T>
  
  to transform this instance
Returns T
Implementation of IHasDataSpecification.transform

Overrides Class.transform
- Defined in types.ts:8764

transformWithContext

transformWithContext<ContextT, T>(transformer: AbstractTransformerWithContext<ContextT, T>, context: ContextT): T
Dispatch the transformer on this instance in context.

Returns
transformation of this instance

Param Type
T - type of the transformation result

Param Type
ContextT - type of the transformation context
Type Parameters
- ContextT
- T
Parameters
- transformer: AbstractTransformerWithContext<ContextT, T>
  
  to transform this instance
- context: ContextT
  
  to be passed along to the transformer
Returns T
Implementation of IHasDataSpecification.transformWithContext

Overrides Class.transformWithContext
- Defined in types.ts:8777

Class ConceptDescription

Remarks

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

id: string

extensions: Extension[] = null

category: string = null

idShort: string = null

displayName: LangStringNameType[] = null

description: LangStringTextType[] = null

administration: AdministrativeInformation = null

embeddedDataSpecifications: EmbeddedDataSpecification[] = null

isCaseOf: Reference[] = null

Returns ConceptDescription

Properties

administration

Remarks

category

Remarks

description

Remarks

displayName

embeddedDataSpecifications

extensions

id

idShort

Remarks

isCaseOf

Remarks

Methods

accept

Parameters

visitor: AbstractVisitor

Returns void

acceptWithContext

Type Parameters

ContextT

Parameters

visitor: AbstractVisitorWithContext<ContextT>

context: ContextT

Returns void

descend

Returns

Returns IterableIterator<Class>

descendOnce

Returns

Returns IterableIterator<Class>

modelType

Returns ModelType

overDescriptionOrEmpty

Returns IterableIterator<LangStringTextType>

overDisplayNameOrEmpty

Returns IterableIterator<LangStringNameType>

overEmbeddedDataSpecificationsOrEmpty

Returns IterableIterator<EmbeddedDataSpecification>

overExtensionsOrEmpty

Returns IterableIterator<Extension>

overIsCaseOfOrEmpty

Returns IterableIterator<Reference>

transform

Returns

Param Type

Type Parameters

T

Parameters

transformer: AbstractTransformer<T>

Returns T

transformWithContext

Returns

Param Type

Param Type

Type Parameters

ContextT