Step | plannerjs - v0.4.1

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

Hierarchy

Step

Implements

IStep

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Step(startLocation: ILocation, stopLocation: ILocation, duration: IProbabilisticValue<DurationMs>, startTime?: Date, stopTime?: Date, distance?: DistanceM, enterConnectionId?: string, exitConnectionId?: string): Step

- Defined in src/planner/Step.ts:72
Parameters
- startLocation: ILocation
- stopLocation: ILocation
- duration: IProbabilisticValue<DurationMs>
- Optional startTime: Date
- Optional stopTime: Date
- Optional distance: DistanceM
- Optional enterConnectionId: string
- Optional exitConnectionId: string
Returns Step

Properties

distance

distance: DistanceM

duration

duration: IProbabilisticValue<DurationMs>

enterConnectionId

enterConnectionId: string

exitConnectionId

exitConnectionId: string

startLocation

startLocation: ILocation

startTime

startTime: Date

stopLocation

stopLocation: ILocation

stopTime

stopTime: Date

Methods

Static compareEquals

compareEquals(step: IStep, otherStep: IStep): boolean

- Defined in src/planner/Step.ts:56
Compare two IStep instances

Parameters
- step: IStep
- otherStep: IStep
Returns boolean

true if the two steps are the same

Static create

create(startLocation: ILocation, stopLocation: ILocation, duration: IProbabilisticValue<DurationMs>, through?: string, startTime?: Date, stopTime?: Date, distance?: DistanceM): IStep

- Defined in src/planner/Step.ts:14
Parameters
- startLocation: ILocation
- stopLocation: ILocation
- duration: IProbabilisticValue<DurationMs>
- Optional through: string
- Optional startTime: Date
- Optional stopTime: Date
- Optional distance: DistanceM
Returns IStep

Static createFromConnections

createFromConnections(enterConnection: IConnection, exitConnection: IConnection): IStep

- Defined in src/planner/Step.ts:34
Parameters
- enterConnection: IConnection
- exitConnection: IConnection
Returns IStep

Generated using TypeDoc