Class VehicleDayRoute

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

A summary of vehicle activity for a given route and day.

[ReportClass]
public class VehicleDayRoute : RouteDevice, IDeviceProvider

Inheritance

object

RouteDevice

VehicleDayRoute

Implements

IDeviceProvider

Inherited Members

RouteDevice.EndDate

RouteDevice.LocalStartDate

RouteDevice.StartDate

RouteDevice.Route

RouteDevice.TimeZone

RouteDevice.Device

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

VehicleDayRoute()

Initializes a new instance of the VehicleDayRoute class. Default constructor.

public VehicleDayRoute()

VehicleDayRoute(Route, Device, in DateTime, string)

Initializes a new instance of the VehicleDayRoute class.Initializes a new instance of the VehicleDayRoute class.

public VehicleDayRoute(Route route, Device device, in DateTime date, string timeZone)

Parameters

route Route

The route.

device Device

The device.

date DateTime

The date.

timeZone string

The device Timezone.

Properties

CustomerStopsOverThreshold

Gets or sets the number of customer stops over the minimum stop time threshold.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteCustomerStopsOverThreshold })]
public int CustomerStopsOverThreshold { get; set; }

Property Value

int

The number of customer stops over the threshold.

CustomerStopsUnderThreshold

Gets or sets the number of customer stops under the minimum stop time threshold.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteCustomerStopsUnderThreshold })]
public int CustomerStopsUnderThreshold { get; set; }

Property Value

int

The number of customer stops under the threshold.

CustomerTimeOverThreshold

Gets or sets the total duration of customer stops over the minimum stop time threshold.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteCustomerTimeOverThreshold })]
public TimeSpan CustomerTimeOverThreshold { get; set; }

Property Value

TimeSpan

The total duration in customer zones over the min threshold.

CustomerTimeUnderThreshold

Gets or sets the total duration of customer stops under the minimum stop time threshold.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteCustomerTimeUnderThreshold })]
public TimeSpan CustomerTimeUnderThreshold { get; set; }

Property Value

TimeSpan

The total duration in customer zones under the threshold.

Distance

Gets or sets the total distance driven for the day.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteDistance }, IsSpeedOrDistance = true)]
public double Distance { get; set; }

Property Value

double

The distance driven in the day.

DriveTime

Gets or sets the total driving time for the day.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteDriveTime })]
public TimeSpan DriveTime { get; set; }

Property Value

TimeSpan

The total driving time in the day.

EmployeeList

Gets the Employee list of the matched route for the day.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteEmployeeList })]
public string EmployeeList { get; }

Property Value

string

List of employees.

Employees

Gets or sets the list of employees associated with this route and day.

public List<Employee> Employees { get; set; }

Property Value

List<Employee>

The list of employees.

FirstDepartureTime

Gets or sets the first time the device departed for the day in UTC time.

public DateTime FirstDepartureTime { get; set; }

Property Value

DateTime

The first departure time in UTC.

HomeStops

Gets or sets the total number of stops at a home type zone.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteHomeStops })]
public int HomeStops { get; set; }

Property Value

int

The number of stops in a Home type zone.

HomeTime

Gets or sets the total amount of time spent at home.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteHomeTime })]
public TimeSpan HomeTime { get; set; }

Property Value

TimeSpan

The total time inside Home type zones.

IdleTime

Gets or sets the total amount of time spent idling.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteIdleTime })]
public TimeSpan IdleTime { get; set; }

Property Value

TimeSpan

The total idle time.

JackRabbitStarts

Gets or sets the number of jack rabbit starts (not implemented currently).

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteJackRabbitStarts })]
public int JackRabbitStarts { get; set; }

Property Value

int

The number of jack rabbit starts.

LastArrivalTime

Gets or sets the time of the last trips arrival.

public DateTime? LastArrivalTime { get; set; }

Property Value

DateTime?

The last arrival time.

LastOfficeStopZone

