@cabinfo.eu/astrophysics-library
Version:
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 7.2.0.
297 lines (296 loc) • 7.62 kB
TypeScript
/**
* This class define physics constants and calculated physics constants.
*
* Instanciation example :
*
* ```typescript
* const instance = new CPhysicsConstants();
* ```
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @author Alain Deseine
*
* @copyright CEI Alain Deseine 1992-2019
*
* @beta
*
* Copyright (C) 2019 Alain Deseine
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
*/
export declare class CConstant {
name: string;
symbol: string;
value: number;
unit: string;
description: string;
/**
* Constructor.
*
* The constructor of this class calculate calculated physics constants.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
constructor(name: string, symbol: string, value: number, unit: string, description: string);
}
export declare class CPhysicsConstants {
[index: string]: any;
constants: CConstant[];
/**
* Constructor.
*
* The constructor of this class calculate calculated physics constants.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
constructor();
/**
* getConstantInfo method.
*
* this method simply log to the console class properties and methods.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
getConstantInfo(name: string): any;
/**
* logConstants method.
*
* this method simply log to the console class properties and methods.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
logConstants(): void;
/**
* toJSON method.
*
* this method return the public and protected object properties.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
toJSON(): Object;
/**
*
* Conversion helpers
*
*/
/**
* unit of length conversion helpers
*/
/**
* meter2au method.
*
* this method convert meters to astronomical unit.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
meter2au(value: number): number;
/**
* au2meter method.
*
* this method convert astronomical unit to meters.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
au2meter(value: number): number;
/**
* au2kilometer method.
*
* this method convert astronomical unit to kilometers.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
au2kilometer(value: number): number;
/**
* meter2pc method.
*
* this method convert meters to parsec.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
meter2pc(value: number): number;
/**
* pc2meter method.
*
* this method convert parsec to meters.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
pc2meter(value: number): number;
/**
* pc2kilometer method.
*
* this method convert parsec to kilometers.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
pc2kilometer(value: number): number;
/**
* pc2au method.
*
* this method convert parsec to astronomical unit.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
pc2au(value: number): number;
/**
* au2pc method.
*
* this method convert astronomical unit to parsec.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
au2pc(value: number): number;
/**
* lr2pc method.
*
* this method convert light year unit to parsec.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
lr2pc(value: number): number;
/**
* lr2au method.
*
* this method convert light year to astronomical unit.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
lr2au(value: number): number;
/**
* lr2meter method.
*
* this method convert light year to meter.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
lr2meter(value: number): number;
/**
* lr2kilometer method.
*
* this method convert light year to kilometer.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
lr2kilometer(value: number): number;
/**
* meter2lr method.
*
* this method convert meter to light year.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
meter2lr(value: number): number;
/**
* au2lr method.
*
* this method convert astronomical unit to light year.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
au2lr(value: number): number;
/**
* pc2lr method.
*
* this method convert parsec to light year.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
pc2lr(value: number): number;
/**
* unit of mass conversion helpers
*/
/**
* kg2ev method.
*
* this method convert kilogram to electronvolt.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
kg2ev(value: number): number;
/**
* ev2kg method.
*
* this method convert kilogram to electronvolt using Albert Einstein formula E=mc2.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @beta
*/
ev2kg(value: number): number;
}