Table of Contents

Class RoutePlanItem

Namespace
Geotab.Checkmate.ObjectModel
Assembly
Geotab.Checkmate.ObjectModel.dll

The class representing an individual item in a planned Route.

public class RoutePlanItem : Entity, IEntity, IComparable, IIdentifiable, IDateTimeProvider
Inheritance
RoutePlanItem
Implements
Derived
Inherited Members

Constructors

RoutePlanItem()

Initializes a new instance of the RoutePlanItem class.

public RoutePlanItem()

RoutePlanItem(Id?, Zone?, Route?, DateTime?, DateTime?, int?)

Initializes a new instance of the RoutePlanItem class.

public RoutePlanItem(Id? id, Zone? zone, Route? route, DateTime? activeFrom, DateTime? activeTo, int? passCount)

Parameters

id Id

The Id.

zone Zone

The Zone linked to the Route entry.

route Route

The Route associated with this plan.

activeFrom DateTime?

The start date of the route plan.

activeTo DateTime?

The end date of the route plan.

passCount int?

The expected number of passes though the Zone.

RoutePlanItem(Id?, Zone?, Route?, int?, DateTime?, DateTime?, DateTime?, DateTime?, bool?, string)

Initializes a new instance of the RoutePlanItem class.

public RoutePlanItem(Id? id, Zone? zone, Route? route, int? sequence, DateTime? activeFrom, DateTime? activeTo, DateTime? arrivalWindowStart, DateTime? arrivalWindowEnd, bool? nonOptimizable = false, string comment = "")

Parameters

id Id

The Id.

zone Zone

The Zone linked to the Route entry.

route Route

The Route associated with this plan.

sequence int?

The sequence number within the plan.

activeFrom DateTime?

The start date of the route plan.

activeTo DateTime?

The end date of the route plan.

arrivalWindowStart DateTime?

Arrival window start.

arrivalWindowEnd DateTime?

Arrival window end.

nonOptimizable bool?

NonOptimizable flag.

comment string

Comment for a stop within the plan.

RoutePlanItem(Id?, Zone?, Route?, int?, DateTime?, DateTime?, string)

Initializes a new instance of the RoutePlanItem class.

public RoutePlanItem(Id? id, Zone? zone, Route? route, int? sequence, DateTime? activeFrom, DateTime? activeTo, string comment = "")

Parameters

id Id

The Id.

zone Zone

The Zone linked to the Route entry.

route Route

The Route associated with this plan.

sequence int?

The sequence number within the plan.

activeFrom DateTime?

The start date of the route plan.

activeTo DateTime?

The end date of the route plan.

comment string

Comment for a stop within the plan.

RoutePlanItem(Id?, Zone?, Route?, int?, DateTime?, TimeSpan?, float?, TimeSpan?, DateTime?, DateTime?, bool?, string)

Initializes a new instance of the RoutePlanItem class.

public RoutePlanItem(Id? id, Zone? zone, Route? route, int? sequence, DateTime? expectedDateTime, TimeSpan? expectedStopDuration, float? expectedDistanceToArrival, TimeSpan? expectedTripDurationToArrival, DateTime? arrivalWindowStart, DateTime? arrivalWindowEnd, bool? nonOptimizable = false, string comment = "")

Parameters

id Id

The Id.

zone Zone

The Zone linked to the Route entry.

route Route

The Route associated with this plan.

sequence int?

The sequence number within the plan.

expectedDateTime DateTime?

Expected DateTime of arrival.

expectedStopDuration TimeSpan?

Expected stop duration.

expectedDistanceToArrival float?

Expected trip distance to arrive at the zone.

expectedTripDurationToArrival TimeSpan?

Expected trip time to arrive at the zone.

arrivalWindowStart DateTime?

Arrival window start.

arrivalWindowEnd DateTime?

Arrival window end.

nonOptimizable bool?

Non Optimizable.

comment string

Comment for a stop within the plan.

RoutePlanItem(Id?, Zone?, Route?, int?, DateTime?, TimeSpan?, float?, TimeSpan?, string)

Initializes a new instance of the RoutePlanItem class.

public RoutePlanItem(Id? id, Zone? zone, Route? route, int? sequence, DateTime? expectedDateTime, TimeSpan? expectedStopDuration, float? expectedDistanceToArrival, TimeSpan? expectedTripDurationToArrival, string comment = "")

Parameters

id Id

The Id.

zone Zone

The Zone linked to the Route entry.

route Route

The Route associated with this plan.

sequence int?

The sequence number within the plan.

expectedDateTime DateTime?

Expected DateTime of arrival.

