@openhps/core/src/data/position/Position.ts

Open Hybrid Positioning System - Core component

import { Unit } from '../../utils';
import { Accuracy } from '../values/Accuracy';

/**
 * General abstract position class consisting of orientation, velocity, position unit and an accuracy.
 * @category Position
 */
export interface Position<U extends Unit> {
    /**
     * Position recording timestamp
     */
    timestamp: number;

    /**
     * Position accuracy
     */
    accuracy: Accuracy<U, any>;

    /**
     * Position probability
     */
    probability: number;

    /**
     * Clone the position
     */
    clone(): this;

    /**
     * Check if this position equals another position
     * @param position Other position
     */
    equals(position: this): boolean;
}