D-SI Update quantityType (100%)

changed due date to December 31, 2022

changed milestone to %D-SI-XSD-v2.2.0

assigned to @Wafa.El.Jaoua

changed title from D-SI Update quanityType to D-SI Update quantityType

added Doing label

Suggestion for generalizing definition of quantity type

Introduction of a new element si:quantityType to the D-SI metadata model that can provide information about the kind of quantity/measurement (such as length, mass, temperature, pressure, speed, etc…).
Insert in SI_Format.xsd:
- local: si:quantityType as an optional element in si:realInListType.
- global: si:listQuantityType as an optional element in si:realList.
A new file with test examples for si:quantityType such as 2022-05-23-PLATINUM-examples.xml has been added to each folder examples (PLATINUM, GOLD, BRONZE, SILVER).
New examples of quantity type with IDs PTB700, PTB701... added to Example-Meta.md.

closed

Examples extended:

real atomic with si:quantityType element:

<si:real>
  <si:quantityType>length</si:quantityType>                            
  <si:value>1.0</si:value>
  <si:unit>\metre</si:unit>
 </si:real>

local in si:realList with quantityType element:

<si:realList>
  <si:real>
     <si:quantityType>luminous intensity</si:quantityType>
     <si:value>1.0</si:value>
     <si:unit>\candela</si:unit>
  </si:real>
  <si:real>
     <si:quantityType>luminous intensity</si:quantityType>
     <si:value>1.0</si:value>
     <si:unit>\candela</si:unit>
  </si:real>
</si:realList>

global in si:realList with listQuantityType element:

<si:realList>
  <si:listQuantityType>luminous intensity</si:listQuantityType>
  <si:listUnit>\candela</si:listUnit>
  <si:real>
     <si:value>1.0</si:value>
  </si:real>
  <si:real>
     <si:value>1.0</si:value>
  </si:real>
</si:realList>

reopened

constant with si:quantityType element:

<si:constant>
   <si:label>speed of light in vacuum</si:label>
   <si:quantityType>speed</si:quantityType>                                                           
   <si:value>299792458.0</si:value>
   <si:unit>\metre\second\tothe{-1}</si:unit>
   <si:uncertainty>0</si:uncertainty>
</si:constant>

closed

complex atomic with si:quantityType element:

<si:complex>
   <si:quantityType>length</si:quantityType>
   <si:valueReal>-12.592</si:valueReal>
   <si:valueImag>7.015</si:valueImag>
   <si:unit>\metre</si:unit>
</si:complex>

local in si:complexList with quantityType

<si:complexList>
   <si:complex>
      <si:quantityType>electric current</si:quantityType>                           
      <si:valueReal>-10.310</si:valueReal>
      <si:valueImag>5.010</si:valueImag>
      <si:unit>\ampere</si:unit>
   </si:complex>
   <si:complex>
      <si:quantityType>electric current</si:quantityType>
      <si:valueReal>1.0</si:valueReal>
      <si:valueImag>-2.0</si:valueImag>
      <si:unit>\ampere</si:unit>
   </si:complex>
</si:complexList>

global in si:complexList with listQuantityType

<si:complexList>
   <si:listQuantityType>electric current</si:listQuantityType>               
   <si:listUnit>\ampere</si:listUnit>
   <si:listUnitPhase>\metre\metre\tothe{-1}</si:listUnitPhase>
   <si:complex>
      <si:valueMagnitude>3.0</si:valueMagnitude>
      <si:valuePhase>20.0</si:valuePhase>
   </si:complex>
   <si:complex>
      <si:valueMagnitude>-1.0</si:valueMagnitude>
      <si:valuePhase>35.0</si:valuePhase>
   </si:complex>
</si:complexList>

reopened

This requirement is a must. There is need for standard quantityKind field in the DSI. The last example about "electric charge" should be defined with units "\ampere \second" or as "electric current" with units "\ampere". So, by standard quantiytKind or quantityType I refere to a dictionary of valid values, for example: \electricCurrent, \electricCharge, \length, \mass, \time, etc. In this sense there are several ontologies or taxonomies that can be reused.

@hgasca thank you for comment and clarifying

