Interface IDataSpecificationIec61360

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

Inherited Members

IClass.DescendOnce()

IClass.Descend()

IClass.Accept(Visitation.IVisitor)

IClass.Accept<TContext>(Visitation.IVisitorWithContext<TContext>, TContext)

IClass.Transform<T>(Visitation.ITransformer<T>)

IClass.Transform<TContext, T>(Visitation.ITransformerWithContext<TContext, T>, TContext)

Namespace: AasCore.Aas3_0

Assembly: AasCore.Aas3_0.dll

Syntax

public interface IDataSpecificationIec61360 : IDataSpecificationContent, IClass

Remarks

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.

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.

Constraints:

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

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.

Although it is possible to define a ConceptDescription for a :attr:´value_list`, it is not possible to reuse this ValueList. It is only possible to directly add a 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.

Properties

| Improve this Doc View Source

DataType

Data Type

Declaration

DataTypeIec61360? DataType { get; set; }

Property Value

Type	Description
System.Nullable<DataTypeIec61360>

| Improve this Doc View Source

Definition

Definition in different languages

Declaration

List<ILangStringDefinitionTypeIec61360> Definition { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ILangStringDefinitionTypeIec61360>

| Improve this Doc View Source

LevelType

Set of levels.

Declaration

ILevelType LevelType { get; set; }

Property Value

Type	Description
ILevelType

| Improve this Doc View Source

PreferredName

Preferred name

Declaration

List<ILangStringPreferredNameTypeIec61360> PreferredName { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ILangStringPreferredNameTypeIec61360>

Remarks

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

Constraints:

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

| Improve this Doc View Source

ShortName

Short name

Declaration

List<ILangStringShortNameTypeIec61360> ShortName { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ILangStringShortNameTypeIec61360>

| Improve this Doc View Source

SourceOfDefinition

Source of definition

Declaration

string SourceOfDefinition { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Symbol

Declaration

string Symbol { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Unit

Declaration

string Unit { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

UnitId

Unique unit id

Declaration

IReference UnitId { get; set; }

Property Value

Type	Description
IReference

Remarks

Unit and UnitId need to be consistent if both attributes are set

It is recommended to use an external reference ID.

| Improve this Doc View Source

Value

Declaration

string Value { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ValueFormat

Value Format

Declaration

string ValueFormat { get; set; }

Property Value

Type	Description
System.String

Remarks

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

| Improve this Doc View Source

ValueList

List of allowed values

Declaration

IValueList ValueList { get; set; }

Property Value

Type	Description
IValueList

Methods

| Improve this Doc View Source

OverDefinitionOrEmpty()

Iterate over Definition, if set, and otherwise return an empty enumerable.

Declaration

IEnumerable<ILangStringDefinitionTypeIec61360> OverDefinitionOrEmpty()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ILangStringDefinitionTypeIec61360>

| Improve this Doc View Source

OverShortNameOrEmpty()

Iterate over ShortName, if set, and otherwise return an empty enumerable.

Declaration

IEnumerable<ILangStringShortNameTypeIec61360> OverShortNameOrEmpty()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ILangStringShortNameTypeIec61360>