ReportOptions Class Reference

Inherits SharedOptions.

Public Member Functions
	ReportOptions ()
	Default constructor More...
	ReportOptions (SharedOptions sharedOpts, TruckStyle? vehicleProfile)
	Initializes ReportOptions from the base class SharedOptions More...

Properties
bool?	UseTollData[get, set]
	Gets or sets a value indicating whether or not toll data should be used. More...
VolumeUnits	FuelUnits[get, set]
	Gets or sets the fuel units to gallons (default) or liters. More...
RouteCosts	RouteCosts[get, set]
	Gets or sets the route costs. More...
TimeCosts	TimeCosts[get, set]
	Gets or sets the time costs. More...
Currency	TollCurrency[get, set]
	Gets or sets the toll currency. Default is US in the United States and EUR in Europe. More...
double	ExchangeRate[get, set]
	Gets or sets the change rate to convert US dollars to Canadian dollars. More...
string	TollDiscount[get, set]
	Gets or sets a string containing the applicable toll discount program. More...
bool?	IncludeFerryDistance[get, set]
	Gets or sets a value indicating whether or not miles traveled on ferries are included in mileage calculation. The default is true. More...
bool	UseCustomRoadSpeeds[get, set]
	Gets or sets a value indicating whether or not to use custom road speeds. More...
LanguageType	Language[get, set]
	Gets or sets the language in which the information is to be displayed. The default is ENUS for English United States. More...
bool	UseEUTollsReport = true[get, set]
	Gets or sets a value indicating whether EU toll report should be reported. default set to true, get validated in route request validator only for EU users More...
EstimatedTimeOptions	EstimatedTimeOptions[get, set]
	Gets or sets the estimated time options. More...
bool	UseTraffic[get, set]
	Gets or sets a value indicating whether or not to use traffic data when calculating transit times, or when using fastest routing. More...
TruckStyle	TruckStyle[get, set]
	Loads a vehicle profile which includes vehicle dimensions, route costs and other routing options for a specific vehicle class. See TruckStyle for more information. More...
bool	IncludeVehicleRestrictedCleanupPoints[get, set]
	Boolean that designates if the customer wants the vehicle restricted cleanups to be separated from the main coordinate list and returned separately. More...

Detailed Description

Represents options specific to creation of reports.

Constructor & Destructor Documentation

ReportOptions() [1/2]

ReportOptions

(

)

Default constructor

ReportOptions() [2/2]

ReportOptions	(	SharedOptions	sharedOpts,
		TruckStyle?	vehicleProfile
	)

Initializes ReportOptions from the base class SharedOptions

Parameters

sharedOpts	The shared options
vehicleProfile	The vehicle profile from route options

Property Documentation

UseTollData

bool? UseTollData

getset

Gets or sets a value indicating whether or not toll data should be used.

FuelUnits

VolumeUnits FuelUnits

getset

Gets or sets the fuel units to gallons (default) or liters.

The fuel units are used in setting RouteCosts

RouteCosts

RouteCosts RouteCosts

getset

Gets or sets the route costs.

TimeCosts

TimeCosts TimeCosts

getset

Gets or sets the time costs.

TollCurrency

Currency TollCurrency

getset

Gets or sets the toll currency. Default is US in the United States and EUR in Europe.

ExchangeRate

double ExchangeRate

getset

Gets or sets the change rate to convert US dollars to Canadian dollars.

TollDiscount

string TollDiscount

getset

Gets or sets a string containing the applicable toll discount program.

This field is only valid if the user has quarterly toll data privileges and the UseTollData is set to true.

Available programs are: 407ETR Transponder, A25 Transponder, BreezeBy,C-Pass, Cruise Card, E-Pass, E-Pass Canada, EXpress Toll, EZ Tag, EZPass, EZPass-NJ, EZPass-WV, FAST LANE, FasTrak, GeauxPass, GO-PASS, Good to Go, I-PASS, I-Zoom, K-TAG, Laredo Trade Tag, Leeway, MACPASS, NC Quick Pass, NEXPRESS TOLL, Palmetto Pass, Peach Pass, PikePass, Quickpass, Smart Tag, StraitPASS, SunPass, TollTag, TxTag, and WabashPass or All.

IncludeFerryDistance

bool? IncludeFerryDistance

getset

Gets or sets a value indicating whether or not miles traveled on ferries are included in mileage calculation. The default is true.

UseCustomRoadSpeeds

bool UseCustomRoadSpeeds

getset

Gets or sets a value indicating whether or not to use custom road speeds.

Language

LanguageType Language

getset

Gets or sets the language in which the information is to be displayed. The default is ENUS for English United States.

UseEUTollsReport

bool UseEUTollsReport = true

getset

Gets or sets a value indicating whether EU toll report should be reported. default set to true, get validated in route request validator only for EU users

EstimatedTimeOptions

EstimatedTimeOptions EstimatedTimeOptions

getsetinherited

Gets or sets the estimated time options.

Used to only affect eta/etd in reports, but now can affect the route on road restrictions that are time based.

UseTraffic

bool UseTraffic

getsetinherited

Gets or sets a value indicating whether or not to use traffic data when calculating transit times, or when using fastest routing.

TruckStyle

TruckStyle TruckStyle

getsetinherited

Loads a vehicle profile which includes vehicle dimensions, route costs and other routing options for a specific vehicle class. See TruckStyle for more information.

This is deprecated in v32. We recommend using RouteOptions.VehicleProfile instead. Setting a truck style to any value besides None will override any TruckConfig that has been set.

IncludeVehicleRestrictedCleanupPoints

bool IncludeVehicleRestrictedCleanupPoints

getsetinherited

Boolean that designates if the customer wants the vehicle restricted cleanups to be separated from the main coordinate list and returned separately.