Class Qualifier

A qualifier is a type-value-pair that makes additional statements w.r.t. the value of the element.

Constraint AASd-006: If both the value and the valueId of a Qualifier are present then the value needs to be identical to the value of the referenced coded value in valueId.

Constraint AASd-020: The value of value shall be consistent to the data type as defined in valueType.

Hierarchy

Class
- Qualifier

Implements

IHasSemantics

Index

Constructors

constructor

new Qualifier(type: string, valueType: DataTypeDefXsd, semanticId?: Reference, supplementalSemanticIds?: Reference[], kind?: QualifierKind, value?: string, valueId?: Reference): Qualifier
Parameters
- type: string
- valueType: DataTypeDefXsd
- semanticId: Reference = null
- supplementalSemanticIds: Reference[] = null
- kind: QualifierKind = null
- value: string = null
- valueId: Reference = null
Returns Qualifier
Overrides Class.constructor
- Defined in types.ts:1124

Properties

kind

kind: QualifierKind

The qualifier kind describes the kind of the qualifier that is applied to the element.

Remarks

Default: ConceptQualifier

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.

type

type: string

The qualifier type describes the type of the qualifier that is applied to the element.

value

value: string

The qualifier value is the value of the qualifier.

valueId

valueId: Reference

Reference to the global unique ID of a coded value.

Remarks

Note: It is recommended to use a global reference.

valueType

valueType: DataTypeDefXsd

Data type of the qualifier value.

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

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

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

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

kindOrDefault

kindOrDefault(): QualifierKind
Returns
kind if set or the default value otherwise.

Returns QualifierKind
- Defined in types.ts:1022

modelType

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

Returns ModelType
Implementation of IHasSemantics.modelType

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

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

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

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

Class Qualifier

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

type: string

valueType: DataTypeDefXsd

semanticId: Reference = null

supplementalSemanticIds: Reference[] = null

kind: QualifierKind = null

value: string = null

valueId: Reference = null

Returns Qualifier

Properties

kind

Remarks

semanticId

Remarks

supplementalSemanticIds

Remarks

type

value

valueId

Remarks

valueType

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>

kindOrDefault

Returns

Returns QualifierKind

modelType

Returns ModelType

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