Interface Plan

interface Plan {
    course: Types.Course;
    cutoffMargin?: number;
    cutoffs?: PlanCutoff[];
    delay: number;
    delays: PlanDelay[];
    event: Types.Event;
    events: PlanEvents;
    heatModel:
        | undefined
        | { baseline: number; max: number; start: number; stop: number };
    id?: null | string | number | symbol;
    method: PlanDataMethod;
    name?: string;
    pacing: Types.Pacing;
    points: Types.PlanPoint[];
    scales: PlanScales;
    splits: PlanSplits;
    stats: PlanStats;
    strategy: factors.Strategy;
    target: number;
    typicalDelay: number;
    version: number;
    checkPacing(): void;
    getDelayAtWaypoint(waypoint: Types.Waypoint): number;
    getPoint(loc: number, insert?: boolean): Types.PlanPoint;
    update(data: PlanUpdateData): void;
}

Implemented by

Properties

course cutoffMargin? cutoffs? delay delays event events heatModel id? method name? pacing points scales splits stats strategy target typicalDelay version

Methods

checkPacing getDelayAtWaypoint getPoint update

Properties

Readonlycourse

course: Types.Course

Optional ReadonlycutoffMargin

cutoffMargin?: number

Optional Readonlycutoffs

cutoffs?: PlanCutoff[]

cutoffs array is calculated on get as a combination of the course cutoffs and the plan points gets re-calculated if the course or plan version changes

Readonlydelay

delay: number

delay is sum of Plan.delays

Readonlydelays

delays: PlanDelay[]

delays array is calculated on get as a combination of the specified delays and default delays based on waypoint types gets re-calculated if the course or plan version changes

Readonlyevent

event: Types.Event

Event object gets re-calculated if the course or plan version changes

Readonlyevents

events: PlanEvents

ReadonlyheatModel

heatModel:
    | undefined
    | { baseline: number; max: number; start: number; stop: number }

Optional Readonlyid

id?: null | string | number | symbol

Unique identifier for the plan

Readonlymethod

method: PlanDataMethod

Method for calculating target time

Optional Readonlyname

name?: string

Display name for the plan

Readonlypacing

pacing: Types.Pacing

Readonlypoints

points: Types.PlanPoint[]

Readonlyscales

scales: PlanScales

Scales for factors

Readonlysplits

splits: PlanSplits

splits

Readonlystats

stats: PlanStats

Plan stats object

Readonlystrategy

strategy: factors.Strategy

Readonlytarget

target: number

Target time in seconds

ReadonlytypicalDelay

typicalDelay: number

Typical delay for the plan; amount of dwell time at waypoints where 'hasDelay' is true

Readonlyversion

version: number

version of plan update (non-trivial changes that affect pacing)

Methods

checkPacing

getDelayAtWaypoint

getPoint

  • getPoint(loc: number, insert?: boolean): Types.PlanPoint

  • Finds and optionally inserts a point at an input location.

    Parameters

    • loc: number

      The location (in km) to determine value.

    • Optionalinsert: boolean

      Whether to also insert a created point into the points array. Defaults to false.

    Returns Types.PlanPoint

    The PlanPoint at input location.

update

Settings

Member Visibility

On This Page

Properties
Methods