Class IWRoute

A class representing a route

This class is part of the module routing.

IWRoute

IWRoute()

Creates a new route

addEntry

void addEntry(entry)

Adds a new entry to the route.

Parameters:
IWRouteEntry entry

Returns:
void 

getBounds

IWBounds getBounds()

Returns the bounds of this route.

Returns:
IWBounds 

getCoordinates

getCoordinates()

undocumented

getDestinationAddress

IWAddress getDestinationAddress()

Returns the destination address.

Returns:
IWAddress 

getDrivingTime

number getDrivingTime()

Returns the driving time in seconds.

Returns:
number 

getEntry

IWRouteEntry getEntry(index)

Returns the route entry at the specified index.

Parameters:
number index

Returns:
IWRouteEntry 

getFuelConsumption

double getFuelConsumption()

Returns the total fuel consumption in liters.

Returns:
double 

getInterstationAddresses

IWAddress[] getInterstationAddresses()

Returns the interstation addresses.

Returns:
IWAddress[] 

getRouteLength

double getRouteLength()

Returns the total route length in kilometers.

Returns:
double 

getSegments

number getSegments()

Returns the number of route entries.

Returns:
number 

getShape

void getShape()

Returns the name of the shape file

Returns:
void 

getStartAddress

IWAddress getStartAddress()

Returns the start address.

Returns:
IWAddress 

setBounds

void setBounds(bounds)

Sets the bounds of this route.

Parameters:
IWBounds bounds

Returns:
void 

setCoordinates

setCoordinates(coordinates)

undocumented

Parameters:
coordinates

setDestinationAddress

void setDestinationAddress()

Sets the destination address.

Parameters:
IWAddress 

Returns:
void 

setDrivingTime

void setDrivingTime(drivingTime)

Sets the driving time in seconds.

Parameters:
number drivingTime

Returns:
void 

setFuelConsumption

void setFuelConsumption(fuelConsumption)

Sets the total fuel consumption in liters.

Parameters:
double fuelConsumption

Returns:
void 

setInterstationAddresses

void setInterstationAddresses(interstationAddresses)

Sets the interstation addresses.

Parameters:
IWAddress[] interstationAddresses

Returns:
void 

setRouteLength

void setRouteLength(routeLength)

Sets the total route length in kilometers.

Parameters:
double routeLength

Returns:
void 

setShape

void setShape(shape)

Sets the name of the shape file.

Parameters:
String shape

Returns:
void 

setStartAddress

void setStartAddress(address)

Sets the start address.

Parameters:
IWAddress address

Returns:
void 

toString

String toString()

Returns a string representation of this object.

Returns:
String