unitsnet-js
Version:
A better way to hold unit variables and easily convert to the destination unit
315 lines (314 loc) • 15 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.TemperatureGradient = exports.TemperatureGradientUnits = void 0;
const base_unit_1 = require("../base-unit");
/** TemperatureGradientUnits enumeration */
var TemperatureGradientUnits;
(function (TemperatureGradientUnits) {
/** */
TemperatureGradientUnits["KelvinsPerMeter"] = "KelvinPerMeter";
/** */
TemperatureGradientUnits["DegreesCelsiusPerMeter"] = "DegreeCelsiusPerMeter";
/** */
TemperatureGradientUnits["DegreesFahrenheitPerFoot"] = "DegreeFahrenheitPerFoot";
/** */
TemperatureGradientUnits["DegreesCelsiusPerKilometer"] = "DegreeCelsiusPerKilometer";
})(TemperatureGradientUnits = exports.TemperatureGradientUnits || (exports.TemperatureGradientUnits = {}));
/** The rate of change of temperature with displacement in a given direction (as with increase of height) */
class TemperatureGradient extends base_unit_1.BaseUnit {
/**
* Create a new TemperatureGradient.
* @param value The value.
* @param fromUnit The ‘TemperatureGradient’ unit to create from.
* The default unit is KelvinsPerMeter
*/
constructor(value, fromUnit = TemperatureGradientUnits.KelvinsPerMeter) {
super();
this.kelvinspermeterLazy = null;
this.degreescelsiuspermeterLazy = null;
this.degreesfahrenheitperfootLazy = null;
this.degreescelsiusperkilometerLazy = null;
if (value === undefined || value === null || Number.isNaN(value)) {
throw new TypeError('invalid unit value ‘' + value + '’');
}
this.value = this.convertToBase(value, fromUnit);
}
/**
* The base value of TemperatureGradient is KelvinsPerMeter.
* This accessor used when needs a value for calculations and it's better to use directly the base value
*/
get BaseValue() {
return this.value;
}
/** Gets the default unit used when creating instances of the unit or its DTO */
get baseUnit() {
return TemperatureGradientUnits.KelvinsPerMeter;
}
/** */
get KelvinsPerMeter() {
if (this.kelvinspermeterLazy !== null) {
return this.kelvinspermeterLazy;
}
return this.kelvinspermeterLazy = this.convertFromBase(TemperatureGradientUnits.KelvinsPerMeter);
}
/** */
get DegreesCelsiusPerMeter() {
if (this.degreescelsiuspermeterLazy !== null) {
return this.degreescelsiuspermeterLazy;
}
return this.degreescelsiuspermeterLazy = this.convertFromBase(TemperatureGradientUnits.DegreesCelsiusPerMeter);
}
/** */
get DegreesFahrenheitPerFoot() {
if (this.degreesfahrenheitperfootLazy !== null) {
return this.degreesfahrenheitperfootLazy;
}
return this.degreesfahrenheitperfootLazy = this.convertFromBase(TemperatureGradientUnits.DegreesFahrenheitPerFoot);
}
/** */
get DegreesCelsiusPerKilometer() {
if (this.degreescelsiusperkilometerLazy !== null) {
return this.degreescelsiusperkilometerLazy;
}
return this.degreescelsiusperkilometerLazy = this.convertFromBase(TemperatureGradientUnits.DegreesCelsiusPerKilometer);
}
/**
* Create a new TemperatureGradient instance from a KelvinsPerMeter
*
* @param value The unit as KelvinsPerMeter to create a new TemperatureGradient from.
* @returns The new TemperatureGradient instance.
*/
static FromKelvinsPerMeter(value) {
return new TemperatureGradient(value, TemperatureGradientUnits.KelvinsPerMeter);
}
/**
* Create a new TemperatureGradient instance from a DegreesCelsiusPerMeter
*
* @param value The unit as DegreesCelsiusPerMeter to create a new TemperatureGradient from.
* @returns The new TemperatureGradient instance.
*/
static FromDegreesCelsiusPerMeter(value) {
return new TemperatureGradient(value, TemperatureGradientUnits.DegreesCelsiusPerMeter);
}
/**
* Create a new TemperatureGradient instance from a DegreesFahrenheitPerFoot
*
* @param value The unit as DegreesFahrenheitPerFoot to create a new TemperatureGradient from.
* @returns The new TemperatureGradient instance.
*/
static FromDegreesFahrenheitPerFoot(value) {
return new TemperatureGradient(value, TemperatureGradientUnits.DegreesFahrenheitPerFoot);
}
/**
* Create a new TemperatureGradient instance from a DegreesCelsiusPerKilometer
*
* @param value The unit as DegreesCelsiusPerKilometer to create a new TemperatureGradient from.
* @returns The new TemperatureGradient instance.
*/
static FromDegreesCelsiusPerKilometer(value) {
return new TemperatureGradient(value, TemperatureGradientUnits.DegreesCelsiusPerKilometer);
}
/**
* Gets the base unit enumeration associated with TemperatureGradient
* @returns The unit enumeration that can be used to interact with this type
*/
static getUnitEnum() {
return TemperatureGradientUnits;
}
/**
* Gets the default unit used when creating instances of the unit or its DTO
* @returns The unit enumeration value used as a default parameter in constructor and DTO methods
*/
static getBaseUnit() {
return TemperatureGradientUnits.KelvinsPerMeter;
}
/**
* Create API DTO represent a TemperatureGradient unit.
* @param holdInUnit The specific TemperatureGradient unit to be used in the unit representation at the DTO
*/
toDto(holdInUnit = TemperatureGradientUnits.KelvinsPerMeter) {
return {
value: this.convert(holdInUnit),
unit: holdInUnit
};
}
/**
* Create a TemperatureGradient unit from an API DTO representation.
* @param dtoTemperatureGradient The TemperatureGradient API DTO representation
*/
static FromDto(dtoTemperatureGradient) {
return new TemperatureGradient(dtoTemperatureGradient.value, dtoTemperatureGradient.unit);
}
/**
* Convert TemperatureGradient to a specific unit value.
* @param toUnit The specific unit to convert to
* @returns The value of the specific unit provided.
*/
convert(toUnit) {
switch (toUnit) {
case TemperatureGradientUnits.KelvinsPerMeter: return this.KelvinsPerMeter;
case TemperatureGradientUnits.DegreesCelsiusPerMeter: return this.DegreesCelsiusPerMeter;
case TemperatureGradientUnits.DegreesFahrenheitPerFoot: return this.DegreesFahrenheitPerFoot;
case TemperatureGradientUnits.DegreesCelsiusPerKilometer: return this.DegreesCelsiusPerKilometer;
default:
break;
}
return Number.NaN;
}
convertFromBase(toUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (toUnit) {
case TemperatureGradientUnits.KelvinsPerMeter: return this.value;
case TemperatureGradientUnits.DegreesCelsiusPerMeter: return this.value;
case TemperatureGradientUnits.DegreesFahrenheitPerFoot: {
const v3 = super.internalMultiply(this.value, 0.3048);
const v6 = super.internalDivide(9, 5);
return super.internalMultiply(v3, v6);
}
case TemperatureGradientUnits.DegreesCelsiusPerKilometer: return super.internalMultiply(this.value, 1e3);
default: return Number.NaN;
}
switch (toUnit) {
case TemperatureGradientUnits.KelvinsPerMeter: return this.value;
case TemperatureGradientUnits.DegreesCelsiusPerMeter: return this.value;
case TemperatureGradientUnits.DegreesFahrenheitPerFoot: return (this.value * 0.3048) * 9 / 5;
case TemperatureGradientUnits.DegreesCelsiusPerKilometer: return this.value * 1e3;
default: return Number.NaN;
}
}
convertToBase(value, fromUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (fromUnit) {
case TemperatureGradientUnits.KelvinsPerMeter: return value;
case TemperatureGradientUnits.DegreesCelsiusPerMeter: return value;
case TemperatureGradientUnits.DegreesFahrenheitPerFoot: {
const v3 = super.internalDivide(value, 0.3048);
const v6 = super.internalDivide(5, 9);
return super.internalMultiply(v3, v6);
}
case TemperatureGradientUnits.DegreesCelsiusPerKilometer: return super.internalDivide(value, 1e3);
default: return Number.NaN;
}
switch (fromUnit) {
case TemperatureGradientUnits.KelvinsPerMeter: return value;
case TemperatureGradientUnits.DegreesCelsiusPerMeter: return value;
case TemperatureGradientUnits.DegreesFahrenheitPerFoot: return (value / 0.3048) * 5 / 9;
case TemperatureGradientUnits.DegreesCelsiusPerKilometer: return value / 1e3;
default: return Number.NaN;
}
}
/**
* Format the TemperatureGradient to string.
* Note! the default format for TemperatureGradient is KelvinsPerMeter.
* To specify the unit format set the 'unit' parameter.
* @param unit The unit to format the TemperatureGradient.
* @param options The ToString options, it also can be the number of fractional digits to keep that deprecated and moved to the options object. support in number will be dropped in the upcoming versions.
* @returns The string format of the TemperatureGradient.
*/
toString(unit = TemperatureGradientUnits.KelvinsPerMeter, options) {
if (typeof options === 'number') {
console.warn('The number parameter is deprecated and moved to the options object. support in number will be dropped in the upcoming versions.');
options = { fractionalDigits: options };
}
switch (unit) {
case TemperatureGradientUnits.KelvinsPerMeter:
return super.truncateFractionDigits(this.KelvinsPerMeter, options) + ` ∆°K/m`;
case TemperatureGradientUnits.DegreesCelsiusPerMeter:
return super.truncateFractionDigits(this.DegreesCelsiusPerMeter, options) + ` ∆°C/m`;
case TemperatureGradientUnits.DegreesFahrenheitPerFoot:
return super.truncateFractionDigits(this.DegreesFahrenheitPerFoot, options) + ` ∆°F/ft`;
case TemperatureGradientUnits.DegreesCelsiusPerKilometer:
return super.truncateFractionDigits(this.DegreesCelsiusPerKilometer, options) + ` ∆°C/km`;
default:
break;
}
return this.value.toString();
}
/**
* Get TemperatureGradient unit abbreviation.
* Note! the default abbreviation for TemperatureGradient is KelvinsPerMeter.
* To specify the unit abbreviation set the 'unitAbbreviation' parameter.
* @param unitAbbreviation The unit abbreviation of the TemperatureGradient.
* @returns The abbreviation string of TemperatureGradient.
*/
getUnitAbbreviation(unitAbbreviation = TemperatureGradientUnits.KelvinsPerMeter) {
switch (unitAbbreviation) {
case TemperatureGradientUnits.KelvinsPerMeter:
return `∆°K/m`;
case TemperatureGradientUnits.DegreesCelsiusPerMeter:
return `∆°C/m`;
case TemperatureGradientUnits.DegreesFahrenheitPerFoot:
return `∆°F/ft`;
case TemperatureGradientUnits.DegreesCelsiusPerKilometer:
return `∆°C/km`;
default:
break;
}
return '';
}
/**
* Check if the given TemperatureGradient are equals to the current TemperatureGradient.
* @param temperatureGradient The other TemperatureGradient.
* @returns True if the given TemperatureGradient are equal to the current TemperatureGradient.
*/
equals(temperatureGradient) {
return super.internalEquals(this.value, temperatureGradient.BaseValue);
}
/**
* Compare the given TemperatureGradient against the current TemperatureGradient.
* @param temperatureGradient The other TemperatureGradient.
* @returns 0 if they are equal, -1 if the current TemperatureGradient is less then other, 1 if the current TemperatureGradient is greater then other.
*/
compareTo(temperatureGradient) {
return super.internalCompareTo(this.value, temperatureGradient.BaseValue);
}
/**
* Add the given TemperatureGradient with the current TemperatureGradient.
* @param temperatureGradient The other TemperatureGradient.
* @returns A new TemperatureGradient instance with the results.
*/
add(temperatureGradient) {
return new TemperatureGradient(super.internalAdd(this.value, temperatureGradient.BaseValue));
}
/**
* Subtract the given TemperatureGradient with the current TemperatureGradient.
* @param temperatureGradient The other TemperatureGradient.
* @returns A new TemperatureGradient instance with the results.
*/
subtract(temperatureGradient) {
return new TemperatureGradient(super.internalSubtract(this.value, temperatureGradient.BaseValue));
}
/**
* Multiply the given TemperatureGradient with the current TemperatureGradient.
* @param temperatureGradient The other TemperatureGradient.
* @returns A new TemperatureGradient instance with the results.
*/
multiply(temperatureGradient) {
return new TemperatureGradient(super.internalMultiply(this.value, temperatureGradient.BaseValue));
}
/**
* Divide the given TemperatureGradient with the current TemperatureGradient.
* @param temperatureGradient The other TemperatureGradient.
* @returns A new TemperatureGradient instance with the results.
*/
divide(temperatureGradient) {
return new TemperatureGradient(super.internalDivide(this.value, temperatureGradient.BaseValue));
}
/**
* Modulo the given TemperatureGradient with the current TemperatureGradient.
* @param temperatureGradient The other TemperatureGradient.
* @returns A new TemperatureGradient instance with the results.
*/
modulo(temperatureGradient) {
return new TemperatureGradient(super.internalModulo(this.value, temperatureGradient.BaseValue));
}
/**
* Pow the given TemperatureGradient with the current TemperatureGradient.
* @param temperatureGradient The other TemperatureGradient.
* @returns A new TemperatureGradient instance with the results.
*/
pow(temperatureGradient) {
return new TemperatureGradient(super.internalPow(this.value, temperatureGradient.BaseValue));
}
}
exports.TemperatureGradient = TemperatureGradient;