mentioned in issue #37 (closed)

changed due date to March 31, 2023

removed Doing label

added Priority: High Product Backlog Version 2.2.0-Beta labels

added Status: In Progress label and removed Product Backlog label

##Additional design ideas:

Having unique (meta)data types associated to each element in XML is essential for better semantic linking and interoperation in the future.

When "gluing" the D-SI to some dictionary such as an ontology, it would be beneficial to allow a clear type identification.

This may be done for example by changing

<xs:element name="quantityType" type="xs:string"/>

to

<xs:element name="quantityType" type="qudt:quanityKind"/>
... xmlns:qudt="http://qudt.org/vocab/" ...

And a file included defining qudt in XML: https://ptb.de/si/v2.2.0/qudt/quantityKind.xsd

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema version="1.0.0" xmlns:xs="http://www.w3.org/2001/XMLSchema"
    targetNamespace="http://qudt.org/vocab/"
    xmlns:qudt="https://qudt.org/vocab/"
    elementFormDefault="qualified">

  <xs:simpleType name="quantityKind">
    <xs:restriction base="xs:string"/>
  </xs:simpleType>

</xs:schema>

In addition (or as an alternative), the element name for the quantityType may provide information on the vocabulary for types of quantities:

<xs:element name="quantityTypeQUDT" type="qudt:quantityKind"/>
<si:quantityTypeQUDT>length</si:quantityTypeQUDT>

This appraoch is beneficial in respect to adding later other vocabularies.

Remarks:

Adding an attribute to provide the vocabulary is of disadvantage, as attributes are not available in JSON and many other formats. This would thus limit the useability of the D-SI outside XML.
Defining an XML element for each quantity type entity is not considered, as such a list would require permanent updating of the D-SI XML scheme compared to a generic element.

changed title from D-SI Update quantityType to D-SI Update quantityType (100%)

added Status: Review Needed label and removed Status: In Progress label

Updates after meeting on 21 March:

implementing semantic version based on qudt:quantitykind and with extendable naming si:quantityTypeQUDT
looking for implementation appraoch where later on other listings of quantity types (e.g., from IEC/ISO) could also be added with a clear semantic link.

Implementation

Define placeholder element for all quantity types

<xs:element name="quantityType" type="xs:string" abstract="true">
  <xs:annotation>
    <xs:documentation xml:lang="en">
       Definition of placeholder element for providing different quantity types.
    </xs:documentation>
  </xs:annotation>
</xs:element>

Define QUDT type element with semantik link

<xs:element name="quantityTypeQUDT" substitutionGroup="si:quantityType" type="qudt:quantityKind">
  <xs:annotation>
    <xs:documentation xml:lang="en">
      Definition of a quantity element that links to the QUDT 
      ontology IDs for qauntities.
    </xs:documentation>
  </xs:annotation>
</xs:element>

.. qudt/quantityKind.xsd

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema version="1.0.0" xmlns:xs="http://www.w3.org/2001/XMLSchema"
    targetNamespace="http://qudt.org/vocab/"
    xmlns:qudt="http://qudt.org/vocab/"
    elementFormDefault="qualified">

  <xs:simpleType name="quantityKind">
    <xs:restriction base="xs:string"/>
  </xs:simpleType>

</xs:schema>

Integration in si:real, si:complex by placeholder element

<xs:complexType name="realQuantityType">
        <xs:sequence>
            <!-- optional label and quantity type-->
            <xs:element name="label" type="xs:string" minOccurs="0"/>

            <xs:element ref="si:quantityType" minOccurs="0"/>
            
            <!-- mandatory information -->
            <xs:element name="value" type="si:decimalType"/>
            <xs:element name="unit"  type="si:unitType"/>
         ...

This allows to write data like

<si:real>
  <si:quantityTypeQUDT>length</si:quantityTypeQUDT>                            
  <si:value>1.0</si:value>
  <si:unit>\metre</si:unit>
</si:real>

added Status: Completed label and removed Status: Review Needed label

removed Status: Completed label

removed Priority: High label

closed

D-SI Update quantityType (100%)

Designs

Child items 0

Activity