Class Plan

constructor

• new Plan(course: Types.Course, data: PlanData): Models.Plan

• Parameters

  • course: Types.Course
  • data: PlanData

  Returns Models.Plan

_version

Readonlycourse

pacing

Readonlypoints

Readonlysplits

cache

• get cache(): {
      cutoffs?: PlanCutoff[];
      delays?: PlanDelay[];
      event?: Types.Event;
      events?: PlanEvents;
      heatModel?: PlanHeatModel;
      scales?: PlanScales;
      stats?: PlanStats;
      strategy?: factors.Strategy;
      version?: number;
  }

• Returns {
      cutoffs?: PlanCutoff[];
      delays?: PlanDelay[];
      event?: Types.Event;
      events?: PlanEvents;
      heatModel?: PlanHeatModel;
      scales?: PlanScales;
      stats?: PlanStats;
      strategy?: factors.Strategy;
      version?: number;
  }

cutoffMargin

• get cutoffMargin(): undefined | number

• Returns undefined | number

cutoffs

• get 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

  Returns PlanCutoff[]

delay

• get delay(): number

• delay is sum of Plan.delays

  Returns number

delays

• get 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

  Returns PlanDelay[]

event

• get event(): Types.Event

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

  Returns Types.Event

events

• get events(): PlanEvents

• Returns PlanEvents

heatModel

• get heatModel(): | undefined
  | { baseline: number; max: number; start: number; stop: number }

• Returns undefined | { baseline: number; max: number; start: number; stop: number }

id

• get id(): undefined | null | string | number | symbol

• Unique identifier for the plan

  Returns undefined | null | string | number | symbol

method

• get method(): PlanDataMethod

• Method for calculating target time

  Returns PlanDataMethod

name

• get name(): undefined | string

• Display name for the plan

  Returns undefined | string

scales

• get scales(): PlanScales

• Scales for factors

  Returns PlanScales

stats

• get stats(): PlanStats

• Plan stats object

  Returns PlanStats

strategy

• get strategy(): factors.Strategy

• Returns factors.Strategy

target

• get target(): number

• Target time in seconds

  Returns number

typicalDelay

• get typicalDelay(): number

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

  Returns number

version

• get version(): number

• Version of course & plan update (non trivial changes that affect pacing)

  Returns number

checkPacing

• checkPacing(): boolean

• Returns boolean

getDelayAtWaypoint

• getDelayAtWaypoint(waypoint: Types.Waypoint): number

• get delay at input Waypoint

  Parameters

  • waypoint: Types.Waypoint

    waypoint of interest

  Returns number

  delay (sec)

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.
  • insert: boolean = false

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

  Returns Types.PlanPoint

  The PlanPoint at input location.

update

• update(data: PlanUpdateData): void

• Update the plan with new data.

  Parameters

  • data: PlanUpdateData

    Plan update data

  Returns void