Class SpecificAssetId

A specific asset ID describes a generic supplementary identifying attribute of the asset.

Remarks

The specific asset ID is not necessarily globally unique.

Hierarchy

Class
- SpecificAssetId

Implements

IHasSemantics

Index

Constructors

constructor

new SpecificAssetId(name: string, value: string, externalSubjectId: Reference, semanticId?: Reference, supplementalSemanticIds?: Reference[]): SpecificAssetId
Parameters
- name: string
- value: string
- externalSubjectId: Reference
- semanticId: Reference = null
- supplementalSemanticIds: Reference[] = null
Returns SpecificAssetId
Overrides Class.constructor
- Defined in types.ts:1812

Properties

externalSubjectId

externalSubjectId: Reference

The (external) subject the key belongs to or has meaning to.

Remarks

Note: This is a global reference.

name

name: string

Name of the identifier

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

The value of the specific asset identifier with the corresponding name.

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:1767

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:1778

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:1742

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:1725

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:1711

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:1792

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:1805

Class SpecificAssetId

Remarks

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

value: string

externalSubjectId: Reference

semanticId: Reference = null

supplementalSemanticIds: Reference[] = null

Returns SpecificAssetId

Properties

externalSubjectId

Remarks

name

semanticId

Remarks

supplementalSemanticIds

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>

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

Settings

Member Visibility

Theme