unitsnet-js
Version:
A better way to hold unit variables and easily convert to the destination unit
375 lines (374 loc) • 18 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.AreaMomentOfInertia = exports.AreaMomentOfInertiaUnits = void 0;
const base_unit_1 = require("../base-unit");
/** AreaMomentOfInertiaUnits enumeration */
var AreaMomentOfInertiaUnits;
(function (AreaMomentOfInertiaUnits) {
/** */
AreaMomentOfInertiaUnits["MetersToTheFourth"] = "MeterToTheFourth";
/** */
AreaMomentOfInertiaUnits["DecimetersToTheFourth"] = "DecimeterToTheFourth";
/** */
AreaMomentOfInertiaUnits["CentimetersToTheFourth"] = "CentimeterToTheFourth";
/** */
AreaMomentOfInertiaUnits["MillimetersToTheFourth"] = "MillimeterToTheFourth";
/** */
AreaMomentOfInertiaUnits["FeetToTheFourth"] = "FootToTheFourth";
/** */
AreaMomentOfInertiaUnits["InchesToTheFourth"] = "InchToTheFourth";
})(AreaMomentOfInertiaUnits = exports.AreaMomentOfInertiaUnits || (exports.AreaMomentOfInertiaUnits = {}));
/** A geometric property of an area that reflects how its points are distributed with regard to an axis. */
class AreaMomentOfInertia extends base_unit_1.BaseUnit {
/**
* Create a new AreaMomentOfInertia.
* @param value The value.
* @param fromUnit The ‘AreaMomentOfInertia’ unit to create from.
* The default unit is MetersToTheFourth
*/
constructor(value, fromUnit = AreaMomentOfInertiaUnits.MetersToTheFourth) {
super();
this.meterstothefourthLazy = null;
this.decimeterstothefourthLazy = null;
this.centimeterstothefourthLazy = null;
this.millimeterstothefourthLazy = null;
this.feettothefourthLazy = null;
this.inchestothefourthLazy = 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 AreaMomentOfInertia is MetersToTheFourth.
* 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 AreaMomentOfInertiaUnits.MetersToTheFourth;
}
/** */
get MetersToTheFourth() {
if (this.meterstothefourthLazy !== null) {
return this.meterstothefourthLazy;
}
return this.meterstothefourthLazy = this.convertFromBase(AreaMomentOfInertiaUnits.MetersToTheFourth);
}
/** */
get DecimetersToTheFourth() {
if (this.decimeterstothefourthLazy !== null) {
return this.decimeterstothefourthLazy;
}
return this.decimeterstothefourthLazy = this.convertFromBase(AreaMomentOfInertiaUnits.DecimetersToTheFourth);
}
/** */
get CentimetersToTheFourth() {
if (this.centimeterstothefourthLazy !== null) {
return this.centimeterstothefourthLazy;
}
return this.centimeterstothefourthLazy = this.convertFromBase(AreaMomentOfInertiaUnits.CentimetersToTheFourth);
}
/** */
get MillimetersToTheFourth() {
if (this.millimeterstothefourthLazy !== null) {
return this.millimeterstothefourthLazy;
}
return this.millimeterstothefourthLazy = this.convertFromBase(AreaMomentOfInertiaUnits.MillimetersToTheFourth);
}
/** */
get FeetToTheFourth() {
if (this.feettothefourthLazy !== null) {
return this.feettothefourthLazy;
}
return this.feettothefourthLazy = this.convertFromBase(AreaMomentOfInertiaUnits.FeetToTheFourth);
}
/** */
get InchesToTheFourth() {
if (this.inchestothefourthLazy !== null) {
return this.inchestothefourthLazy;
}
return this.inchestothefourthLazy = this.convertFromBase(AreaMomentOfInertiaUnits.InchesToTheFourth);
}
/**
* Create a new AreaMomentOfInertia instance from a MetersToTheFourth
*
* @param value The unit as MetersToTheFourth to create a new AreaMomentOfInertia from.
* @returns The new AreaMomentOfInertia instance.
*/
static FromMetersToTheFourth(value) {
return new AreaMomentOfInertia(value, AreaMomentOfInertiaUnits.MetersToTheFourth);
}
/**
* Create a new AreaMomentOfInertia instance from a DecimetersToTheFourth
*
* @param value The unit as DecimetersToTheFourth to create a new AreaMomentOfInertia from.
* @returns The new AreaMomentOfInertia instance.
*/
static FromDecimetersToTheFourth(value) {
return new AreaMomentOfInertia(value, AreaMomentOfInertiaUnits.DecimetersToTheFourth);
}
/**
* Create a new AreaMomentOfInertia instance from a CentimetersToTheFourth
*
* @param value The unit as CentimetersToTheFourth to create a new AreaMomentOfInertia from.
* @returns The new AreaMomentOfInertia instance.
*/
static FromCentimetersToTheFourth(value) {
return new AreaMomentOfInertia(value, AreaMomentOfInertiaUnits.CentimetersToTheFourth);
}
/**
* Create a new AreaMomentOfInertia instance from a MillimetersToTheFourth
*
* @param value The unit as MillimetersToTheFourth to create a new AreaMomentOfInertia from.
* @returns The new AreaMomentOfInertia instance.
*/
static FromMillimetersToTheFourth(value) {
return new AreaMomentOfInertia(value, AreaMomentOfInertiaUnits.MillimetersToTheFourth);
}
/**
* Create a new AreaMomentOfInertia instance from a FeetToTheFourth
*
* @param value The unit as FeetToTheFourth to create a new AreaMomentOfInertia from.
* @returns The new AreaMomentOfInertia instance.
*/
static FromFeetToTheFourth(value) {
return new AreaMomentOfInertia(value, AreaMomentOfInertiaUnits.FeetToTheFourth);
}
/**
* Create a new AreaMomentOfInertia instance from a InchesToTheFourth
*
* @param value The unit as InchesToTheFourth to create a new AreaMomentOfInertia from.
* @returns The new AreaMomentOfInertia instance.
*/
static FromInchesToTheFourth(value) {
return new AreaMomentOfInertia(value, AreaMomentOfInertiaUnits.InchesToTheFourth);
}
/**
* Gets the base unit enumeration associated with AreaMomentOfInertia
* @returns The unit enumeration that can be used to interact with this type
*/
static getUnitEnum() {
return AreaMomentOfInertiaUnits;
}
/**
* 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 AreaMomentOfInertiaUnits.MetersToTheFourth;
}
/**
* Create API DTO represent a AreaMomentOfInertia unit.
* @param holdInUnit The specific AreaMomentOfInertia unit to be used in the unit representation at the DTO
*/
toDto(holdInUnit = AreaMomentOfInertiaUnits.MetersToTheFourth) {
return {
value: this.convert(holdInUnit),
unit: holdInUnit
};
}
/**
* Create a AreaMomentOfInertia unit from an API DTO representation.
* @param dtoAreaMomentOfInertia The AreaMomentOfInertia API DTO representation
*/
static FromDto(dtoAreaMomentOfInertia) {
return new AreaMomentOfInertia(dtoAreaMomentOfInertia.value, dtoAreaMomentOfInertia.unit);
}
/**
* Convert AreaMomentOfInertia 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 AreaMomentOfInertiaUnits.MetersToTheFourth: return this.MetersToTheFourth;
case AreaMomentOfInertiaUnits.DecimetersToTheFourth: return this.DecimetersToTheFourth;
case AreaMomentOfInertiaUnits.CentimetersToTheFourth: return this.CentimetersToTheFourth;
case AreaMomentOfInertiaUnits.MillimetersToTheFourth: return this.MillimetersToTheFourth;
case AreaMomentOfInertiaUnits.FeetToTheFourth: return this.FeetToTheFourth;
case AreaMomentOfInertiaUnits.InchesToTheFourth: return this.InchesToTheFourth;
default:
break;
}
return Number.NaN;
}
convertFromBase(toUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (toUnit) {
case AreaMomentOfInertiaUnits.MetersToTheFourth: return this.value;
case AreaMomentOfInertiaUnits.DecimetersToTheFourth: return super.internalMultiply(this.value, 1e4);
case AreaMomentOfInertiaUnits.CentimetersToTheFourth: return super.internalMultiply(this.value, 1e8);
case AreaMomentOfInertiaUnits.MillimetersToTheFourth: return super.internalMultiply(this.value, 1e12);
case AreaMomentOfInertiaUnits.FeetToTheFourth: {
const v4 = super.internalPow(0.3048, 4);
return super.internalDivide(this.value, v4);
}
case AreaMomentOfInertiaUnits.InchesToTheFourth: {
const v4 = super.internalPow(2.54e-2, 4);
return super.internalDivide(this.value, v4);
}
default: return Number.NaN;
}
switch (toUnit) {
case AreaMomentOfInertiaUnits.MetersToTheFourth: return this.value;
case AreaMomentOfInertiaUnits.DecimetersToTheFourth: return this.value * 1e4;
case AreaMomentOfInertiaUnits.CentimetersToTheFourth: return this.value * 1e8;
case AreaMomentOfInertiaUnits.MillimetersToTheFourth: return this.value * 1e12;
case AreaMomentOfInertiaUnits.FeetToTheFourth: return this.value / Math.pow(0.3048, 4);
case AreaMomentOfInertiaUnits.InchesToTheFourth: return this.value / Math.pow(2.54e-2, 4);
default: return Number.NaN;
}
}
convertToBase(value, fromUnit) {
if (base_unit_1.areAnyOperatorsOverridden())
switch (fromUnit) {
case AreaMomentOfInertiaUnits.MetersToTheFourth: return value;
case AreaMomentOfInertiaUnits.DecimetersToTheFourth: return super.internalDivide(value, 1e4);
case AreaMomentOfInertiaUnits.CentimetersToTheFourth: return super.internalDivide(value, 1e8);
case AreaMomentOfInertiaUnits.MillimetersToTheFourth: return super.internalDivide(value, 1e12);
case AreaMomentOfInertiaUnits.FeetToTheFourth: {
const v4 = super.internalPow(0.3048, 4);
return super.internalMultiply(value, v4);
}
case AreaMomentOfInertiaUnits.InchesToTheFourth: {
const v4 = super.internalPow(2.54e-2, 4);
return super.internalMultiply(value, v4);
}
default: return Number.NaN;
}
switch (fromUnit) {
case AreaMomentOfInertiaUnits.MetersToTheFourth: return value;
case AreaMomentOfInertiaUnits.DecimetersToTheFourth: return value / 1e4;
case AreaMomentOfInertiaUnits.CentimetersToTheFourth: return value / 1e8;
case AreaMomentOfInertiaUnits.MillimetersToTheFourth: return value / 1e12;
case AreaMomentOfInertiaUnits.FeetToTheFourth: return value * Math.pow(0.3048, 4);
case AreaMomentOfInertiaUnits.InchesToTheFourth: return value * Math.pow(2.54e-2, 4);
default: return Number.NaN;
}
}
/**
* Format the AreaMomentOfInertia to string.
* Note! the default format for AreaMomentOfInertia is MetersToTheFourth.
* To specify the unit format set the 'unit' parameter.
* @param unit The unit to format the AreaMomentOfInertia.
* @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 AreaMomentOfInertia.
*/
toString(unit = AreaMomentOfInertiaUnits.MetersToTheFourth, 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 AreaMomentOfInertiaUnits.MetersToTheFourth:
return super.truncateFractionDigits(this.MetersToTheFourth, options) + ` m⁴`;
case AreaMomentOfInertiaUnits.DecimetersToTheFourth:
return super.truncateFractionDigits(this.DecimetersToTheFourth, options) + ` dm⁴`;
case AreaMomentOfInertiaUnits.CentimetersToTheFourth:
return super.truncateFractionDigits(this.CentimetersToTheFourth, options) + ` cm⁴`;
case AreaMomentOfInertiaUnits.MillimetersToTheFourth:
return super.truncateFractionDigits(this.MillimetersToTheFourth, options) + ` mm⁴`;
case AreaMomentOfInertiaUnits.FeetToTheFourth:
return super.truncateFractionDigits(this.FeetToTheFourth, options) + ` ft⁴`;
case AreaMomentOfInertiaUnits.InchesToTheFourth:
return super.truncateFractionDigits(this.InchesToTheFourth, options) + ` in⁴`;
default:
break;
}
return this.value.toString();
}
/**
* Get AreaMomentOfInertia unit abbreviation.
* Note! the default abbreviation for AreaMomentOfInertia is MetersToTheFourth.
* To specify the unit abbreviation set the 'unitAbbreviation' parameter.
* @param unitAbbreviation The unit abbreviation of the AreaMomentOfInertia.
* @returns The abbreviation string of AreaMomentOfInertia.
*/
getUnitAbbreviation(unitAbbreviation = AreaMomentOfInertiaUnits.MetersToTheFourth) {
switch (unitAbbreviation) {
case AreaMomentOfInertiaUnits.MetersToTheFourth:
return `m⁴`;
case AreaMomentOfInertiaUnits.DecimetersToTheFourth:
return `dm⁴`;
case AreaMomentOfInertiaUnits.CentimetersToTheFourth:
return `cm⁴`;
case AreaMomentOfInertiaUnits.MillimetersToTheFourth:
return `mm⁴`;
case AreaMomentOfInertiaUnits.FeetToTheFourth:
return `ft⁴`;
case AreaMomentOfInertiaUnits.InchesToTheFourth:
return `in⁴`;
default:
break;
}
return '';
}
/**
* Check if the given AreaMomentOfInertia are equals to the current AreaMomentOfInertia.
* @param areaMomentOfInertia The other AreaMomentOfInertia.
* @returns True if the given AreaMomentOfInertia are equal to the current AreaMomentOfInertia.
*/
equals(areaMomentOfInertia) {
return super.internalEquals(this.value, areaMomentOfInertia.BaseValue);
}
/**
* Compare the given AreaMomentOfInertia against the current AreaMomentOfInertia.
* @param areaMomentOfInertia The other AreaMomentOfInertia.
* @returns 0 if they are equal, -1 if the current AreaMomentOfInertia is less then other, 1 if the current AreaMomentOfInertia is greater then other.
*/
compareTo(areaMomentOfInertia) {
return super.internalCompareTo(this.value, areaMomentOfInertia.BaseValue);
}
/**
* Add the given AreaMomentOfInertia with the current AreaMomentOfInertia.
* @param areaMomentOfInertia The other AreaMomentOfInertia.
* @returns A new AreaMomentOfInertia instance with the results.
*/
add(areaMomentOfInertia) {
return new AreaMomentOfInertia(super.internalAdd(this.value, areaMomentOfInertia.BaseValue));
}
/**
* Subtract the given AreaMomentOfInertia with the current AreaMomentOfInertia.
* @param areaMomentOfInertia The other AreaMomentOfInertia.
* @returns A new AreaMomentOfInertia instance with the results.
*/
subtract(areaMomentOfInertia) {
return new AreaMomentOfInertia(super.internalSubtract(this.value, areaMomentOfInertia.BaseValue));
}
/**
* Multiply the given AreaMomentOfInertia with the current AreaMomentOfInertia.
* @param areaMomentOfInertia The other AreaMomentOfInertia.
* @returns A new AreaMomentOfInertia instance with the results.
*/
multiply(areaMomentOfInertia) {
return new AreaMomentOfInertia(super.internalMultiply(this.value, areaMomentOfInertia.BaseValue));
}
/**
* Divide the given AreaMomentOfInertia with the current AreaMomentOfInertia.
* @param areaMomentOfInertia The other AreaMomentOfInertia.
* @returns A new AreaMomentOfInertia instance with the results.
*/
divide(areaMomentOfInertia) {
return new AreaMomentOfInertia(super.internalDivide(this.value, areaMomentOfInertia.BaseValue));
}
/**
* Modulo the given AreaMomentOfInertia with the current AreaMomentOfInertia.
* @param areaMomentOfInertia The other AreaMomentOfInertia.
* @returns A new AreaMomentOfInertia instance with the results.
*/
modulo(areaMomentOfInertia) {
return new AreaMomentOfInertia(super.internalModulo(this.value, areaMomentOfInertia.BaseValue));
}
/**
* Pow the given AreaMomentOfInertia with the current AreaMomentOfInertia.
* @param areaMomentOfInertia The other AreaMomentOfInertia.
* @returns A new AreaMomentOfInertia instance with the results.
*/
pow(areaMomentOfInertia) {
return new AreaMomentOfInertia(super.internalPow(this.value, areaMomentOfInertia.BaseValue));
}
}
exports.AreaMomentOfInertia = AreaMomentOfInertia;