ootk/dist/objects/BaseObject.d.ts

Orbital Object Toolkit including Multiple Propagators, Initial Orbit Determination, and Maneuver Calculations.

/**
 * @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 { BaseObjectParams } from '../interfaces/BaseObjectParams.js';
import { EciVec3, KilometersPerSecond, SpaceObjectType } from '../types/types.js';
export declare class BaseObject {
    id: number;
    name: string;
    type: SpaceObjectType;
    position: EciVec3;
    totalVelocity: number;
    velocity: EciVec3<KilometersPerSecond>;
    active: boolean;
    constructor(info: BaseObjectParams);
    /**
     * Checks if the object is a satellite.
     * @returns True if the object is a satellite, false otherwise.
     */
    isSatellite(): boolean;
    /**
     * Checks if the object is a ground object.
     * @returns True if the object is a ground object, false otherwise.
     */
    isGroundObject(): boolean;
    /**
     * Returns whether the object is a sensor.
     * @returns True if the object is a sensor, false otherwise.
     */
    isSensor(): boolean;
    /**
     * Checks if the object is a marker.
     * @returns True if the object is a marker, false otherwise.
     */
    isMarker(): boolean;
    /**
     * Returns whether the object's position is static.
     * @returns True if the object is static, false otherwise.
     */
    isStatic(): boolean;
    isPayload(): boolean;
    isRocketBody(): boolean;
    isDebris(): boolean;
    isStar(): boolean;
    isMissile(): boolean;
    isNotional(): boolean;
    getTypeString(): string;
    /**
     * 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<T>(value: T, minValue: T, maxValue: T, errorMessage: string): void;
}