Difference between revisions of "Extensions.Quantities.Multiplication"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:'''Multiplication '''}}[[Category:Quantities]]
 
{{DISPLAYTITLE:'''Multiplication '''}}[[Category:Quantities]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | Multiplication | Multiplication of all numerical quantities | [[Operations]] | [[Extensions.Quantities|OTX Quantities extension]] | [[Overloading semantics]] | [[Core.Actions.Throw.Exception.InvalidConversionException|InvalidConversionException]] | - }}
+
{{ClassificationActivity | Multiplication | Multiplication of all numerical quantities | [[Operations]] | [[Extensions.Quantities|OTX Quantities extension]] | [[Extensions.Quantities#Terms|Overloading semantics]] | [[Extensions.Quantities.InvalidConversionException|InvalidConversionException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
This is a term wwhich returns as a result of the product of all numerical quantities (NumericQuantity) in accordance with their units.  
+
This is a term which returns as a result of the product of all numerical quantities (NumericQuantity) in accordance with their units.
 +
 
 +
* When '''Quantity''' values are multiplied or divided, a definition of the physical dimension of the resulting '''Quantity''' has to exist in the UNIT-SPEC available to the OTX system.
 +
 
 +
* Scalar operands shall be interpreted "as is"; this allows e.g. the multiplication of 2 * 2 km which will result in a '''Quantity''' of 4000 m.
 +
 
 +
* The display unit of the resulting '''Quantity''' should be set to the SI base unit corresponding to the physical dimension resulting from the operation. Furthermore, the display precision of the resulting '''Quantity''' shall be the maximum of the display precisions of the operands.
  
 
{{TermReturnValue| [[Extensions.Quantities.Quantity|Quantity]] | Product of two or more numeric quantity (NumericQuantity)}}
 
{{TermReturnValue| [[Extensions.Quantities.Quantity|Quantity]] | Product of two or more numeric quantity (NumericQuantity)}}
Line 17: Line 23:
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertie1| QuantityTerm1 | [[Extensions.Quantities.Quantity|Quantity]] | [[Term]] | - | [1] | NumericQuantity operand, which should be multiplied}}
 
{{TableRowPropertie1| QuantityTerm1 | [[Extensions.Quantities.Quantity|Quantity]] | [[Term]] | - | [1] | NumericQuantity operand, which should be multiplied}}
{{TableRowPropertie1| QuantityTerm2 | [[Extensions.Quantities.Quantity|Quantity]] | [[Term]] | - | [1] | NumericQuantity operand, which should be multiplied}}
+
{{TableRowPropertie1| QuantityTerm2 | [[Extensions.Quantities.Quantity|Quantity]]/[[Numeric]] | [[Term]] | - | [1] | NumericQuantity/Numeric operand, which should be multiplied}}
 
|}
 
|}
  
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Quantities.Quantity Quantity1;
+
Quantities.Quantity Quantity;
 +
 
 +
/// Flow
  
Quantity1 = 1 [@Unit, "ODX_RS_UNIT_LIB.odx", "km"] * 500 [@Unit, "ODX_RS_UNIT_LIB.odx", "m"];
+
Quantity = 2 * 2 [@Unit, "BL_DataLibraMIB.odx", "km", 2];
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
[[Extensions.Quantities.Addition|Addition]] <br/>
+
[[Extensions.Quantities.Addition|Addition]] <br/>  
 
[[Extensions.Quantities.Subtraction|Subtraction]] <br/>
 
[[Extensions.Quantities.Subtraction|Subtraction]] <br/>
[[Extensions.Quantities.Division|Division]]
+
<!--[[Extensions.Quantities.Multiplication|Multiplication]] <br/>-->
 +
[[Extensions.Quantities.Division|Division]]<br/>
 +
[[Extensions.Quantities.Modulo|Modulo]]<br/>
 +
[[Extensions.Quantities.AbsoluteValue|Absolute Value]]<br/>
 +
[[Extensions.Quantities.Negation|Negation]]<br/>

Revision as of 07:47, 2 October 2018

Classification

Name Multiplication
Short Description Multiplication of all numerical quantities
Class Operations
Extension OTX Quantities extension
Group Overloading semantics
Exceptions InvalidConversionException
Checker Rules -
Standard Compliant Yes

OTL Syntax

QuantityTerm = QuantityTerm1 * QuantityTerm2 * ...;

Description

This is a term which returns as a result of the product of all numerical quantities (NumericQuantity) in accordance with their units.

  • When Quantity values are multiplied or divided, a definition of the physical dimension of the resulting Quantity has to exist in the UNIT-SPEC available to the OTX system.
  • Scalar operands shall be interpreted "as is"; this allows e.g. the multiplication of 2 * 2 km which will result in a Quantity of 4000 m.
  • The display unit of the resulting Quantity should be set to the SI base unit corresponding to the physical dimension resulting from the operation. Furthermore, the display precision of the resulting Quantity shall be the maximum of the display precisions of the operands.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Quantity Product of two or more numeric quantity (NumericQuantity)

Properties

Name Data Type Class Default Cardinality Description
QuantityTerm1 Quantity Term - [1] NumericQuantity operand, which should be multiplied
QuantityTerm2 Quantity/Numeric Term - [1] NumericQuantity/Numeric operand, which should be multiplied

OTL Examples

Quantities.Quantity Quantity;

/// Flow

Quantity = 2 * 2 [@Unit, "BL_DataLibraMIB.odx", "km", 2];

See also

Addition
Subtraction
Division
Modulo
Absolute Value
Negation