ootk
Version:
Orbital Object Toolkit including Multiple Propagators, Initial Orbit Determination, and Maneuver Calculations.
151 lines • 6.16 kB
JavaScript
/**
* @author @thkruz Theodore Kruczek
* @description Orbital Object ToolKit (ootk) is a collection of tools for working
* with satellites and other orbital objects.
* @license AGPL-3.0-or-later
* @copyright (c) 2025 Kruczek Labs LLC
*
* Many of the classes are based off of the work of @david-rc-dayton and his
* Pious Squid library (https://github.com/david-rc-dayton/pious_squid) which
* is licensed under the MIT license.
*
* Orbital Object ToolKit is free software: you can redistribute it and/or modify it under the
* terms of the GNU Affero General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* Orbital Object ToolKit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License along with
* Orbital Object ToolKit. If not, see <http://www.gnu.org/licenses/>.
*/
import { SpaceObjectType } from '../types/types.js';
export class BaseObject {
id;
name;
type;
position; // Where is the object
totalVelocity; // How fast is the object moving
velocity; // How fast is the object moving
active = true; // Is the object active
constructor(info) {
this.type = info.type ?? SpaceObjectType.UNKNOWN;
this.name = info.name ?? 'Unknown';
this.id = info.id ?? -1; // Default to -1 if no id is provided
this.active = info.active ?? true;
// Default to the center of the earth until position is calculated
this.position = info.position ?? {
x: 0,
y: 0,
z: 0,
};
// Default to 0 velocity until velocity is calculated
this.velocity = info.velocity ?? {
x: 0,
y: 0,
z: 0,
};
this.totalVelocity = Math.sqrt(this.velocity.x ** 2 + this.velocity.y ** 2 + this.velocity.z ** 2);
}
/**
* Checks if the object is a satellite.
* @returns True if the object is a satellite, false otherwise.
*/
isSatellite() {
return false;
}
/**
* Checks if the object is a ground object.
* @returns True if the object is a ground object, false otherwise.
*/
isGroundObject() {
return false;
}
/**
* Returns whether the object is a sensor.
* @returns True if the object is a sensor, false otherwise.
*/
isSensor() {
return false;
}
/**
* Checks if the object is a marker.
* @returns True if the object is a marker, false otherwise.
*/
isMarker() {
return false;
}
/**
* Returns whether the object's position is static.
* @returns True if the object is static, false otherwise.
*/
isStatic() {
return this.velocity.x === 0 && this.velocity.y === 0 && this.velocity.z === 0;
}
isPayload() {
return this.type === SpaceObjectType.PAYLOAD;
}
isRocketBody() {
return this.type === SpaceObjectType.ROCKET_BODY;
}
isDebris() {
return this.type === SpaceObjectType.DEBRIS;
}
isStar() {
return this.type === SpaceObjectType.STAR;
}
isMissile() {
return this.type === SpaceObjectType.BALLISTIC_MISSILE;
}
isNotional() {
return this.type === SpaceObjectType.NOTIONAL;
}
getTypeString() {
const typeToStringMap = {
[SpaceObjectType.UNKNOWN]: 'Unknown',
[SpaceObjectType.PAYLOAD]: 'Payload',
[SpaceObjectType.ROCKET_BODY]: 'Rocket Body',
[SpaceObjectType.DEBRIS]: 'Debris',
[SpaceObjectType.SPECIAL]: 'Special',
[SpaceObjectType.BALLISTIC_MISSILE]: 'Ballistic Missile',
[SpaceObjectType.STAR]: 'Star',
[SpaceObjectType.INTERGOVERNMENTAL_ORGANIZATION]: 'Intergovernmental Organization',
[SpaceObjectType.SUBORBITAL_PAYLOAD_OPERATOR]: 'Suborbital Payload Operator',
[SpaceObjectType.PAYLOAD_OWNER]: 'Payload Owner',
[SpaceObjectType.METEOROLOGICAL_ROCKET_LAUNCH_AGENCY_OR_MANUFACTURER]: 'Meteorological Rocket Launch Agency or Manufacturer',
[SpaceObjectType.PAYLOAD_MANUFACTURER]: 'Payload Manufacturer',
[SpaceObjectType.LAUNCH_AGENCY]: 'Launch Agency',
[SpaceObjectType.LAUNCH_SITE]: 'Launch Site',
[SpaceObjectType.LAUNCH_POSITION]: 'Launch Position',
[SpaceObjectType.LAUNCH_FACILITY]: 'Launch Facility',
[SpaceObjectType.CONTROL_FACILITY]: 'Control Facility',
[SpaceObjectType.GROUND_SENSOR_STATION]: 'Ground Sensor Station',
[SpaceObjectType.OPTICAL]: 'Optical',
[SpaceObjectType.MECHANICAL]: 'Mechanical',
[SpaceObjectType.PHASED_ARRAY_RADAR]: 'Phased Array Radar',
[SpaceObjectType.OBSERVER]: 'Observer',
[SpaceObjectType.BISTATIC_RADIO_TELESCOPE]: 'Bistatic Radio Telescope',
[SpaceObjectType.COUNTRY]: 'Country',
[SpaceObjectType.LAUNCH_VEHICLE_MANUFACTURER]: 'Launch Vehicle Manufacturer',
[SpaceObjectType.ENGINE_MANUFACTURER]: 'Engine Manufacturer',
};
return typeToStringMap[this.type] ?? 'Unknown';
}
/**
* Validates a parameter value against a minimum and maximum value.
* @param value - The value to be validated.
* @param minValue - The minimum allowed value.
* @param maxValue - The maximum allowed value.
* @param errorMessage - The error message to be thrown if the value is invalid.
*/
validateParameter(value, minValue, maxValue, errorMessage) {
if (typeof minValue !== 'undefined' && minValue !== null && value < minValue) {
throw new Error(errorMessage);
}
if (typeof maxValue !== 'undefined' && maxValue !== null && value > maxValue) {
throw new Error(errorMessage);
}
}
}
//# sourceMappingURL=BaseObject.js.map