Class PlanSegment

Hierarchy

Segment
- PlanSegment

Implements

Types.PlanSegment

Index

Constructors

Properties

gain grade loss point1 point2 waypoint?

Accessors

alt delay dist elapsed end factors name pace start time tod

Constructors

constructor

new PlanSegment(
    plan: Types.Plan,
    obj: {
        gain: number;
        grade: number;
        loss: number;
        point1: Types.PlanPoint;
        point2: Types.PlanPoint;
    },
): Models.PlanSegment
Parameters
- plan: Types.Plan
- obj: {
      gain: number;
      grade: number;
      loss: number;
      point1: Types.PlanPoint;
      point2: Types.PlanPoint;
  }
Returns Models.PlanSegment
Overrides Segment.constructor
- Defined in models/Segment.ts:112

Properties

gain

gain: number

elevation gain (m) over segment

grade

grade: number

average grade (%) over segment

loss

loss: number

elevation loss (m) over segment

point1

point1: Types.PlanPoint

point2

point2: Types.PlanPoint

`Optional`waypoint

waypoint?: Types.Waypoint

waypoint at end of segment

Accessors

alt

get alt(): number
altitude (m) at end of segment

Returns number
Implementation of PlanSegment.alt
Inherited from Segment.alt
- Defined in models/Segment.ts:81

delay

get delay(): number
delay (s) over segment

Returns number
Implementation of PlanSegment.delay
- Defined in models/Segment.ts:133
set delay(_v: number): void
delay (s) over segment
Parameters
- _v: number
Returns void
Implementation of PlanSegment.delay
- Defined in models/Segment.ts:157

dist

get dist(): number
distance (km) of segment

Returns number
Implementation of PlanSegment.dist
Inherited from Segment.dist
- Defined in models/Segment.ts:73

elapsed

get elapsed(): number
elapsed time (s) over segment

Returns number
Implementation of PlanSegment.elapsed
- Defined in models/Segment.ts:144
set elapsed(_v: number): void
elapsed time (s) over segment
Parameters
- _v: number
Returns void
Implementation of PlanSegment.elapsed
- Defined in models/Segment.ts:159

end

get end(): number
location along course (km) at end of segment

Returns number
Implementation of PlanSegment.end
Inherited from Segment.end
- Defined in models/Segment.ts:77

factors

get factors(): factors.Factors
Returns factors.Factors
Implementation of PlanSegment.factors
- Defined in models/Segment.ts:164

name

get name(): undefined | string
Returns undefined | string
Implementation of PlanSegment.name
Inherited from Segment.name
- Defined in models/Segment.ts:65

pace

get pace(): number
moving pace (s/km) over segment

Returns number
Implementation of PlanSegment.pace
- Defined in models/Segment.ts:128
set pace(_v: number): void
moving pace (s/km) over segment
Parameters
- _v: number
Returns void
Implementation of PlanSegment.pace
- Defined in models/Segment.ts:158

start

get start(): number
location along course (km) at start of segment

Returns number
Implementation of PlanSegment.start
Inherited from Segment.start
- Defined in models/Segment.ts:69

time

get time(): number
moving time (s) over segment

Returns number
Implementation of PlanSegment.time
- Defined in models/Segment.ts:148
set time(_v: number): void
moving time (s) over segment
Parameters
- _v: number
Returns void
Implementation of PlanSegment.time
- Defined in models/Segment.ts:160

tod

get tod(): number
time of day (s) at end of segment

Returns number
Implementation of PlanSegment.tod
- Defined in models/Segment.ts:152
set tod(_v: number): void
time of day (s) at end of segment
Parameters
- _v: number
Returns void
Implementation of PlanSegment.tod
- Defined in models/Segment.ts:161