Quantity Class

Мeasure-safe immutable quantity with measurement unit. Allows measurement unit safe calculations.

Inheritance Hierarchy

SystemObject
Aloe.EnterpriseOne.ModelQuantity

Namespace: Aloe.EnterpriseOne.Model
Assembly: Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5

Syntax

C++

Copy

public class Quantity : IComparable, IComparable<Quantity>, 
	IEquatable<Quantity>, IValueWithMeasure<MeasurementUnit>

Public Class Quantity
	Implements IComparable, IComparable(Of Quantity), 
	IEquatable(Of Quantity), IValueWithMeasure(Of MeasurementUnit)

public ref class Quantity : IComparable, 
	IComparable<Quantity^>, IEquatable<Quantity^>, IValueWithMeasure<MeasurementUnit^>

type Quantity =  
    class
        interface IComparable
        interface IComparable<Quantity>
        interface IEquatable<Quantity>
        interface IValueWithMeasure<MeasurementUnit>
    end

The Quantity type exposes the following members.

Constructors

	Name	Description
	Quantity	Initializes a new instance of the Quantity class.

Top

Properties

	Name	Description
	Unit	Gets the measurement unit of the quantity.
	Value	Gets the value of the quantity.

Top

Methods

	Name	Description
	Add	Returns the sum of the specified quantities. The quantities must have the same Unit.
	AreCompatible	Returns true if the two quantities are compatible (e.g. have the same unit).
	Compare	Compares the quantities. The quantities must have the same unit.
	CompareTo(Object)	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
	CompareTo(Quantity)	Compares the current object with another object of the same type.
	Divide	Divides the specified quantities. The operation is successful only if both quantities have the same measurement unit.
	Equals(Object)	Determines whether the specified Object, is equal to this instance. (Overrides ObjectEquals(Object).)
	Equals(Quantity)	Indicates whether the current object is equal to another object of the same type.
	GetHashCode	Returns a hash code for this instance. (Overrides ObjectGetHashCode.)
	Multiply	Multiplies the specified quantity with the specified multiplier.
	Subtract	Subtracts the second quantity from the first. The quantities must have the same Unit.
	ToString	Returns a String that represents this instance. (Overrides ObjectToString.)
	ToString(CultureInfo)	Returns a String that represents this instance.

Top

Operators

	Name	Description
	Addition	Returns the sum of quantity a and b, which must have the same measurement unit
	Division	Implements the operator /.
	Equality	Implements the operator ==.
	GreaterThan	Compares first and second.
	GreaterThanOrEqual	Implements the operator >=.
	Inequality	Implements the operator !=.
	LessThan	Implements the operator <.
	LessThanOrEqual	Implements the operator <=.
	Multiply(Decimal, Quantity)	Implements the operator *.
	Multiply(Quantity, Decimal)	Implements the operator *.
	Subtraction	Subtracts the second quantity from the first. The quantities must have the same Unit.

Top

Extension Methods

	Name	Description
	Round	Rounds the quantity as per the precision, supported by the system (0.001). (Defined by QuantityExtensions.)

Top

Remarks

Quantity supports basic quantity arithmetic, which is measure-safe. For example, adding two quantities is measure-safe, because the two quantities are added successfully only if their measurement units are compatible. This helps avoid errors of inadvertently doing quantity arithmetic with incompatible measurement units.

The following basic rules are true for Quantity:

Quantity(15, Pcs) + Quantity(10, Pcs) == Quantity(25, Pcs)
Quantity(15, Pcs) + Quantity(10, Kg) => Exception!
Quantity(15, Pcs) + Quantity(10, null) => Exception!
Quantity(15, Pcs) + Quantity(0, null) == Quantity(15, Pcs)
Quantity(15, Pcs) + Quantity(0, Kg) == Quantity(15, Pcs)
Quantity(15, Pcs) + null == Quantity(15, Pcs)
Quantity(15, Pcs) * 3 == Quantity(45, Pcs)
Quantity(15, Pcs) > Quantity(10, Pcs) == true
Quantity(15, Pcs) > Quantity(0, Kg) == true
Quantity(15, Pcs) > Quantity(10, Kg) => Exception!
Quantity(15, Pcs) > null == true

Reference

Aloe.EnterpriseOne.Model Namespace