|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectalk.connect.PCMSJava
PCMSJava is a wrapper class for the C-style API supported by PC*Miler Connect v18.0 and higher. It allows a user to access PC*Miler's native routines through a Java interface. To access this functionality you must first have a licensed version PC*Miler Connect installed on your machine. Then import the package alk.connect. You may also need to import alk.connect.results if you plan to use any of the methods that require a results object as a parameter (i.e. SetCalcTypeEx). Finally, instantiate an instance of the PCMSJava class within your existing Java application and access its methods as you would any other Java class.
Note: You must have alk.jar included in your CLASSPATH in order to access its packages. Also make sure the location of the pcmsrv32 library is set in java.library.path before running your application. You can set this environment variable at execution time. (ex. java -Djava.library.path=[path] test)
| Constructor Summary | |
PCMSJava()
|
|
| Method Summary | |
int |
About(java.lang.String which,
java.lang.StringBuffer strBuf)
Gets PC*Miler version information. |
int |
AddressToLatLong(short serverID,
java.lang.String address,
java.lang.StringBuffer strBuf)
Finds corresponding latlong for given address. |
int |
AddStop(long tripID,
java.lang.String stop)
Adds stop to end of trip. |
int |
AFLinks(long tripID,
boolean bFavor)
Sets trip option so that selected links are respectively avoided and favored during route calculation (if true). |
int |
AFLoad(short serverID,
java.lang.String filename)
Loads current set of avoided/favored links for default region. |
int |
AFLoadForRegion(short serverID,
java.lang.String filename,
java.lang.String regionID)
Loads current set of avoided/favored links for specified region. |
int |
AFSave(short serverID)
Saves current set of avoided/favored links for default region to file |
int |
AFSaveForRegion(short serverID,
java.lang.String regionID)
Saves current set of avoided/favored links for specified region to file. |
long |
AirDistToRte(long tripID,
java.lang.String location,
int legNum)
Calculates closest air distance between "location" and specified leg. |
long |
CalcDistance(short serverID,
java.lang.String orig,
java.lang.String dest)
Calculates distance from orig to dest. |
long |
CalcDistance2(short serverID,
java.lang.String orig,
java.lang.String dest,
int routeType)
Calculates distance from orig to dest given routing type. |
long[] |
CalcDistance3(short serverID,
java.lang.String orig,
java.lang.String dest,
int routeType)
Calculates distance and minutes of travel from orig to dest given routing type. |
int |
CalcDistToRoute(long tripID,
java.lang.String location)
Calculates orthogonal distance to route from "location". |
long |
CalcTrip(long tripID,
java.lang.String orig,
java.lang.String dest)
Calculates distance from orig to dest using trip settings. |
long |
Calculate(long tripID)
Calculates trip distance through all stops using current trip settings. |
int |
ChangeWWDataSet(java.lang.String regionID)
Sets default region to given regionID. |
int |
CheckPlaceName(short serverID,
java.lang.String cityZip)
Verifies that input has an exact match in the database. |
int |
CityToLatLong(short serverID,
java.lang.String city,
java.lang.StringBuffer strBuf)
Finds corresponding latlong for given city. |
void |
ClearStops(long tripID)
Clears trip of all stops. |
int |
CloseServer(short serverID)
Clean up and dismiss PC*Miler server. |
void |
ConvertLLToPlace(long tripID,
boolean bYesNo)
Sets trip option to automatically convert latlongs to PC*MILER place names (true). |
void |
Defaults(long tripID)
Reset all options to default values. |
int |
DeleteStop(long tripID,
int idx)
Deletes specified stop. |
void |
DeleteTrip(long tripID)
Frees existing PC*MILER trip and resources associated with it. |
long |
GetBorderWaitHours(long tripID)
Gets time spent waiting at borders (in minutes). |
long |
GetBreakHours(long tripID)
Gets the interval designated on-duty and between breaks (in minutes). |
long |
GetBreakWaitHours(long tripID)
Gets length of breaks (in minutes). |
int |
GetCalcType(long tripID)
Gets criteria used to calculate distance for given trip. |
int |
GetCalcTypeEx(long tripID,
CalcTypeEx calcTypeEx)
Gets extended criteria used to calculate distance for given trip. |
int |
GetCost(long tripID)
Gets cost per mile (in cents). |
int |
GetDebug()
Gets debugging level for this PC*Miler Server. |
int |
GetDefaultRegion(java.lang.StringBuffer str)
Gets default region. |
long |
GetDuration(long tripID)
Gets duration of trip in minutes. |
int |
GetError()
Gets last error code associated with server. |
int |
GetErrorString(int errorCode,
java.lang.StringBuffer str)
Gets specific error string for given error code. |
int |
GetExactLevel(short serverID)
Gets current threshold at which an address is considered a match. |
int |
GetFmtMatch(long tripID,
int idx,
java.lang.StringBuffer strBuf,
int zipLen,
int cityLen,
int countyLen)
Gets specific place name from last Lookup in a custom format. |
int |
GetFmtMatch2(long tripID,
int idx,
java.lang.StringBuffer addr,
java.lang.StringBuffer city,
java.lang.StringBuffer state,
java.lang.StringBuffer zip,
java.lang.StringBuffer county)
Gets specific place name from last Lookup, parsed into separate fields for address, city, state, zip and county. |
long |
GetHTMLRpt(long tripID,
int rptNum,
java.lang.StringBuffer strBuf)
Copies HTML-formatted report into user-supplied StringBuffer. |
int |
GetLegInfo(long tripID,
int legNum,
LegInfoType pLegInfo)
Gets information about leg miles, total miles, leg cost, total cost, leg hours, and total for specific leg of trip. |
int |
GetLocAtMiles(long tripID,
long miles,
java.lang.StringBuffer strBuf)
Gets nearest location on the route after travelling 'miles' from the origin. |
int |
GetLocAtMinutes(long tripID,
long minutes,
java.lang.StringBuffer strBuf)
Gets nearest location on the route after travelling 'minutes' from the origin. |
int |
GetLocRadItem(long tripID,
int index,
java.lang.StringBuffer strBuf)
Gets an item found through a LocRadLookup query. |
int |
GetMatch(long tripID,
int idx,
java.lang.StringBuffer strBuf)
Gets specific place name from last Lookup. |
int |
GetNumSegments(long tripID)
Gets number of segments in detailed report. |
long |
GetOptions(long tripID)
Gets trip options as single set of flags. |
int |
GetRegionName(short serverID,
int idx,
java.lang.StringBuffer strBuf)
Gets full name for idx-th region. |
int |
GetRpt(long tripID,
int rptNum,
java.lang.StringBuffer strBuf)
Copies entire report text into user-supplied StringBuffer. |
int |
GetRptLine(long tripID,
int rptNum,
int lineNum,
java.lang.StringBuffer strBuf)
Copies line from specified report into user-supplied StringBuffer. |
int |
GetSegment(long tripID,
int segNum,
SegmentStruct pSegment)
Gets segment by 0-based index. |
int |
GetStop(long tripID,
int idx,
java.lang.StringBuffer strBuf)
Gets place name for specific stop. |
int |
GetStopType(long tripID,
int idx)
Gets stop type for given stop. |
long |
GetToll(long tripID)
Gets total toll amount for trip in cents. |
long |
GetTollBreakdown(long tripID,
int discProgram)
Gets tolls owed when using specific discount program. |
int |
GetTollDiscountName(short serverID,
int idx,
java.lang.StringBuffer strBuf)
Gets specific toll discount program name by index. |
int |
IsValid(short serverID)
Check that server is valid. |
int |
LatLongAtMiles(long tripID,
long miles,
java.lang.StringBuffer strBuf,
boolean bUseShpPts)
Get latlong on the route after travelling 'miles' from the origin. |
int |
LatLongAtMinutes(long tripID,
long minutes,
java.lang.StringBuffer strBuf,
boolean bUseShpPts)
Get latlong on the route after travelling 'minutes' from the origin. |
double[] |
LatLongsEnRoute(long tripID,
long numPairs,
boolean bUseShpPts)
Gets lat/long pairs along route. |
int |
LatLongToAddress(short serverID,
java.lang.String latlong,
java.lang.StringBuffer strBuf)
Finds corresonding address for given latlong. |
int |
LatLongToCity(short serverID,
java.lang.String latlong,
java.lang.StringBuffer strBuf)
Finds corresonding city for given latlong. |
int |
LocRadLookup(long tripID,
java.lang.String city,
int radius,
boolean bCities,
boolean bPostalCodes,
boolean bCustomPlaces,
boolean bPOI,
int POICategoryIndex)
Looks up cities, postal codes, custom places, and/or POIs within a radius around a city/state or zip. |
int |
Lookup(long tripID,
java.lang.String str,
int easyMatch)
Looks up zip or city/state name and returns number of matching places. |
long |
NewTrip(short serverID)
Creates new PC*MILER trip. |
long |
NewTripWithRegion(short serverID,
java.lang.String regionID)
Creates a new PC*MILER trip for a specific region. |
long |
NumHTMLRptBytes(long tripID,
int rptNum)
Gets total length of HTML-formatted report. |
long |
NumLatLongsEnRoute(long tripID,
boolean bUseShpPts)
Gets total number of lat/long pairs in route. |
int |
NumLegs(long tripID)
Gets number of legs in trip. |
int |
NumMatches(long tripID)
Gets total number of matches found in last Lookup. |
int |
NumPOICategories(short serverID)
Gets total number of POI categories in data. |
int |
NumRegions(short serverID)
Gets number of available region names. |
long |
NumRptBytes(long tripID,
int rptNum)
Gets total length of report in bytes. |
int |
NumRptLines(long tripID,
int rptNum)
Gets number of lines in report. |
int |
NumStops(long tripID)
Gets number of stops in trip. |
int |
NumTollDiscounts(short serverID)
Gets number of toll discount programs (EZPass, FasTrak, etc) tracked by PC*Miler. |
short |
OpenServer(int hAppInst,
int hWnd)
Initializes new PC*Miler server. |
int |
Optimize(long tripID)
Optimizes order of stops for given trip. |
int |
POICategoryName(short serverID,
int index,
java.lang.StringBuffer strBuf)
Gets the name of a POI category. |
void |
SetAlphaOrder(long tripID,
boolean bAlphaOrder)
Sets trip option to sort state report in alphabetical (true) or in driving order (false). |
void |
SetBordersOpen(long tripID,
boolean bOpen)
Sets trip option to run routes with international borders open (true) or closed (false). |
void |
SetBorderWaitHours(long tripID,
long mins)
Sets time spent waiting at borders (in minutes). |
void |
SetBreakHours(long tripID,
long mins)
Sets the interval designated on-duty and between breaks (in minutes). |
void |
SetBreakWaitHours(long tripID,
long mins)
Sets length of breaks (in minutes). |
void |
SetCalcType(long tripID,
int calcType)
Sets criteria used to calculate distance for given trip. |
void |
SetCalcTypeEx(long tripID,
CalcTypeEx calcTypeEx)
Sets extended criteria used to calculate distance for given trip. |
void |
SetCost(long tripID,
int cost)
Sets cost per mile (in cents). |
void |
SetCustomMode(long tripID,
boolean bOnOff)
Sets trip option to route with custom mode on(true) or off(false). |
int |
SetDebug(int levl)
Sets debugging level for this PC*Miler Server. |
int |
SetDefaultRegion(java.lang.String regionID)
Sets default region to given regionID. |
void |
SetExactLevel(short serverID,
int threshold)
Sets threshold at which an address is considered a match. |
void |
SetHazOption(long tripID,
int hazType)
Sets Hazardous Routing options. |
void |
SetHubMode(long tripID,
boolean bOnOff)
Sets hub routing mode on (true) so that first stop becomes common origin for all subsequent stops, or off (false) to route through all stops. |
void |
SetKilometers(long tripID)
Sets trip option to report all distances in kilometers. |
int |
SetLoaded(long tripID,
int idx,
boolean bLoaded)
Sets stop flag to either loaded or empty. |
void |
SetMiles(long tripID)
Sets trip option to report all distances in miles. |
void |
SetOldMode(long tripID,
boolean bOnOff)
Sets trip option to enable old-style (no comma) geocoding (if true). |
int |
SetOldModeForRegion(short serverID,
java.lang.String regionID,
boolean bOnOff)
Sets server option to enable old-style (no comma) geocoding for an entire region. |
void |
SetOnRoad(long tripID,
boolean bOnOff)
Sets trip option determining whether a latlong should be geocoded to a road (true), or used as an exact position. |
void |
SetOptions(long tripID,
long opts)
Sets trip options from set of flags. |
void |
SetResequence(long tripID,
boolean bChangeDest)
Sets trip option so that when optimizing, reorder all but first stop (true), or all but the first and last stops (false). |
void |
SetRoadNameOnly(long tripID,
boolean bOnOff)
Sets trip option to match addresses on road names only (true), or only match addresses exactly(false). |
void |
SetShowFerryMiles(long tripID,
boolean bOnOff)
Sets trip option to include ferry miles in distance calculations (true) or ignore them (false). |
void |
SetTollMode(long tripID,
int mode)
Sets level of toll reporting for trip. |
void |
SetVehicleType(long tripID,
boolean bOnOff)
Sets trip option to calculate route with heavy vehicle on (true) or off(false) |
void |
TranslateAlias(long tripID,
boolean bTranslate)
Sets wheter aliases (custom places) should be translated to corresponding location or left as user-defined name. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public PCMSJava()
| Method Detail |
public int SetDebug(int levl)
levl - debug level maps to following values:
0 = no debugging
1 = some debugging (currently not used)
2 = lots of message boxes about the state of the DLL.
public int GetDebug()
public short OpenServer(int hAppInst,
int hWnd)
hAppInst - calling application's instance handle. (Use 0 for current version)hWnd - parent window's window handle. (Use 0 for current version)
public int CloseServer(short serverID)
serverID - unique server ID. Must be passed in to free resources.
public int IsValid(short serverID)
serverID - unique server ID
public int GetErrorString(int errorCode,
java.lang.StringBuffer str)
errorCode - error code returned by GetError()str - user-supplied StringBuffer to hold error string
public int GetError()
public int About(java.lang.String which,
java.lang.StringBuffer strBuf)
which - designates which string to return. Can be one of following:
"ProductName"
"ProductVersion"
"LegalCopyright"
"LegalTrademarks"
strBuf - user-supplied StringBuffer to hold version information on success
public int ChangeWWDataSet(java.lang.String regionID)
regionID - String can be one of following:
"AF" or "Africa"
"AS" or "Asia"
"EU" or "Europe"
"NA" or "North America"
"OC" or "Oceania"
"SA" or "South America"
public int SetDefaultRegion(java.lang.String regionID)
regionID - String can be one of following:
"AF" or "Africa"
"AS" or "Asia"
"EU" or "Europe"
"NA" or "North America"
"OC" or "Oceania"
"SA" or "South America"
public int GetDefaultRegion(java.lang.StringBuffer str)
str - user-supplied StringBuffer to hold region information on success. Will contain one of
following two-letter abbreviations:
"AF" for Africa
"AS" for Asia
"EU" for Europe
"NA" for North America
"OC" for Oceania
"SA" for South America
public long CalcDistance(short serverID,
java.lang.String orig,
java.lang.String dest)
serverID - unique server IDorig - String specifiying origin. (ex. "08540", "Princeton, NJ", "Princeton, NJ; 1000 Herrontown Rd")dest - String specifiying destination.
public long CalcDistance2(short serverID,
java.lang.String orig,
java.lang.String dest,
int routeType)
serverID - unique server IDorig - String specifiying the origin.dest - String specifiying the destination.routeType - int with one of following values:
-1 - Invalid 0 - Practical
1 - Shortest
2 - National Network
3 - Avoid Tolls
4 - Air Distance
5 - POV
6 - 53'
public long[] CalcDistance3(short serverID,
java.lang.String orig,
java.lang.String dest,
int routeType)
serverID - unique server IDorig - String specifiying the origin.dest - String specifiying the destination.routeType - int specifying a routing type. Refer to CalcDistance2 for valid input values.
public int CheckPlaceName(short serverID,
java.lang.String cityZip)
serverID - unique server IDcityZip - String containing location information (ex. "08540", "Pri*, NJ");
public int CityToLatLong(short serverID,
java.lang.String city,
java.lang.StringBuffer strBuf)
serverID - unique server IDcity - String containing city to be looked upstrBuf - user-supplied StringBuffer to hold latlong information on success
public int LatLongToCity(short serverID,
java.lang.String latlong,
java.lang.StringBuffer strBuf)
serverID - unique server IDlatlong - String containing latlong to be looked upstrBuf - user-supplied StringBuffer to hold city information on success
public int AddressToLatLong(short serverID,
java.lang.String address,
java.lang.StringBuffer strBuf)
serverID - unique server IDaddress - String containing address to be looked upstrBuf - user-supplied StringBuffer to hold latlong information on success
public int LatLongToAddress(short serverID,
java.lang.String latlong,
java.lang.StringBuffer strBuf)
serverID - unique server IDlatlong - String containing latlong to be looked upstrBuf - user-supplied StringBuffer to hold address information on success
public int NumRegions(short serverID)
serverID - unique server ID
public int GetRegionName(short serverID,
int idx,
java.lang.StringBuffer strBuf)
serverID - unique server IDidx - 0-based index into list of region namesstrBuf - user-supplied StringBuffer to hold region name string on success
public long NewTrip(short serverID)
serverID - unique server ID
public long NewTripWithRegion(short serverID,
java.lang.String regionID)
serverID - unique server IDregionID - String containing region identifier. Refer to GetDefaultRegion for possible values.
public void DeleteTrip(long tripID)
tripID - unique trip identifier
public long CalcTrip(long tripID,
java.lang.String orig,
java.lang.String dest)
tripID - unique trip identifierorig - String specifiying the origindest - String specifiying the destination
public long Calculate(long tripID)
tripID - unique trip identifier
public int Optimize(long tripID)
tripID - unique trip identifier
public long GetDuration(long tripID)
tripID - unique trip identifier
public long GetToll(long tripID)
tripID - unique trip identifier
return total amount owed for trip in centspublic int NumTollDiscounts(short serverID)
serverID - unique server ID
public int GetTollDiscountName(short serverID,
int idx,
java.lang.StringBuffer strBuf)
serverID - a unique server IDidx - 0-based index into list of toll discount programsstrBuf - user-supplied StringBuffer to hold program name on success
public long GetTollBreakdown(long tripID,
int discProgram)
tripID - unique trip identifierdiscProgram - 0-based index into list of toll discount program
public int AddStop(long tripID,
java.lang.String stop)
tripID - unique trip identifierstop - String containing location information (ex. "08540", "Princeton, NJ", "Princeton, NJ; 1000 Herrontown Rd")
public int DeleteStop(long tripID,
int idx)
tripID - unique trip identifieridx - 0-based index into trip list of stops
public void ClearStops(long tripID)
tripID - unique trip identifier
public int GetStop(long tripID,
int idx,
java.lang.StringBuffer strBuf)
tripID - unique trip identifieridx - 0-based index into trip list of stopsstrBuf - user-supplied StringBuffer to hold place name string on success
public int NumStops(long tripID)
tripID - unique trip identifier
public int GetStopType(long tripID,
int idx)
tripID - unique trip identifieridx - 0-based index into trip list of stops
0 - A valid PC*Miler stop
1 - A valid LatLong or address
2 - A valid SPLC
public int SetLoaded(long tripID,
int idx,
boolean bLoaded)
tripID - unique trip identifieridx - 0-based index into trip list of stopsbLoaded - boolean with value true if loaded, false if empty
public int Lookup(long tripID,
java.lang.String str,
int easyMatch)
tripID - unique trip identifierstr - String containing location informationeasyMatch - int with value 1 for exact matches only, 0 to include partial matches
public int GetMatch(long tripID,
int idx,
java.lang.StringBuffer strBuf)
tripID - unique trip identifieridx - 0-based index into list of matchesstrBuf - user-supplied StringBuffer to hold place name string on success
public int GetFmtMatch(long tripID,
int idx,
java.lang.StringBuffer strBuf,
int zipLen,
int cityLen,
int countyLen)
tripID - unique trip identifieridx - 0-based index into list of matchesstrBuf - user-supplied StringBuffer to hold place name string on successzipLen - maximum number of bytes allocated to zip informationcityLen - maximum number of bytes allocated to city information (including state)countyLen - maximum number of bytes allocated to county information
public int GetFmtMatch2(long tripID,
int idx,
java.lang.StringBuffer addr,
java.lang.StringBuffer city,
java.lang.StringBuffer state,
java.lang.StringBuffer zip,
java.lang.StringBuffer county)
tripID - unique trip identifieridx - 0-based index into list of matchesaddr - user-supplied StringBuffer to hold address string on successcity - user-supplied StringBuffer to hold city string on successstate - user-supplied StringBuffer to hold state string on successzip - user-supplied StringBuffer to hold zip string on successcounty - user-supplied StringBuffer to hold county string on success
public int NumMatches(long tripID)
tripID - unique trip identifier
public int NumPOICategories(short serverID)
serverID - unique server identifier
public int POICategoryName(short serverID,
int index,
java.lang.StringBuffer strBuf)
serverID - unique server identifierindex - 0-based index into list of categories (list size determined by POICategoriesNum)strBuf - user-supplied StringBuffer to hold category name
public int LocRadLookup(long tripID,
java.lang.String city,
int radius,
boolean bCities,
boolean bPostalCodes,
boolean bCustomPlaces,
boolean bPOI,
int POICategoryIndex)
tripID - unique trip identifiercity - String containing location information (city/state or zipcode)radius - search radius in milesbCities - include cities in search (if true)bPostalCodes - include postal codes in search (if true)bCustomPlaces - include custom places in search (if true)bPOI - include pois in search (if true)POICategoryIndex - category index of POIs to search
public int GetLocRadItem(long tripID,
int index,
java.lang.StringBuffer strBuf)
tripID - unique trip identifierindex - 0-based index into list of items foudn by LocRadLookupstrBuf - user-supplied StringBuffer to hold item results (distance to lookup location is prepended)
public int GetRpt(long tripID,
int rptNum,
java.lang.StringBuffer strBuf)
tripID - unique trip identifierrptNum - type of report to return. Can be one of following values:
0 - Detailed
1 - State
2 - Mileage
strBuf - user-supplied StringBuffer to hold text of report on success
public int GetRptLine(long tripID,
int rptNum,
int lineNum,
java.lang.StringBuffer strBuf)
tripID - unique trip identifierrptNum - type of report to return. Refer to GetRpt for appropriate valueslineNum - line of report to be copiedstrBuf - user-supplied StringBuffer to hold report line on success
public int NumRptLines(long tripID,
int rptNum)
tripID - unique trip identifierrptNum - type of report to generate. Refer to GetRpt for appropriate values
public long NumRptBytes(long tripID,
int rptNum)
tripID - unique trip identifierrptNum - type of report to generate. Refer to GetRpt for appropriate values
public long GetHTMLRpt(long tripID,
int rptNum,
java.lang.StringBuffer strBuf)
tripID - unique trip identifierrptNum - type of report to return. Refer to GetRpt for appropriate valuesstrBuf - user-supplied StringBuffer to hold text of report
public long NumHTMLRptBytes(long tripID,
int rptNum)
tripID - unique trip identifierrptNum - type of report to return. Refer to GetRpt for appropriate values
public int GetNumSegments(long tripID)
tripID - unique trip identifier
public int GetSegment(long tripID,
int segNum,
SegmentStruct pSegment)
tripID - unique trip identifiersegNum - 0-based index into segment listpSegment - empty user-supplied object of type SegmentStruct. Used to return method results.
public int GetLegInfo(long tripID,
int legNum,
LegInfoType pLegInfo)
tripID - unique trip identifierlegNum - 0-based index into list of legspLegInfo - empty user-supplied object of type pLegInfo. Used to return method results.
public void SetCalcType(long tripID,
int calcType)
tripID - unique trip identifiercalcType - Refer to CalcDistance2 for appropriate input valuespublic int GetCalcType(long tripID)
tripID - unique trip identifier
public void SetCalcTypeEx(long tripID,
CalcTypeEx calcTypeEx)
tripID - unique trip identifiercalcTypeEx - user-supplied object of type CalcTypeEx with each member initialized to one of following values:
rtType:
0x00000001 - PracticaloptFlags:
0x00000002 - Shortest
0x00000004 - Air Distance
0x00000100 - Avoid TollsvehType:
0x00000200 - National Routing
0x00000400 - 53' Routing
0x00000000 - Truck
0x01000000 - Auto
public int GetCalcTypeEx(long tripID,
CalcTypeEx calcTypeEx)
tripID - unique trip identifiercalcTypeEx - empty user-supplied object of type CalcTypeEx. Used to return method results.
public void SetBordersOpen(long tripID,
boolean bOpen)
tripID - unique trip identifierbOpen - if true, run with borders open; if false, run with borders closed
public void SetShowFerryMiles(long tripID,
boolean bOnOff)
tripID - unique trip identifierbOnOff - if true, include ferry miles; if false, ignore ferry milespublic void SetKilometers(long tripID)
tripID - unique trip identifierpublic void SetMiles(long tripID)
tripID - unique trip identifier
public void SetHubMode(long tripID,
boolean bOnOff)
tripID - unique trip identifierbOnOff - if true, turn hub routing on; if false, turn hub routing off
public void SetCost(long tripID,
int cost)
tripID - unique trip identifiercost - cost/mile in centspublic int GetCost(long tripID)
tripID - unique trip identifier
public void SetResequence(long tripID,
boolean bChangeDest)
tripID - unique trip identifierbChangeDest - if true, resequence all stops except origin; if false, resequence all stops except origin and last stop
public void SetTollMode(long tripID,
int mode)
tripID - unique trip identifiermode - use one of following values:
0 - no toll information
1 - cash toll amount
2 - discount toll amount
public void SetOptions(long tripID,
long opts)
tripID - unique trip identifieropts - concatenation of possible options flags bit-wise or'ed into single longpublic long GetOptions(long tripID)
tripID - unique trip identifier
public int NumLegs(long tripID)
tripID - unique trip identifierpublic void Defaults(long tripID)
tripID - unique trip identifier
public void SetBreakHours(long tripID,
long mins)
tripID - unique trip identifiermins - number of minutes between breakspublic long GetBreakHours(long tripID)
tripID - unique trip identifier
public void SetBreakWaitHours(long tripID,
long mins)
tripID - unique trip identifiermins - length of breaks in minutespublic long GetBreakWaitHours(long tripID)
tripID - unique trip identifier
public void SetBorderWaitHours(long tripID,
long mins)
tripID - unique trip identifiermins - minutes spent waiting at borderspublic long GetBorderWaitHours(long tripID)
tripID - unique trip identifier
public void SetOnRoad(long tripID,
boolean bOnOff)
tripID - unique trip identifierbOnOff - true if enable latlong geocoding to road, false if disable latlong geocoding to road
public void SetCustomMode(long tripID,
boolean bOnOff)
tripID - unique trip identifierbOnOff - true if enable custom routing, false if disable custom routing
public void SetOldMode(long tripID,
boolean bOnOff)
tripID - unique trip identifierbOnOff - true if enable old-style geocoding, false if disable old-style geocoding
public int SetOldModeForRegion(short serverID,
java.lang.String regionID,
boolean bOnOff)
serverID - unique server identifierregionID - String denoting region to be setbOnOff - true if enable old-style geocoding; false if disable old-style geocoding
public void SetAlphaOrder(long tripID,
boolean bAlphaOrder)
tripID - unique trip identifierbAlphaOrder - true if sort state report in alphabetical order; false if sort in driving order
public void ConvertLLToPlace(long tripID,
boolean bYesNo)
tripID - unique trip identifierbYesNo - true to convert latlongs to place names; false to keep latlongs intact
public int AFLinks(long tripID,
boolean bFavor)
tripID - unique trip identifierbFavor - true to avoid or favor selected links during route calculation; false otherwise
public int AFLoad(short serverID,
java.lang.String filename)
serverID - unique server identifierfilename - name of file to be loadedpublic int AFSave(short serverID)
serverID - unique server identifier
public int AFLoadForRegion(short serverID,
java.lang.String filename,
java.lang.String regionID)
serverID - unique server identifierfilename - name of file to be loaded
public int AFSaveForRegion(short serverID,
java.lang.String regionID)
serverID - unique server identifierregionID - String specifiying region
public int CalcDistToRoute(long tripID,
java.lang.String location)
tripID - unique trip identifierlocation - String containing location information
public long AirDistToRte(long tripID,
java.lang.String location,
int legNum)
tripID - unique trip identifierlocation - String containing location informationlegNum - 0-based index into list of legs
public int GetLocAtMiles(long tripID,
long miles,
java.lang.StringBuffer strBuf)
tripID - unique trip identifiermiles - number of miles along routestrBuf - StringBuffer to hold location information
public int GetLocAtMinutes(long tripID,
long minutes,
java.lang.StringBuffer strBuf)
tripID - unique trip identifierminutes - number of minutes travelledstrBuf - StringBuffer to hold location information
public int LatLongAtMiles(long tripID,
long miles,
java.lang.StringBuffer strBuf,
boolean bUseShpPts)
tripID - unique trip identifiermiles - number of miles along routestrBuf - StringBuffer to hold latlong informationbUseShpPts - use shape points in route calculation
public int LatLongAtMinutes(long tripID,
long minutes,
java.lang.StringBuffer strBuf,
boolean bUseShpPts)
tripID - unique trip identifierminutes - number of minutes travelledstrBuf - StringBuffer to hold latlong informationbUseShpPts - use shape points in route calculation (true)
public long NumLatLongsEnRoute(long tripID,
boolean bUseShpPts)
tripID - unique trip identifierbUseShpPts - use shape points in route calculation (true)
public double[] LatLongsEnRoute(long tripID,
long numPairs,
boolean bUseShpPts)
tripID - unique trip identifiernumPairs - number of pairs to returnbUseShpPts - use shape points in route calculation (true)
public void SetVehicleType(long tripID,
boolean bOnOff)
tripID - unique trip identifierbOnOff - true if heavy vehicle on, false if heavy vehicle off
public void SetRoadNameOnly(long tripID,
boolean bOnOff)
tripID - unique trip identifierbOnOff - true if match address to road name, false if only match exactly
public void SetExactLevel(short serverID,
int threshold)
serverID - unique serverIDthreshold - valid range 0 to 100public int GetExactLevel(short serverID)
serverID - unique serverID
public void SetHazOption(long tripID,
int hazType)
tripID - unique trip IDhazType - one of the following values:
0 - none
1 - general
2 - explosive
3 - inhalant
4 - radioactive
public void TranslateAlias(long tripID,
boolean bTranslate)
tripID - unique trip identifierbTranslate - true if translate; false if do not translate
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||