Interface IHasSemantics

Element that can have a semantic definition plus some supplemental semantic definitions.

Constraint AASd-118: If there are ID supplementalSemanticIds defined then there shall be also a main semantic ID semanticId.

Hierarchy

Class
- IHasSemantics
  - ISubmodelElement

Implemented by

Index

Properties

semanticId supplementalSemanticIds

Methods

accept acceptWithContext descend descendOnce modelType overSupplementalSemanticIdsOrEmpty transform transformWithContext

Properties

semanticId

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

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

`Abstract` accept

accept(visitor: AbstractVisitor): void
Dispatch the visitor on this instance.
Parameters
- visitor: AbstractVisitor
  
  to be dispatched
Returns void
Inherited from Class.accept
- Defined in types.ts:216

`Abstract` acceptWithContext

acceptWithContext<ContextT>(visitor: AbstractVisitorWithContext<ContextT>, context: ContextT): void
Dispatch the visitor on this instance with context.
Type Parameters
- ContextT
  
  type of the visitation context
Parameters
- visitor: AbstractVisitorWithContext<ContextT>
  
  to be dispatched
- context: ContextT
  
  of the visitation
Returns void
Inherited from Class.acceptWithContext
- Defined in types.ts:225

`Abstract` descend

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

Returns IterableIterator<Class>
Inherited from Class.descend
- Defined in types.ts:209

`Abstract` descendOnce

descendOnce(): IterableIterator<Class>
Iterate over all the instances referenced from this one.

Returns IterableIterator<Class>
Inherited from Class.descendOnce
- Defined in types.ts:204

`Abstract` modelType

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

Returns ModelType
Inherited from Class.modelType
- Defined in types.ts:199

overSupplementalSemanticIdsOrEmpty

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

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

`Abstract` transform

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

Returns
this instance transformed
Type Parameters
- T
  
  type of the transformation result
Parameters
- transformer: AbstractTransformer<T>
  
  to be dispatched
Returns T
Inherited from Class.transform
- Defined in types.ts:237

`Abstract` transformWithContext

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

Returns
this instance transformed
Type Parameters
- ContextT
- T
  
  type of the transformation result
Parameters
- transformer: AbstractTransformerWithContext<ContextT, T>
  
  to be dispatched
- context: ContextT
  
  of the transformation
Returns T
Inherited from Class.transformWithContext
- Defined in types.ts:247

Interface IHasSemantics

Hierarchy

Implemented by

Index

Properties

Methods

Properties

semanticId

Remarks

supplementalSemanticIds

Remarks

Methods

Abstract accept

Parameters

visitor: AbstractVisitor

Returns void

Abstract acceptWithContext

Type Parameters

ContextT

Parameters

visitor: AbstractVisitorWithContext<ContextT>

context: ContextT

Returns void

Abstract descend

Returns IterableIterator<Class>

Abstract descendOnce

Returns IterableIterator<Class>

Abstract modelType

Returns ModelType

overSupplementalSemanticIdsOrEmpty

Returns IterableIterator<Reference>

Abstract transform

Returns

Type Parameters

T

Parameters

transformer: AbstractTransformer<T>

Returns T

Abstract transformWithContext

Returns

Type Parameters

ContextT

T

Parameters

transformer: AbstractTransformerWithContext<ContextT, T>

context: ContextT

Returns T

Settings

Member Visibility

Theme

`Abstract` accept

`Abstract` acceptWithContext

`Abstract` descend

`Abstract` descendOnce

`Abstract` modelType

`Abstract` transform

`Abstract` transformWithContext