Leg | plannerjs - v0.4.1

Hierarchy

Leg

Implements

ILeg

Index

Constructors

constructor

Methods

Constructors

constructor

new Leg(travelMode: TravelMode, steps: IStep[]): Leg

- Defined in src/planner/Leg.ts:26
Parameters
- travelMode: TravelMode
- steps: IStep[]
Returns Leg

Methods

getAverageDuration

getAverageDuration(): DurationMs

Implementation of ILeg.getAverageDuration
- Defined in src/planner/Leg.ts:43
Returns DurationMs

getDistance

getDistance(): DistanceM

Implementation of ILeg.getDistance
- Defined in src/planner/Leg.ts:57
Returns DistanceM

getExpectedDuration

getExpectedDuration(): DurationMs

Implementation of ILeg.getExpectedDuration
- Defined in src/planner/Leg.ts:33
Returns DurationMs

getMaximumDuration

getMaximumDuration(): DurationMs

Implementation of ILeg.getMaximumDuration
- Defined in src/planner/Leg.ts:51
Returns DurationMs

getMinimumDuration

getMinimumDuration(): DurationMs

Implementation of ILeg.getMinimumDuration
- Defined in src/planner/Leg.ts:37
Returns DurationMs

getStartLocation

getStartLocation(): ILocation

Implementation of ILeg.getStartLocation
- Defined in src/planner/Leg.ts:83
Returns ILocation

getStartTime

getStartTime(): Date

Implementation of ILeg.getStartTime
- Defined in src/planner/Leg.ts:71
Returns Date

getSteps

getSteps(): IStep[]

Implementation of ILeg.getSteps
- Defined in src/planner/Leg.ts:67
Returns IStep[]

getStopLocation

getStopLocation(): ILocation

Implementation of ILeg.getStopLocation
- Defined in src/planner/Leg.ts:89
Returns ILocation

getStopTime

getStopTime(): Date

Implementation of ILeg.getStopTime
- Defined in src/planner/Leg.ts:77
Returns Date

getTravelMode

getTravelMode(): TravelMode

Implementation of ILeg.getTravelMode
- Defined in src/planner/Leg.ts:63
Returns TravelMode

Static compareEquals

compareEquals(leg: ILeg, otherLeg: ILeg): boolean

- Defined in src/planner/Leg.ts:9
Parameters
- leg: ILeg
- otherLeg: ILeg
Returns boolean

Generated using TypeDoc