Gets or sets the Last Office Stop Zone.

public Zone? LastOfficeStopZone { get; set; }

Property Value

Zone

The last zone stop in of type Office.

LocalFirstDepartureTime

Gets the first time the device departed for the day in device's Timezone.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteLocalFirstDepartureTime })]
public DateTimeOffset? LocalFirstDepartureTime { get; }

Property Value

DateTimeOffset?

The first departure time of the day.

LocalLastArrivalTime

Gets the time of the last trips arrival in the device's Timezone.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteLocalLastArrivalTime })]
public DateTimeOffset? LocalLastArrivalTime { get; }

Property Value

DateTimeOffset?

The last arrival time of the day.

MatchedRouteCandidateRouteItemCount

Gets or sets the count or candidate RouteItem(s) used for matching the Route in Route.

public int MatchedRouteCandidateRouteItemCount { get; set; }

Property Value

int

The number of candidate routes.

MatchedRouteZoneNames

Gets or sets gets the matched route zone names.

public string MatchedRouteZoneNames { get; set; }

Property Value

string

The matched route zone names.

OfficeStops

Gets or sets the number of office stops.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteOfficeStops })]
public int OfficeStops { get; set; }

Property Value

int

The number of office zone stops in the day.

OfficeTime

Gets or sets the total duration spent at an office type zone.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteOfficeTime })]
public TimeSpan OfficeTime { get; set; }

Property Value

TimeSpan

The amount of time spent in zone of type Office.

PercentageSpeeding

Gets the percentage of time spent speeding. The percentage is calculated against the total amount of driving time.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRoutePercentageSpeeding })]
public double PercentageSpeeding { get; }

Property Value

double

The percentage speeding.

SeatbeltViolations

Gets or sets the number of seat belt violations for the day.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteSeatbeltViolations })]
public int SeatbeltViolations { get; set; }

Property Value

int

The number of seat belt violations.

SpeedingViolationTime

Gets or sets the total amount of time spent over the speeding threshold.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteSpeedingViolationTime })]
public TimeSpan SpeedingViolationTime { get; set; }

Property Value

TimeSpan

The amount of time over the speeding threshold.

SpeedingViolations

Gets or sets the number of speeding violations for the day.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteSpeedingViolations })]
public int SpeedingViolations { get; set; }

Property Value

int

The number of speeding violations.

StopsWithinThresholds

Gets or sets gets the stops within thresholds.

public int StopsWithinThresholds { get; set; }

Property Value

int

The number of stops withing the thresholds.

TotalStops

Gets the total stops, regardless of type.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteTotalStops })]
public int TotalStops { get; }

Property Value

int

The total stops.

TotalTime

Gets the total time.

public TimeSpan TotalTime { get; }

Property Value

TimeSpan

The total time.

UndefinedStopTimeOverThreshold

Gets or sets the total duration of stops over the minimum stop time threshold.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteUndefinedStopTimeOverThreshold })]
public TimeSpan UndefinedStopTimeOverThreshold { get; set; }

Property Value

TimeSpan

The duration of stop time over the threshold.

UndefinedStopTimeUnderThreshold

Gets or sets the total duration of stops under the minimum stop time threshold.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteUndefinedStopTimeUnderThreshold })]
public TimeSpan UndefinedStopTimeUnderThreshold { get; set; }

Property Value

TimeSpan

The duration of stops under the min threshold.

UndefinedStopsOverThreshold

Gets or sets the number of undefined stops over the minimum stop time threshold.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteUndefinedStopsOverThreshold })]
public int UndefinedStopsOverThreshold { get; set; }

Property Value

int

Number of steps over the threshold.

UndefinedStopsUnderThreshold

Gets or sets the number of undefined stops under the minimum stop time threshold.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.VehicleDayRouteUndefinedStopsUnderThreshold })]
public int UndefinedStopsUnderThreshold { get; set; }

Property Value

int

Number of stops under the threshold.