unitsnet-js
Version:
A better way to hold unit variables and easily convert to the destination unit
459 lines (458 loc) • 19.8 kB
TypeScript
import { BaseUnit, ToStringOptions } from "../base-unit";
/** API DTO represents a MassMomentOfInertia */
export interface MassMomentOfInertiaDto {
/** The value of the MassMomentOfInertia */
value: number;
/** The specific unit that the MassMomentOfInertia value is representing */
unit: MassMomentOfInertiaUnits;
}
/** MassMomentOfInertiaUnits enumeration */
export declare enum MassMomentOfInertiaUnits {
/** */
GramSquareMeters = "GramSquareMeter",
/** */
GramSquareDecimeters = "GramSquareDecimeter",
/** */
GramSquareCentimeters = "GramSquareCentimeter",
/** */
GramSquareMillimeters = "GramSquareMillimeter",
/** */
TonneSquareMeters = "TonneSquareMeter",
/** */
TonneSquareDecimeters = "TonneSquareDecimeter",
/** */
TonneSquareCentimeters = "TonneSquareCentimeter",
/** */
TonneSquareMillimeters = "TonneSquareMillimeter",
/** */
PoundSquareFeet = "PoundSquareFoot",
/** */
PoundSquareInches = "PoundSquareInch",
/** */
SlugSquareFeet = "SlugSquareFoot",
/** */
SlugSquareInches = "SlugSquareInch",
/** */
MilligramSquareMeters = "MilligramSquareMeter",
/** */
KilogramSquareMeters = "KilogramSquareMeter",
/** */
MilligramSquareDecimeters = "MilligramSquareDecimeter",
/** */
KilogramSquareDecimeters = "KilogramSquareDecimeter",
/** */
MilligramSquareCentimeters = "MilligramSquareCentimeter",
/** */
KilogramSquareCentimeters = "KilogramSquareCentimeter",
/** */
MilligramSquareMillimeters = "MilligramSquareMillimeter",
/** */
KilogramSquareMillimeters = "KilogramSquareMillimeter",
/** */
KilotonneSquareMeters = "KilotonneSquareMeter",
/** */
MegatonneSquareMeters = "MegatonneSquareMeter",
/** */
KilotonneSquareDecimeters = "KilotonneSquareDecimeter",
/** */
MegatonneSquareDecimeters = "MegatonneSquareDecimeter",
/** */
KilotonneSquareCentimeters = "KilotonneSquareCentimeter",
/** */
MegatonneSquareCentimeters = "MegatonneSquareCentimeter",
/** */
KilotonneSquareMillimeters = "KilotonneSquareMillimeter",
/** */
MegatonneSquareMillimeters = "MegatonneSquareMillimeter"
}
/** A property of body reflects how its mass is distributed with regard to an axis. */
export declare class MassMomentOfInertia extends BaseUnit {
protected value: number;
private gramsquaremetersLazy;
private gramsquaredecimetersLazy;
private gramsquarecentimetersLazy;
private gramsquaremillimetersLazy;
private tonnesquaremetersLazy;
private tonnesquaredecimetersLazy;
private tonnesquarecentimetersLazy;
private tonnesquaremillimetersLazy;
private poundsquarefeetLazy;
private poundsquareinchesLazy;
private slugsquarefeetLazy;
private slugsquareinchesLazy;
private milligramsquaremetersLazy;
private kilogramsquaremetersLazy;
private milligramsquaredecimetersLazy;
private kilogramsquaredecimetersLazy;
private milligramsquarecentimetersLazy;
private kilogramsquarecentimetersLazy;
private milligramsquaremillimetersLazy;
private kilogramsquaremillimetersLazy;
private kilotonnesquaremetersLazy;
private megatonnesquaremetersLazy;
private kilotonnesquaredecimetersLazy;
private megatonnesquaredecimetersLazy;
private kilotonnesquarecentimetersLazy;
private megatonnesquarecentimetersLazy;
private kilotonnesquaremillimetersLazy;
private megatonnesquaremillimetersLazy;
/**
* Create a new MassMomentOfInertia.
* @param value The value.
* @param fromUnit The ‘MassMomentOfInertia’ unit to create from.
* The default unit is KilogramSquareMeters
*/
constructor(value: number, fromUnit?: MassMomentOfInertiaUnits);
/**
* The base value of MassMomentOfInertia is KilogramSquareMeters.
* This accessor used when needs a value for calculations and it's better to use directly the base value
*/
get BaseValue(): number;
/** Gets the default unit used when creating instances of the unit or its DTO */
protected get baseUnit(): MassMomentOfInertiaUnits.KilogramSquareMeters;
/** */
get GramSquareMeters(): number;
/** */
get GramSquareDecimeters(): number;
/** */
get GramSquareCentimeters(): number;
/** */
get GramSquareMillimeters(): number;
/** */
get TonneSquareMeters(): number;
/** */
get TonneSquareDecimeters(): number;
/** */
get TonneSquareCentimeters(): number;
/** */
get TonneSquareMillimeters(): number;
/** */
get PoundSquareFeet(): number;
/** */
get PoundSquareInches(): number;
/** */
get SlugSquareFeet(): number;
/** */
get SlugSquareInches(): number;
/** */
get MilligramSquareMeters(): number;
/** */
get KilogramSquareMeters(): number;
/** */
get MilligramSquareDecimeters(): number;
/** */
get KilogramSquareDecimeters(): number;
/** */
get MilligramSquareCentimeters(): number;
/** */
get KilogramSquareCentimeters(): number;
/** */
get MilligramSquareMillimeters(): number;
/** */
get KilogramSquareMillimeters(): number;
/** */
get KilotonneSquareMeters(): number;
/** */
get MegatonneSquareMeters(): number;
/** */
get KilotonneSquareDecimeters(): number;
/** */
get MegatonneSquareDecimeters(): number;
/** */
get KilotonneSquareCentimeters(): number;
/** */
get MegatonneSquareCentimeters(): number;
/** */
get KilotonneSquareMillimeters(): number;
/** */
get MegatonneSquareMillimeters(): number;
/**
* Create a new MassMomentOfInertia instance from a GramSquareMeters
*
* @param value The unit as GramSquareMeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromGramSquareMeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a GramSquareDecimeters
*
* @param value The unit as GramSquareDecimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromGramSquareDecimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a GramSquareCentimeters
*
* @param value The unit as GramSquareCentimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromGramSquareCentimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a GramSquareMillimeters
*
* @param value The unit as GramSquareMillimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromGramSquareMillimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a TonneSquareMeters
*
* @param value The unit as TonneSquareMeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromTonneSquareMeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a TonneSquareDecimeters
*
* @param value The unit as TonneSquareDecimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromTonneSquareDecimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a TonneSquareCentimeters
*
* @param value The unit as TonneSquareCentimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromTonneSquareCentimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a TonneSquareMillimeters
*
* @param value The unit as TonneSquareMillimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromTonneSquareMillimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a PoundSquareFeet
*
* @param value The unit as PoundSquareFeet to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromPoundSquareFeet(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a PoundSquareInches
*
* @param value The unit as PoundSquareInches to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromPoundSquareInches(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a SlugSquareFeet
*
* @param value The unit as SlugSquareFeet to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromSlugSquareFeet(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a SlugSquareInches
*
* @param value The unit as SlugSquareInches to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromSlugSquareInches(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a MilligramSquareMeters
*
* @param value The unit as MilligramSquareMeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromMilligramSquareMeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a KilogramSquareMeters
*
* @param value The unit as KilogramSquareMeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromKilogramSquareMeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a MilligramSquareDecimeters
*
* @param value The unit as MilligramSquareDecimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromMilligramSquareDecimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a KilogramSquareDecimeters
*
* @param value The unit as KilogramSquareDecimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromKilogramSquareDecimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a MilligramSquareCentimeters
*
* @param value The unit as MilligramSquareCentimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromMilligramSquareCentimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a KilogramSquareCentimeters
*
* @param value The unit as KilogramSquareCentimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromKilogramSquareCentimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a MilligramSquareMillimeters
*
* @param value The unit as MilligramSquareMillimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromMilligramSquareMillimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a KilogramSquareMillimeters
*
* @param value The unit as KilogramSquareMillimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromKilogramSquareMillimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a KilotonneSquareMeters
*
* @param value The unit as KilotonneSquareMeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromKilotonneSquareMeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a MegatonneSquareMeters
*
* @param value The unit as MegatonneSquareMeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromMegatonneSquareMeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a KilotonneSquareDecimeters
*
* @param value The unit as KilotonneSquareDecimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromKilotonneSquareDecimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a MegatonneSquareDecimeters
*
* @param value The unit as MegatonneSquareDecimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromMegatonneSquareDecimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a KilotonneSquareCentimeters
*
* @param value The unit as KilotonneSquareCentimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromKilotonneSquareCentimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a MegatonneSquareCentimeters
*
* @param value The unit as MegatonneSquareCentimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromMegatonneSquareCentimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a KilotonneSquareMillimeters
*
* @param value The unit as KilotonneSquareMillimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromKilotonneSquareMillimeters(value: number): MassMomentOfInertia;
/**
* Create a new MassMomentOfInertia instance from a MegatonneSquareMillimeters
*
* @param value The unit as MegatonneSquareMillimeters to create a new MassMomentOfInertia from.
* @returns The new MassMomentOfInertia instance.
*/
static FromMegatonneSquareMillimeters(value: number): MassMomentOfInertia;
/**
* Gets the base unit enumeration associated with MassMomentOfInertia
* @returns The unit enumeration that can be used to interact with this type
*/
protected static getUnitEnum(): typeof MassMomentOfInertiaUnits;
/**
* 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
*/
protected static getBaseUnit(): MassMomentOfInertiaUnits.KilogramSquareMeters;
/**
* Create API DTO represent a MassMomentOfInertia unit.
* @param holdInUnit The specific MassMomentOfInertia unit to be used in the unit representation at the DTO
*/
toDto(holdInUnit?: MassMomentOfInertiaUnits): MassMomentOfInertiaDto;
/**
* Create a MassMomentOfInertia unit from an API DTO representation.
* @param dtoMassMomentOfInertia The MassMomentOfInertia API DTO representation
*/
static FromDto(dtoMassMomentOfInertia: MassMomentOfInertiaDto): MassMomentOfInertia;
/**
* Convert MassMomentOfInertia to a specific unit value.
* @param toUnit The specific unit to convert to
* @returns The value of the specific unit provided.
*/
convert(toUnit: MassMomentOfInertiaUnits): number;
private convertFromBase;
private convertToBase;
/**
* Format the MassMomentOfInertia to string.
* Note! the default format for MassMomentOfInertia is KilogramSquareMeters.
* To specify the unit format set the 'unit' parameter.
* @param unit The unit to format the MassMomentOfInertia.
* @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 MassMomentOfInertia.
*/
toString(unit?: MassMomentOfInertiaUnits, options?: number | ToStringOptions): string;
/**
* Get MassMomentOfInertia unit abbreviation.
* Note! the default abbreviation for MassMomentOfInertia is KilogramSquareMeters.
* To specify the unit abbreviation set the 'unitAbbreviation' parameter.
* @param unitAbbreviation The unit abbreviation of the MassMomentOfInertia.
* @returns The abbreviation string of MassMomentOfInertia.
*/
getUnitAbbreviation(unitAbbreviation?: MassMomentOfInertiaUnits): string;
/**
* Check if the given MassMomentOfInertia are equals to the current MassMomentOfInertia.
* @param massMomentOfInertia The other MassMomentOfInertia.
* @returns True if the given MassMomentOfInertia are equal to the current MassMomentOfInertia.
*/
equals(massMomentOfInertia: MassMomentOfInertia): boolean;
/**
* Compare the given MassMomentOfInertia against the current MassMomentOfInertia.
* @param massMomentOfInertia The other MassMomentOfInertia.
* @returns 0 if they are equal, -1 if the current MassMomentOfInertia is less then other, 1 if the current MassMomentOfInertia is greater then other.
*/
compareTo(massMomentOfInertia: MassMomentOfInertia): number;
/**
* Add the given MassMomentOfInertia with the current MassMomentOfInertia.
* @param massMomentOfInertia The other MassMomentOfInertia.
* @returns A new MassMomentOfInertia instance with the results.
*/
add(massMomentOfInertia: MassMomentOfInertia): MassMomentOfInertia;
/**
* Subtract the given MassMomentOfInertia with the current MassMomentOfInertia.
* @param massMomentOfInertia The other MassMomentOfInertia.
* @returns A new MassMomentOfInertia instance with the results.
*/
subtract(massMomentOfInertia: MassMomentOfInertia): MassMomentOfInertia;
/**
* Multiply the given MassMomentOfInertia with the current MassMomentOfInertia.
* @param massMomentOfInertia The other MassMomentOfInertia.
* @returns A new MassMomentOfInertia instance with the results.
*/
multiply(massMomentOfInertia: MassMomentOfInertia): MassMomentOfInertia;
/**
* Divide the given MassMomentOfInertia with the current MassMomentOfInertia.
* @param massMomentOfInertia The other MassMomentOfInertia.
* @returns A new MassMomentOfInertia instance with the results.
*/
divide(massMomentOfInertia: MassMomentOfInertia): MassMomentOfInertia;
/**
* Modulo the given MassMomentOfInertia with the current MassMomentOfInertia.
* @param massMomentOfInertia The other MassMomentOfInertia.
* @returns A new MassMomentOfInertia instance with the results.
*/
modulo(massMomentOfInertia: MassMomentOfInertia): MassMomentOfInertia;
/**
* Pow the given MassMomentOfInertia with the current MassMomentOfInertia.
* @param massMomentOfInertia The other MassMomentOfInertia.
* @returns A new MassMomentOfInertia instance with the results.
*/
pow(massMomentOfInertia: MassMomentOfInertia): MassMomentOfInertia;
}