object_ref.ts

import { Nub } from "../nub";
import { ParamDefinition } from "../param/param-definition";
import { INamedIterableValues } from "../param/param-value-iterator";
import { ParamValueMode } from "../param/param-value-mode";
import { ParamValues } from "../param/param-values";
import { Message, MessageCode } from "../util/message";

export class LinkedValue {
    /** linked value metadata (ex: calculator title for GUI) */
    public meta: any;

    /** target Nub */
    private _nub: Nub;

    /** target value : ParamDefinition (possibly in CALC mode) | undefined (ExtraResults) */
    private _element: INamedIterableValues;

    /** parameter / result symbol (ex: "Q") */
    private _symbol: string;

    constructor(nub: Nub, element: INamedIterableValues, symbol: string, meta: any = {}) {
        this._nub = nub;
        this._element = element;
        this._symbol = symbol;
        this.meta = meta;
    }

    public get nub() { return this._nub; }
    public get element() { return this._element; }
    public get symbol() { return this._symbol; }

    /**
     * Returns true if targetted value is a ParamDefinition (in CALC mode or not),
     * and not an extra result
     */
    public isParameter(): boolean {
        return (this.element instanceof ParamDefinition);
    }

    /**
     * Returns true if targetted value is a ParamDefinition in CALC mode
     * (might not have any value yet)
     */
    public isResult(): boolean {
        return (
            this.isParameter()
            && (this.element as ParamDefinition).valueMode === ParamValueMode.CALCUL
        );
    }

    /**
     * Returns true if targetted value is an extra result
     * (might not have any value yet)
     */
    public isExtraResult(): boolean {
        return (
            this.nub !== undefined
            && this.symbol !== undefined
            && ! this.isParameter()
        );
    }

    /**
     * Returns true if v and the current objects have the same :
     *  - Nub UID
     *  - symbol
     *  - value type (Parameter / Result)
     * (ignores metadata)
     * @param v
     */