Class Extension

Single extension of an element.

Hierarchy

Class
- Extension

Implements

IHasSemantics

Index

Constructors

constructor

new Extension(name: string, semanticId?: Reference, supplementalSemanticIds?: Reference[], valueType?: DataTypeDefXsd, value?: string, refersTo?: Reference[]): Extension
Parameters
- name: string
- semanticId: Reference = null
- supplementalSemanticIds: Reference[] = null
- valueType: DataTypeDefXsd = null
- value: string = null
- refersTo: Reference[] = null
Returns Extension
Overrides Class.constructor
- Defined in types.ts:476

Properties

name

name: string

Name of the extension.

Constraint AASd-077: The name of an extension (Extension/name) within IHasExtensions needs to be unique.

refersTo

refersTo: Reference[]

Reference to an element the extension refers to.

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.

value

value: string

Value of the extension

valueType

valueType: DataTypeDefXsd

Type of the value of the extension.

Remarks

Default: String

Methods

accept

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

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

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 IHasSemantics.acceptWithContext

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

descend

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

Returns
Iterator over the referenced instances

Returns IterableIterator<Class>
Implementation of IHasSemantics.descend

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

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 IHasSemantics.descendOnce

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

modelType

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

Returns ModelType
Implementation of IHasSemantics.modelType

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

overRefersToOrEmpty

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

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

overSupplementalSemanticIdsOrEmpty

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

Returns IterableIterator<Reference>
Implementation of IHasSemantics.overSupplementalSemanticIdsOrEmpty
- Defined in types.ts:352

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 IHasSemantics.transform

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

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 IHasSemantics.transformWithContext

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

valueTypeOrDefault

valueTypeOrDefault(): DataTypeDefXsd
Returns
valueType if set or the default value otherwise.

Returns DataTypeDefXsd
- Defined in types.ts:372

Class Extension

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

semanticId: Reference = null

supplementalSemanticIds: Reference[] = null

valueType: DataTypeDefXsd = null

value: string = null

refersTo: Reference[] = null

Returns Extension

Properties

name

refersTo

semanticId

Remarks

supplementalSemanticIds

Remarks

value

valueType

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

overRefersToOrEmpty

Returns IterableIterator<Reference>

overSupplementalSemanticIdsOrEmpty

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

T

Parameters

transformer: AbstractTransformerWithContext<ContextT, T>

context: ContextT

Returns T

valueTypeOrDefault

Returns

Returns DataTypeDefXsd

Settings

Member Visibility

Theme