Class TurnClosures

Methods for dealing with TurnClosures.

Index

Methods

addClosure getAll getById

Methods

addClosure

addClosure(
    args: {
        description: string;
        endDate: number;
        majorTrafficEventId?: string;
        startDate: number;
        turnId: string;
    },
): TurnClosure
Adds a new turn closure to the WME data model.
Parameters
- args: {
      description: string;
      endDate: number;
      majorTrafficEventId?: string;
      startDate: number;
      turnId: string;
  }
  - description: string
    The description of the turn closure.
  - endDate: number
    The end date of the turn closure as a Unix timestamp (milliseconds).
  - OptionalmajorTrafficEventId?: string
    The id of the major traffic event associated with the turn closure (optional).
  - startDate: number
    The start date of the turn closure as a Unix timestamp (milliseconds).
  - turnId: string
    The id of the turn that this closure applies to.
Returns TurnClosure
The newly created turn closure object.

Throws
DataModelNotFoundError if the specified turn or its segments cannot be found in the data model.

Throws
DataModelNotFoundError if the majorTrafficEventId is provided and cannot be found in the data model.

Throws
InvalidStateError if the turn is not allowed.

getAll

getAll(): TurnClosure[]
Returns TurnClosure[]
an array of all the turn closures in the WME data model

getById

getById(args: { turnClosureId: string }): null | TurnClosure
Parameters
- args: { turnClosureId: string }
  - turnClosureId: string
    An id of the turn closure to find.
Returns null | TurnClosure
turn closure with id, or null if not found in the WME data model