ootk-core/dist/objects/BaseObject.d.ts

Orbital Object Toolkit. A modern typed replacement for satellite.js including SGP4 propagation, TLE parsing, Sun and Moon calculations, and more.

/**
 * @author Theodore Kruczek.
 * @license MIT
 * @copyright (c) 2022-2025 Theodore Kruczek Permission is
 * hereby granted, free of charge, to any person obtaining a copy of this
 * software and associated documentation files (the "Software"), to deal in the
 * Software without restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
import { BaseObjectParams } from '../interfaces/BaseObjectParams.js';
import { EciVec3, SpaceObjectType } from '../types/types.js';
export declare class BaseObject {
    id: number;
    name: string;
    type: SpaceObjectType;
    position: EciVec3;
    totalVelocity: number;
    velocity: EciVec3;
    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;
}