Quantity Types: Difference between revisions

From Resonite Wiki
Visual
Created page quantity types
 
change base to default. default unit, base value.
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
To work with various quantities, Resonite provides a generic quantity system, which allows converting between various units for a given quantity type. An example of this is converting a <code>Distance</code> quantity value between metric and imperial units. There are various quantity types available, which can be used with all generic quantity nodes and components. Each quantity type has a base unit, which can be used to create a quantity value, which can then be converted between all known units of the given quantity type.
To work with various quantities, [[Resonite]] provides a generic quantity system, which allows converting between various units for a given quantity type. An example of this is converting a <code>Distance</code> quantity value between metric and imperial units. There are various quantity types available, which can be used with all generic quantity nodes and components. Each quantity type has default unit, which can be used to create a quantity value, which can then be converted between all known units of the given quantity type.


== Technical ==
== Technical ==
The quantity system is part of the <code>Elements.Quantity</code> assembly. Every quantity type is a class implementing <code>IQuantity</code> and <code><nowiki>IQuantity<T></nowiki></code> interfaces.
The quantity system is part of the <code>Elements.Quantity</code> assembly. Every quantity type is a <code>struct</code> that implements either an <code><nowiki>IQuantity<T></nowiki></code> or <code><nowiki>IQuantitySI<T></nowiki></code> [[Interface Type|interface]].
 


== Quantity Types ==
== Quantity Types ==
Line 9: Line 8:
|+ List of Quantity types
|+ List of Quantity types
|-
|-
! Quantity Type !! Base Unit
! Quantity Type !! Default Unit
|-
|-
| Acceleration || m/s²
| [[Type:Acceleration|Acceleration]] || m/s²
|-
|-
| Angle || radian
| [[Type:Angle|Angle]] || radian
|-
|-
| Current || ampere
| [[Type:Current|Current]] || ampere
|-
|-
| Distance || meter
| [[Type:Distance|Distance]] || meter
|-
|-
| Mass || gram
| [[Type:Mass|Mass]] || gram
|-
|-
| Ratio || (no unit)
| [[Type:Ratio|Ratio]] || ''(no unit)''
|-
|-
| Resistance || ohm
| [[Type:Resistance|Resistance]] || ohm
|-
|-
| Temperature || Kelvin
| [[Type:Temperature|Temperature]] || Kelvin
|-
|-
| Time || Second
| [[Type:Time|Time]] || Second
|-
|-
| Velocity || m/s
| [[Type:Velocity|Velocity]] || m/s
|-
|-
| Voltage || volt
| [[Type:Voltage|Voltage]] || volt
|}
|}


Line 40: Line 39:
! Component !! Description
! Component !! Description
|-
|-
| [[ Component:DataFeedQuantityField´2 | <nowiki>DataFeedQuantityField<Q,T></nowiki> ]] || A quantity field for use with the [[Data Feed]] system
| [[Component:FeedQuantityFieldInterface`2| <nowiki>FeedQuantityFieldInterface<Q,T></nowiki> ]] || A quantity field interface for use with the [[Data Feed]] system
|-
|-
| [[ Component:FeedQuantityFieldInterface´2 | <nowiki>FeedQuantityFieldInterface<Q,T></nowiki> ]] || A quantity field interface for use with the [[Data Feed]] system
| [[Component:QuantityTextEditorParser`2| <nowiki>QuantityTextEditorParser<U,T></nowiki> ]] || Text editor for parsing and converting a Quantity value from text input
|-
|-
| [[ Component:QuantityTextEditorParser´2 | <nowiki>QuantityTextEditorParser<U,T></nowiki> ]] || Text editor for parsing and converting a Quantity value from text input
| [[Component:QuantityTextEditorParser`1| <nowiki>QuantityTextEditorParser<U></nowiki> ]] || Text editor for parsing a Quantity value from text input
|-
|-
| [[ Component:QuantityTextEditorParser´1 | <nowiki>QuantityTextEditorParser<U></nowiki> ]] || Text editor for parsing a Quantity value from text input
| [[Component:QuantityTextFormatDriver`1| <nowiki>QuantityTextFormatDriver<U></nowiki>]] || Drives a formatted text form a Quantity value
|-
| [[ Component:QuantityTextFormatDriver´1 | <nowiki>QuantityTextFormatDriver<U></nowiki> ]] || Drives a formatted text form a Quantity value
|}
|}