expectedStopDuration TimeSpan?

Expected stop duration.

expectedDistanceToArrival float?

Expected trip distance to arrive at the zone.

expectedTripDurationToArrival TimeSpan?

Expected trip time to arrive at the zone.

comment string

Comment for a stop within the plan.

RoutePlanItem(RoutePlanItem)

Initializes a new instance of the RoutePlanItem class. Copy Constructor - Initializes a new instance of the RoutePlanItem class.

protected RoutePlanItem(RoutePlanItem routePlanItem)

Parameters

routePlanItem RoutePlanItem

RoutePlanItem

Properties

ActiveFrom

Gets or sets the start date for the plan item.

public DateTime? ActiveFrom { get; set; }

Property Value

DateTime?

DateTime

ActiveTo

Gets or sets the end date for the plan item.

public DateTime? ActiveTo { get; set; }

Property Value

DateTime?

DateTime

ArrivalTime

Gets or sets the arrival time of the assigned vehicle.

public DateTime? ArrivalTime { get; set; }

Property Value

DateTime?

DateTime

ArrivalWindowEnd

Gets or sets the arrival window end.

public DateTime? ArrivalWindowEnd { get; set; }

Property Value

DateTime?

DateTime

ArrivalWindowStart

Gets or sets the arrival window start.

public DateTime? ArrivalWindowStart { get; set; }

Property Value

DateTime?

DateTime

Comment

Gets or sets a free text field where any user information can be stored and referenced for this entity. Default [""].

public string? Comment { get; set; }

Property Value

string

User comments.

DateTime

Gets expected date and time of arrival.

public DateTime? DateTime { get; }

Property Value

DateTime?

DateTime

DepartureTime

Gets or sets the departure time of assigned vehicle.

public DateTime? DepartureTime { get; set; }

Property Value

DateTime?

DateTime

ExpectedDistanceToArrival

Gets or sets expected trip distance to arrival.

public float? ExpectedDistanceToArrival { get; set; }

Property Value

float?

float

ExpectedStopDuration

Gets or sets expected stop duration in milliseconds.

public TimeSpan? ExpectedStopDuration { get; set; }

Property Value

TimeSpan?

TimeSpan

ExpectedTripDurationToArrival

Gets or sets expected trip time to arrival in milliseconds.

public TimeSpan? ExpectedTripDurationToArrival { get; set; }

Property Value

TimeSpan?

TimeSpan

NonOptimizable

Gets or sets a value indicating whether route plan item is optimizable or non optimizable.

public bool? NonOptimizable { get; set; }

Property Value

bool?

bool

PassCount

Gets or sets the expected number of passes through the Zone.

public int? PassCount { get; set; }

Property Value

int?

int

PreviousSequence

Gets or sets the previous sequence number of the route plan item before optimization.

public int? PreviousSequence { get; set; }

Property Value

int?

int

Route

Gets or sets the associated Route of the plan.

public Route? Route { get; set; }

Property Value

Route

Route

Sequence

Gets or sets the sequence number of the route plan item.

public int? Sequence { get; set; }

Property Value

int?

int

Status

Gets the route stop status.

public StopStatus? Status { get; }

Property Value

StopStatus?

StopStatus

StopDuration

Gets actual stop duration.

public TimeSpan? StopDuration { get; }

Property Value

TimeSpan?

TimeSpan

Zone

Gets or sets the associated Zone in the route.

public Zone? Zone { get; set; }

Property Value

Zone

Zone

ZoomLevel

Gets or sets the zoom level of each Zone.

public int? ZoomLevel { get; set; }

Property Value

int?

int

Methods

Clone()

Creates a new object that is a copy of the current instance.

public override IEntity Clone()

Returns

IEntity

A new object that is a copy of this instance.

IsBreak()

false Gets whether the route item is a break.

public bool? IsBreak()

Returns

bool?

bool

IsIdentical(RoutePlanItem?, RoutePlanItem?)

Determines whether the specified item1 is identical.

protected static bool IsIdentical(RoutePlanItem? item1, RoutePlanItem? item2)

Parameters

item1 RoutePlanItem

The item1.

item2 RoutePlanItem

The item2.

Returns

bool

Whether the specified item1 is identical.

IsVehicleParkedHere()

Determines if the vehicle is already parked and this RoutePlanItem is the starting point.

public bool IsVehicleParkedHere()

Returns

bool

True if VehicleParkedHere option is checked in the UI for this RoutePlanItem

IsVisited()

Determines whether the item is visited.

public bool IsVisited()

Returns

bool

Whether the item is visited.