Class DataSpecificationIec61360

Content of data specification template for concept descriptions for properties, values and value lists conformant to IEC 61360.

Remarks

Note: IEC61360 requires also a globally unique identifier for a concept description. This ID is not part of the data specification template. Instead the id as inherited via IIdentifiable is used. Same holds for administrative information like the version and revision.

Note: idShort and shortName are very similar. However, in this case the decision was to add shortName explicitly to the data specification. Same holds for displayName and preferredName. Same holds for description and definition.

Constraint AASc-3a-010: If value is not empty then valueList shall be empty and vice versa.

Note: It is also possible that both value and valueList are empty. This is the case for concept descriptions that define the semantics of a property but do not have an enumeration (valueList) as data type.

Note: Although it is possible to define a ConceptDescription for a :attr:´value_list`, it is not possible to reuse this {@link DataSpecificationIec61360.valueList}. It is only possible to directly add a {@link DataSpecificationIec61360.valueList} as data type to a specific semantic definition of a property.

Constraint AASc-3a-009: If dataType one of: IntegerMeasure, RealMeasure, RationalMeasure, IntegerCurrency, RealCurrency, then unit or unitId shall be defined.

Hierarchy

Class
- DataSpecificationIec61360

Implements

IDataSpecificationContent

Index

Constructors

constructor

new DataSpecificationIec61360(preferredName: LangStringPreferredNameTypeIec61360[], shortName?: LangStringShortNameTypeIec61360[], unit?: string, unitId?: Reference, sourceOfDefinition?: string, symbol?: string, dataType?: DataTypeIec61360, definition?: LangStringDefinitionTypeIec61360[], valueFormat?: string, valueList?: ValueList, value?: string, levelType?: LevelType): DataSpecificationIec61360
Parameters
- preferredName: LangStringPreferredNameTypeIec61360[]
- shortName: LangStringShortNameTypeIec61360[] = null
- unit: string = null
- unitId: Reference = null
- sourceOfDefinition: string = null
- symbol: string = null
- dataType: DataTypeIec61360 = null
- definition: LangStringDefinitionTypeIec61360[] = null
- valueFormat: string = null
- valueList: ValueList = null
- value: string = null
- levelType: LevelType = null
Returns DataSpecificationIec61360
Overrides Class.constructor
- Defined in types.ts:11021

Properties

dataType

dataType: DataTypeIec61360

Data Type

definition

definition: LangStringDefinitionTypeIec61360[]

Definition in different languages

levelType

levelType: LevelType

Set of levels.

preferredName

preferredName: LangStringPreferredNameTypeIec61360[]

Preferred name

Remarks

Note: It is advised to keep the length of the name limited to 35 characters.

Constraint AASc-3a-002: preferredName shall be provided at least in English.

shortName

shortName: LangStringShortNameTypeIec61360[]

Short name

sourceOfDefinition

sourceOfDefinition: string

Source of definition

symbol

symbol: string

Symbol

unit

unit: string

Unit

unitId

unitId: Reference

Unique unit id

Remarks

unit and unitId need to be consistent if both attributes are set

Note: It is recommended to use an external reference ID.

value

value: string

Value

valueFormat

valueFormat: string

Value Format

Remarks

Note: The value format is based on ISO 13584-42 and IEC 61360-2.

valueList

valueList: ValueList

List of allowed values

Methods

accept

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

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

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

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

descend

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

Returns
Iterator over the referenced instances

Returns IterableIterator<Class>
Implementation of IDataSpecificationContent.descend

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

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

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

modelType

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

Returns ModelType
Implementation of IDataSpecificationContent.modelType

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

overDefinitionOrEmpty

overDefinitionOrEmpty(): IterableIterator<LangStringDefinitionTypeIec61360>
Yield from definition if it is set, or yield nothing.

Returns IterableIterator<LangStringDefinitionTypeIec61360>
- Defined in types.ts:10886

overShortNameOrEmpty

overShortNameOrEmpty(): IterableIterator<LangStringShortNameTypeIec61360>
Yield from shortName if it is set, or yield nothing.

Returns IterableIterator<LangStringShortNameTypeIec61360>
- Defined in types.ts:10876

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

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

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

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

Class DataSpecificationIec61360

Remarks

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

preferredName: LangStringPreferredNameTypeIec61360[]

shortName: LangStringShortNameTypeIec61360[] = null

unit: string = null

unitId: Reference = null

sourceOfDefinition: string = null

symbol: string = null

dataType: DataTypeIec61360 = null

definition: LangStringDefinitionTypeIec61360[] = null

valueFormat: string = null

valueList: ValueList = null

value: string = null

levelType: LevelType = null

Returns DataSpecificationIec61360

Properties

dataType

definition

levelType

preferredName

Remarks

shortName

sourceOfDefinition

symbol

unit

unitId

Remarks

value

valueFormat

Remarks

valueList

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

overDefinitionOrEmpty

Returns IterableIterator<LangStringDefinitionTypeIec61360>

overShortNameOrEmpty

Returns IterableIterator<LangStringShortNameTypeIec61360>

transform

Returns

Param Type

Type Parameters

T

Parameters

transformer: AbstractTransformer<T>

Returns T

transformWithContext

Returns

Param Type

Param Type

Type Parameters

ContextT

T

Parameters