Class TurnData

constructor

• new TurnData(
      state: TURN_STATE,
      restrictions?: TurnRestriction[],
      instructionOpcode?: null | OP_CODE_TYPE,
      segmentPath?: number[],
      lanes?: null | TurnLaneData,
      turnGuidance?: null | TurnGuidance,
      junctionID?: null | number,
      pathID?: null | number,
  ): TurnData

  Parameters

  • state: TURN_STATE
  • restrictions: TurnRestriction[] = []
  • instructionOpcode: null | OP_CODE_TYPE = null
  • segmentPath: number[] = []
  • lanes: null | TurnLaneData = null
  • turnGuidance: null | TurnGuidance = null
  • junctionID: null | number = null
  • pathID: null | number = null

  Returns TurnData

StaticALLOWED_TURN

StaticDISALLOWED_TURN

StaticUNKNOWN_TURN

countNonDifficultTimeRestrictions

• countNonDifficultTimeRestrictions(): number

  Returns number

getInstructionOpcode

• getInstructionOpcode(): null | OP_CODE_TYPE

  Returns null | OP_CODE_TYPE

getLaneData

• getLaneData(): null | TurnLaneData

  Returns null | TurnLaneData

getPathID

• getPathID(): null | number

  Returns null | number

getRestrictions

• getRestrictions(): TurnRestriction[]

  Returns TurnRestriction[]

getSegmentPath

• getSegmentPath(): number[]

  Returns number[]

getSegmentPathLength

• getSegmentPathLength(): number

  Returns number

getTurnGuidance

• getTurnGuidance(): null | TurnGuidance

  Returns null | TurnGuidance

hasAdditionalData

• hasAdditionalData(): boolean

  Returns boolean

hasInstructionOpcode

• hasInstructionOpcode(): boolean

  Returns boolean

hasLanes

• hasLanes(): boolean

  Returns boolean

hasRestrictions

• hasRestrictions(): boolean

  Returns boolean

hasSegmentPath

• hasSegmentPath(): boolean

  Returns boolean

hasTurnGuidance

• hasTurnGuidance(): boolean

  Returns boolean

isAllowed

• isAllowed(): boolean

  Returns boolean

isDifficult

• isDifficult(): boolean

  Returns boolean

isDifficultTimeRestricted

• isDifficultTimeRestricted(): boolean

  Returns boolean

isDisallowed

• isDisallowed(): boolean

  Returns boolean

isJunctionBoxTurn

• isJunctionBoxTurn(): boolean

  Returns boolean

isNonDifficultTimeRestricted

• isNonDifficultTimeRestricted(): boolean

  Returns boolean

isNot24Seven

• isNot24Seven(): boolean

  Returns boolean

isPathTurn

• isPathTurn(): boolean

  Returns boolean

isUnknown

• isUnknown(): boolean

  Returns boolean

setPathID

• setPathID(pathId: null | number): void

  Parameters

  • pathId: null | number

  Returns void

toString

• toString(): string

  Returns string

with24SevenDifficulty

• with24SevenDifficulty(difficult: boolean): TurnData

  Parameters

  • difficult: boolean

  Returns TurnData

withInstructionOpcode

• withInstructionOpcode(instructionOpcode: null | OP_CODE_TYPE): TurnData

  Parameters

  • instructionOpcode: null | OP_CODE_TYPE

  Returns TurnData

withJunctionId

• withJunctionId(junctionID: null | number): TurnData

  Parameters

  • junctionID: null | number

  Returns TurnData

withLanes

• withLanes(lanes: TurnLaneData): TurnData

  Parameters

  • lanes: TurnLaneData

  Returns TurnData

withoutDifficultRestrictions

• withoutDifficultRestrictions(): TurnData

  Returns TurnData

withPathID

• withPathID(pathId: null | number): TurnData

  Parameters

  • pathId: null | number

  Returns TurnData

withRestrictions

• withRestrictions(restrictions: TurnRestriction[]): TurnData

  Parameters

  • restrictions: TurnRestriction[]

  Returns TurnData

withSegmentPath

• withSegmentPath(segmentPath: number[]): TurnData

  Parameters

  • segmentPath: number[]

  Returns TurnData

withState

• withState(state: TURN_STATE): TurnData

  Parameters

  • state: TURN_STATE

  Returns TurnData

withToggledState

• withToggledState(enabled: boolean): TurnData

  Parameters

  • enabled: boolean

  Returns TurnData

withTurnGuidance

• withTurnGuidance(turnGuidance: null | TurnGuidance): TurnData

  Parameters

  • turnGuidance: null | TurnGuidance

  Returns TurnData

Staticcreate

• create(
      state: TURN_STATE,
      restrictions?: TurnRestriction[],
      instructionOpcode?: null | OP_CODE_TYPE,
      segmentPath?: number[],
      lanes?: null | TurnLaneData,
      turnGuidance?: null | TurnGuidance,
      junctionID?: null | number,
      pathID?: null | number,
  ): TurnData

  Parameters

  • state: TURN_STATE
  • restrictions: TurnRestriction[] = []
  • instructionOpcode: null | OP_CODE_TYPE = null
  • segmentPath: number[] = []
  • lanes: null | TurnLaneData = null
  • turnGuidance: null | TurnGuidance = null
  • junctionID: null | number = null
  • pathID: null | number = null

  Returns TurnData