Profile | plannerjs - v0.4.1

A factory that create's an IProfile based on the maximum amount of transfers and/or ITransferProfiles.

implements: IProfile

Hierarchy

Profile
- DynamicProfile

Implements

IProfile

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Profile(amountOfTransfers: number, departureTime?: number, transferProfiles?: ITransferProfile[]): Profile

- Defined in src/planner/public-transport/CSA/data-structure/stops/Profile.ts:30
Parameters
- amountOfTransfers: number
- Optional departureTime: number
- Optional transferProfiles: ITransferProfile[]
Returns Profile

Properties

departureTime

departureTime: number

transferProfiles

transferProfiles: ITransferProfile[]

Methods

getArrivalTimeByTransfers

getArrivalTimeByTransfers(tripId?: string): IArrivalTimeByTransfers

- Defined in src/planner/public-transport/CSA/data-structure/stops/Profile.ts:61
Parameters
- Optional tripId: string
Returns IArrivalTimeByTransfers

Abstract getCost

getCost(from: ILocation, to: ILocation, way: RoutableTileWay): number

- Defined in src/entities/profile/Profile.ts:20
Parameters
- from: ILocation
- to: ILocation
- way: RoutableTileWay
Returns number

Abstract getDefaultSpeed

getDefaultSpeed(): number

- Defined in src/entities/profile/Profile.ts:12
Returns number

Abstract getDistance

getDistance(from: ILocation, to: ILocation, way: RoutableTileWay): DistanceM

- Defined in src/entities/profile/Profile.ts:16
Parameters
- from: ILocation
- to: ILocation
- way: RoutableTileWay
Returns DistanceM

Abstract getDuration

getDuration(from: ILocation, to: ILocation, way: RoutableTileWay): DurationMs

- Defined in src/entities/profile/Profile.ts:17
Parameters
- from: ILocation
- to: ILocation
- way: RoutableTileWay
Returns DurationMs

Abstract getID

getID(): string

- Defined in src/entities/profile/Profile.ts:7
Returns string

Abstract getMaxSpeed

getMaxSpeed(): number

- Defined in src/entities/profile/Profile.ts:13
Returns number

Abstract getMultiplier

getMultiplier(way: RoutableTileWay): number

- Defined in src/entities/profile/Profile.ts:19
Parameters
- way: RoutableTileWay
Returns number

Abstract getObstacleTime

getObstacleTime(node: RoutableTileNode): DurationMs

- Defined in src/entities/profile/Profile.ts:23
Parameters
- node: RoutableTileNode
Returns DurationMs

Abstract getSpeed

getSpeed(way: RoutableTileWay): number

- Defined in src/entities/profile/Profile.ts:14
Parameters
- way: RoutableTileWay
Returns number

Abstract hasAccess

hasAccess(way: RoutableTileWay): boolean

- Defined in src/entities/profile/Profile.ts:10
Parameters
- way: RoutableTileWay
Returns boolean

isDominated

isDominated(arrivalTimeByTransfers: IArrivalTimeByTransfers, departureTime: number): boolean

- Defined in src/planner/public-transport/CSA/data-structure/stops/Profile.ts:50
Parameters
- arrivalTimeByTransfers: IArrivalTimeByTransfers
- departureTime: number
Returns boolean

Abstract isObstacle

isObstacle(node: RoutableTileNode): boolean

- Defined in src/entities/profile/Profile.ts:22
Parameters
- node: RoutableTileNode
Returns boolean

Abstract isOneWay

isOneWay(way: RoutableTileWay): boolean

- Defined in src/entities/profile/Profile.ts:9
Parameters
- way: RoutableTileWay
Returns boolean

Static create

create(amountOfTransfers: number): Profile

- Defined in src/planner/public-transport/CSA/data-structure/stops/Profile.ts:12
Parameters
- amountOfTransfers: number
Returns Profile

Static createFromTransfers

createFromTransfers(departureTime: number, transferProfiles?: ITransferProfile[]): Profile

- Defined in src/planner/public-transport/CSA/data-structure/stops/Profile.ts:18
Parameters
- departureTime: number
- Optional transferProfiles: ITransferProfile[]
Returns Profile

Generated using TypeDoc