Extensions.Quantities.Modulo

From emotive
Jump to navigation Jump to search

Classification

Name Modulo
Short Description Division two numeric quantities
Class Operations
Extension OTX Quantities extension
Group Overloading semantics
Exceptions InvalidConversionException
Checker Rules -
Standard Compliant Yes

OTL Syntax

QuantityVariable = QuantityTerm % NumericTerm;
QuantityVariable = NumericTerm % QuantityTerm;

Description

This is a term which returns the remainder of a Division two numeric quanity (NumericQuantity) in accordance with their units.

  • When Quantity values are divided with Modulo, 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 km % 3 which will result in a Quantity of 2 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 the remainder of a Division two numeric quanity (NumericQuantity)

Properties

Name Data Type Class Default Cardinality Description
QuantityTerm Quantity Term - [1..*] Quantity values are divided
NumericTerm Numeric Term - [0..*] Numeric values are divided

OTL Examples

/// Local Declarations

Quantities.Quantity Quantity;

/// Flow

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

See also

Addition
Subtraction
Multiplication
Division
Absolute Value
Negation