Class RouteFile

Hierarchy

StatsClassAbstract
- RouteFile

Implements

RouteFileInterface

Index

Constructors

constructor

new RouteFile(
    name?: string,
    srcFileType?: string,
    creator?: CreatorInterface,
    routes?: RouteInterface[],
    waypoints?: RouteWaypointInterface[],
    createdAt?: Date | null,
): RouteFile
Parameters
- name: string = 'New Route File'
- srcFileType: string = FileType.GPX
- creator: CreatorInterface = ...
- routes: RouteInterface[] = []
- waypoints: RouteWaypointInterface[] = []
- createdAt: Date | null = null
Returns RouteFile
Overrides StatsClassAbstract.constructor
- Defined in src/routes/route-file.ts:21

Properties

createdAt

createdAt: Date | null

creator

creator: CreatorInterface

name

name: string

srcFileType

srcFileType: string

stats

stats: Map<string, DataInterface<DefaultDataValue>> = ...

Methods

addRoute

addRoute(route: RouteInterface): this
Parameters
- route: RouteInterface
Returns this
Implementation of RouteFileInterface.addRoute
- Defined in src/routes/route-file.ts:38

addRoutes

addRoutes(routes: RouteInterface[]): this
Parameters
- routes: RouteInterface[]
Returns this
Implementation of RouteFileInterface.addRoutes
- Defined in src/routes/route-file.ts:43

addStat

addStat(stat: DataInterface<unknown>): void
Parameters
- stat: DataInterface<unknown>
Returns void
Implementation of RouteFileInterface.addStat
Inherited from StatsClassAbstract.addStat
- Defined in src/stats/stats.class.abstract.ts:37

addWaypoint

addWaypoint(waypoint: RouteWaypointInterface): this
Parameters
- waypoint: RouteWaypointInterface
Returns this
Implementation of RouteFileInterface.addWaypoint
- Defined in src/routes/route-file.ts:65

addWaypoints

addWaypoints(waypoints: RouteWaypointInterface[]): this
Parameters
- waypoints: RouteWaypointInterface[]
Returns this
Implementation of RouteFileInterface.addWaypoints
- Defined in src/routes/route-file.ts:70

clearRoutes

clearRoutes(): this
Returns this
Implementation of RouteFileInterface.clearRoutes
- Defined in src/routes/route-file.ts:48

clearStats

clearStats(): void
Returns void
Implementation of RouteFileInterface.clearStats
Inherited from StatsClassAbstract.clearStats
- Defined in src/stats/stats.class.abstract.ts:29

getDistance

getDistance(): DataDistance
Returns DataDistance
Implementation of RouteFileInterface.getDistance
Inherited from StatsClassAbstract.getDistance
- Defined in src/stats/stats.class.abstract.ts:9

getFirstRoute

getFirstRoute(): RouteInterface
Returns RouteInterface
Implementation of RouteFileInterface.getFirstRoute
- Defined in src/routes/route-file.ts:57

getID

getID(): string | null
Returns string | null
Implementation of RouteFileInterface.getID
Inherited from StatsClassAbstract.getID
- Defined in src/id/id.abstract.class.ts:6

getRoutes

getRoutes(): RouteInterface[]
Returns RouteInterface[]
Implementation of RouteFileInterface.getRoutes
- Defined in src/routes/route-file.ts:53

getStat

getStat<TValue = DefaultDataValue>(
statType: string,
): void | DataInterface<TValue>
Type Parameters
- TValue = DefaultDataValue
Parameters
- statType: string
Returns void | DataInterface<TValue>
Implementation of RouteFileInterface.getStat
Inherited from StatsClassAbstract.getStat
- Defined in src/stats/stats.class.abstract.ts:13

getStats

getStats<TValue = DefaultDataValue>(): Map<string, DataInterface<TValue>>
Type Parameters
- TValue = DefaultDataValue
Returns Map<string, DataInterface<TValue>>
Implementation of RouteFileInterface.getStats
Inherited from StatsClassAbstract.getStats
- Defined in src/stats/stats.class.abstract.ts:17

getStatsAsArray

getStatsAsArray<TValue = DefaultDataValue>(): DataInterface<TValue>[]
Type Parameters
- TValue = DefaultDataValue
Returns DataInterface<TValue>[]
Implementation of RouteFileInterface.getStatsAsArray
Inherited from StatsClassAbstract.getStatsAsArray
- Defined in src/stats/stats.class.abstract.ts:21

getWaypoints

getWaypoints(): RouteWaypointInterface[]
Returns RouteWaypointInterface[]
Implementation of RouteFileInterface.getWaypoints
- Defined in src/routes/route-file.ts:75

hasRoutes

hasRoutes(): boolean
Returns boolean
Implementation of RouteFileInterface.hasRoutes
- Defined in src/routes/route-file.ts:61

removeStat

removeStat(statType: string): void
Parameters
- statType: string
Returns void
Implementation of RouteFileInterface.removeStat
Inherited from StatsClassAbstract.removeStat
- Defined in src/stats/stats.class.abstract.ts:25

setDistance

setDistance(distance: DataDistance): void
Parameters
- distance: DataDistance
Returns void
Implementation of RouteFileInterface.setDistance
Inherited from StatsClassAbstract.setDistance
- Defined in src/stats/stats.class.abstract.ts:33

setID

setID(id: string): RouteFile
Parameters
- id: string
Returns RouteFile
Implementation of RouteFileInterface.setID
Inherited from StatsClassAbstract.setID
- Defined in src/id/id.abstract.class.ts:10

toJSON

toJSON(): RouteFileJSONInterface
Returns RouteFileJSONInterface
Implementation of RouteFileInterface.toJSON
- Defined in src/routes/route-file.ts:79