Class Key

A key is a reference to an element by its ID.

Hierarchy

Class
- Key

Index

Constructors

constructor

new Key(type: KeyTypes, value: string): Key
Parameters
- type: KeyTypes
- value: string
Returns Key
Overrides Class.constructor
- Defined in types.ts:9388

Properties

type

type: KeyTypes

Denotes which kind of entity is referenced.

Remarks

In case type = FragmentReference the key represents a bookmark or a similar local identifier within its parent element as specified by the key that precedes this key.

In all other cases the key references a model element of the same or of another AAS. The name of the model element is explicitly listed.

value

value: string

The key value, for example an IRDI or an URI

Methods

accept

accept(visitor: AbstractVisitor): void
Dispatch visitor on this instance.
Parameters
- visitor: AbstractVisitor
  
  to visit this instance
Returns void
Overrides Class.accept
- Defined in types.ts:9343

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
Overrides Class.acceptWithContext
- Defined in types.ts:9354

descend

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

Returns
Iterator over the referenced instances

Returns IterableIterator<Class>
Overrides Class.descend
- Defined in types.ts:9334

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>
Overrides Class.descendOnce
- Defined in types.ts:9325

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
Overrides Class.transform
- Defined in types.ts:9368

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
Overrides Class.transformWithContext
- Defined in types.ts:9381

Class Key

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

type: KeyTypes

value: string

Returns Key

Properties

type

Remarks

value

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>

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

Settings

Member Visibility

Theme