== Quantity ProtoFlux Nodes ==
== Quantity ProtoFlux Nodes ==
{| class="wikitable" style="margin:left"
{| class="wikitable" style="margin:left"
|+ List of components with generic quantity type parameters
|+ List of ProtoFlux nodes with generic quantity type parameters
|-
|-
! Component !! Description
! ProtoFlux Node !! Description
|-
|-
| [[ ProtoFlux:BaseValue´1 | <nowiki>BaseValue<U></nowiki> ]] || Returns the base value of a quantity
| [[ProtoFlux:Base Value| <nowiki>BaseValue<U></nowiki> ]] || Returns the base value of a quantity
|-
|-
| [[ ProtoFlux:FormatQuantity´1 | <nowiki>FormatQuantity<U></nowiki> ]] || Formats a quantity string
| [[ProtoFlux:Format Quantity| <nowiki>FormatQuantity<U></nowiki> ]] || Formats a quantity string
|-
|-
| [[ ProtoFlux:FromBaseValue´1 | <nowiki>FromBaseValue<U></nowiki> ]] || Creates a quantity from the quantity type's base value
| [[ProtoFlux:From Base Value| <nowiki>FromBaseValue<U></nowiki> ]] || Creates a quantity from the quantity type's base value
|-
|-
| [[ ProtoFlux:ParseQuantity´1 | <nowiki>ParseQuantity<U></nowiki> ]] || Parses a quantity string
| [[ProtoFlux:Parse Quantity| <nowiki>ParseQuantity<U></nowiki> ]] || Parses a quantity string
|}
|}
== Deprecated ==
The quantity interface before the [[Beta_2024.7.11.1293|type update]] was referenced as <code>QuantityX</code>.

Latest revision as of 19:36, 22 February 2025

To work with various quantities, Resonite provides a generic quantity system, which allows converting between various units for a given quantity type. An example of this is converting a Distance quantity value between metric and imperial units. There are various quantity types available, which can be used with all generic quantity nodes and components. Each quantity type has default unit, which can be used to create a quantity value, which can then be converted between all known units of the given quantity type.

Technical

The quantity system is part of the Elements.Quantity assembly. Every quantity type is a struct that implements either an IQuantity<T> or IQuantitySI<T> interface.

Quantity Types

List of Quantity types
Quantity Type Default Unit
Acceleration m/s²
Angle radian
Current ampere
Distance meter
Mass gram
Ratio (no unit)
Resistance ohm
Temperature Kelvin
Time Second
Velocity m/s
Voltage volt

Quantity Components

List of components with generic quantity type parameters
Component Description
FeedQuantityFieldInterface<Q,T> A quantity field interface for use with the Data Feed system
QuantityTextEditorParser<U,T> Text editor for parsing and converting a Quantity value from text input
QuantityTextEditorParser<U> Text editor for parsing a Quantity value from text input
QuantityTextFormatDriver<U> Drives a formatted text form a Quantity value

Quantity ProtoFlux Nodes

List of ProtoFlux nodes with generic quantity type parameters
ProtoFlux Node Description
BaseValue<U> Returns the base value of a quantity
FormatQuantity<U> Formats a quantity string
FromBaseValue<U> Creates a quantity from the quantity type's base value
ParseQuantity<U> Parses a quantity string

Deprecated

The quantity interface before the type update was referenced as QuantityX.

Retrieved from "https://wiki.resonite.com/index.php?title=Quantity_Types&oldid=96634"
Last modified
This page was last edited on 22 February 2025, at 19:36.