Class Activity

Index

Constructors

Properties

canHaveOperations check generateId getEndDate getOperations getRouteId getStartDate

Constructors

constructor

new Activity(): Activity
Returns Activity

Properties

`Static` canHaveOperations

canHaveOperations: ((activity) => boolean) = canHaveOperations

Type declaration

- (activity): boolean
- can the activity have operations
  Parameters
  - activity: ARActivity
  Returns boolean

`Static` check

check: ((activity) => void) = check

Type declaration

- (activity): void
- perform multiple integrity checks and throw an Error if not fullfilled
  Parameters
  - activity: ARActivity
  Returns void

`Static` generateId

generateId: ((activity, routeId, index) => string) = generateId

Type declaration

- (activity, routeId, index): string
- generate activity id
  Parameters
  - activity: ARActivity
  - routeId: string
  - index: number
    //usable within a map function (for example) to differenciate id for activity with same sites
  Returns string

`Static` getEndDate

getEndDate: ((activity) => Date) = getEndDate

Type declaration

- (activity): Date
- return activity end Date
  Parameters
  - activity: ARActivity
  Returns Date

`Static` getOperations

getOperations: ((activity, arState) => AROperation[]) = getOperations

Type declaration

- (activity, arState): AROperation[]
- get all operations from given activity
  Parameters
  - activity: ARActivity
  - arState: ARBaseState
  Returns AROperation[]

`Static` getRouteId

getRouteId: ((activityId) => undefined | string) = getRouteId

Type declaration

- (activityId): undefined | string
- get routeId from activity
  Parameters
  - activityId: string
  Returns undefined | string

`Static` getStartDate

getStartDate: ((activity) => Date) = getStartDate

Type declaration

- (activity): Date
- return activity start Date
  Parameters
  - activity: ARActivity
  Returns Date

Generated using TypeDoc