Path | plannerjs - v0.4.1

This Path class serves as an implementation of the IPath interface and as a home for some helper functions related to IPath instances

Hierarchy

Path

Implements

IPath

Index

Constructors

constructor

Properties

context
legs

Methods

Constructors

constructor

new Path(legs: ILeg[], context?: object): Path

- Defined in src/planner/Path.ts:37
Parameters
- legs: ILeg[]
- Optional context: object
Returns Path

Properties

context

context: object

legs

legs: ILeg[]

Methods

addPath

addPath(path: IPath): void

- Defined in src/planner/Path.ts:73
Parameters
- path: IPath
Returns void

addToContext

addToContext(id: string, value: any): void

Implementation of IPath.addToContext
- Defined in src/planner/Path.ts:53
Parameters
- id: string
- value: any
Returns void

appendLeg

appendLeg(leg: ILeg): void

- Defined in src/planner/Path.ts:69
Parameters
- leg: ILeg
Returns void

getArrivalTime

getArrivalTime(query: IQuery): Date

Implementation of IPath.getArrivalTime
- Defined in src/planner/Path.ts:94
Parameters
- query: IQuery
Returns Date

getContext

getContext(): object

Implementation of IPath.getContext
- Defined in src/planner/Path.ts:57
Returns object

getDepartureTime

getDepartureTime(query: IQuery): Date

Implementation of IPath.getDepartureTime
- Defined in src/planner/Path.ts:81
Parameters
- query: IQuery
Returns Date

getFromContext

getFromContext(id: string): any

Implementation of IPath.getFromContext
- Defined in src/planner/Path.ts:61
Parameters
- id: string
Returns any

getStartLocationId

getStartLocationId(): string

- Defined in src/planner/Path.ts:77
Returns string

getTransferTime

getTransferTime(query: IQuery): DurationMs

Implementation of IPath.getTransferTime
- Defined in src/planner/Path.ts:111
Parameters
- query: IQuery
Returns DurationMs

getTravelTime

getTravelTime(query: IQuery): DurationMs

Implementation of IPath.getTravelTime
- Defined in src/planner/Path.ts:107
Parameters
- query: IQuery
Returns DurationMs

prependLeg

prependLeg(leg: ILeg): void

- Defined in src/planner/Path.ts:65
Parameters
- leg: ILeg
Returns void

updateContext

updateContext(other: object): void

Implementation of IPath.updateContext
- Defined in src/planner/Path.ts:49
Parameters
- other: object
Returns void

Static compareEquals

compareEquals(path: IPath, otherPath: IPath): boolean

- Defined in src/planner/Path.ts:24
Compare two IPath instances

Parameters
- path: IPath
- otherPath: IPath
Returns boolean

true if the two paths are the same

Static create

create(): Path

- Defined in src/planner/Path.ts:14
Returns Path

Generated using TypeDoc