GuidanceMgr (CPIK Libraries)

Methods

Road

ArrayList<Coordinate>

ArrayList<String>

ArrayList<String>

TurnInstruction

LaneAssistInfo

SafetyCamera

GPSDevice

PositionInfo

Date

Double

Void

ChevronDisplayType

Void

Void

Boolean

Void

Void

Boolean

Void

Void

Boolean

Void

Void

Void

Void

Void

Void

Void

Boolean

Boolean

Boolean

Int

Int

Boolean

Void

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GeocodingException

Methods

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceException

Methods

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceSettings

Methods

Boolean

Void

Boolean

Void

Boolean

Void

SpeedThreshold

Void

Boolean

Void

SafetyCamera AlertRange

Void

MapMode

Void

Void

int

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceSettings.isSpeedAlertEnabled

Syntax

boolean getSpeedLimitAlertEnabled()

Return Value

Boolean - True if enabled, false if disabled.

Sample Code

// Print whether or not an alert will appear when the driver is exceeding the speed limit
boolean speedAlertEnabled = GuidanceSettings.isSpeedAlertEnabled();

if (speedAlertEnabled)
  System.out.println("Alerts will be given when the driver exceeds the speed limit");
else
  System.out.println("Alerts will NOT be given when the driver exceeds the speed limit");

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceSettings.setSpeedAlert

Syntax

static void enableSpeedLimitAlert(boolean)

Parameters

boolean speedAlertEnabled - True to enable, false to disable.

Return Value

Void

Sample Code

// Enable alerts when exceeding the speed limit
GuidanceSettings.setSpeedAlert(true);

// Disable alerts when exceeding the speed limit
GuidanceSettings.setSpeedAlert(false);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Related APIs

• GuidanceSettings.isSpeedAlertEnabled()
• GuidanceSettings.isSpeedAlertAudioEnabled()
• GuidanceSettings.setSpeedAlertAudio()
• GuidanceSettings.isSpeedLimitOnMap()
• GuidanceSettings.setSpeedLimitOnMap()
• GuidanceSettings.getSpeedLimitThreshold()
• GuidanceSettings.setThreshold()

GuidanceSettings.isSpeedAlertAudioEnabled

Syntax

static boolean getSpeedLimitAudioAlertEnabled()

Parameters

None

Return Value

boolean - True if enabled, false if disabled.

Sample Code

// Print whether or not an audible alert will sound when the driver is exceeding the speed limit
boolean soundAlert = GuidanceSettings.isSpeedAlertAudioEnabled();
if (soundAlert)
  System.out.println("Audio alerts will sound when the driver exceeds the speed limit");
else
  System.out.println("Audio alerts will NOT sound when the driver exceeds the speed limit");

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceSettings.setSpeedAlertAudio

Syntax

void enableSpeedLimitAudioAlert(boolean)

Parameters

boolean alertEnabled - True to enable, false to disable.

Sample Code

// Enable audible alerts when exceeding the speed limit
GuidanceSettings.setSpeedAlertAudio(true);
// Disable audible alerts when exceeding the speed limit
GuidanceSettings.setSpeedAlertAudio(false);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceSettings.isSpeedLimitOnMap

Syntax

static boolean isSpeedLimitOnMap()

Parameters

None

Return Value

boolean - True if shown, false if hidden

Sample Code

// Print whether or not the speed limit will display on the map
boolean speedLimitOnMap = GuidanceSettings.isSpeedLimitOnMap();
if (speedLimitOnMap)
  System.out.println("Speed limit will be displayed on map");
else
  System.out.println("Speed limit will NOT be displayed on map");

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Related APIs

• GuidanceSettings.isSpeedAlertEnabled()
• GuidanceSettings.setSpeedAlert()
• GuidanceSettings.isSpeedAlertAudioEnabled()
• GuidanceSettings.setSpeedAlertAudio()
• GuidanceSettings.setSpeedLimitOnMap()
• GuidanceSettings.getSpeedLimitThreshold()
• GuidanceSettings.setThreshold()

GuidanceSettings.setSpeedLimitOnMap

Syntax

void enableShowSpeedLimitOnMap(boolean)

Parameters

boolean showSpeedLimitOnMap - True to show, false to hide.

Return Value

Void

Sample Code

// Set the speed limit to display on the map
GuidanceSettings.setSpeedLimitOnMap(true);
// Set the speed limit to NOT display on the map
GuidanceSettings.setSpeedLimitOnMap(false);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceSettings.getSpeedLimitThreshold

Syntax

static SpeedLimitWarningThreshold getSpeedLimitWarningThreshold()

Parameters

None

Return Value

SpeedLimitWarningThreshold – An Enum indicating the speed which must be reached in miles per hour before the speed limit warning is provided.

Sample Code

// Print out the current threshold for which speed limit alerts will be sent
GuidanceSettings.SpeedThreshold threshold = GuidanceSettings.getSpeedLimitThreshold();
String unitString = "";
try {
  if (CopilotMgr.getUnitsOfMeasure() == UnitsOfMeasure.METRIC)
    unitString = "KPH";
  else if (CopilotMgr.getUnitsOfMeasure() == UnitsOfMeasure.IMPERIAL)
    unitString = "MPH";

  switch (threshold) {
    case LEVEL_0:
      System.out.println("Alerts will be shown when the current speed is at least 5 "+ unitString + " higher than the speed limit");
      break;
    case LEVEL_1:
      System.out.println("Alerts will be shown when the current speed is at least 10 " + unitString + " higher than the speed limit");
      break;
    case LEVEL_2:
      System.out.println("Alerts will be shown when the current speed is at least 15 " + unitString + " higher than the speed limit");
      break;
    case LEVEL_3:
      System.out.println("Alerts will be shown when the current speed is at least 20 " + unitString + " higher than the speed limit");
      break;
    case LEVEL_4:
      System.out.println("Alerts will be shown when the current speed is at least 25 " + unitString + " higher than the speed limit");
      break;
    case LEVEL_5:
      System.out.println("Alerts will be shown when the current speed is at least 30 " + unitString + " higher than the speed limit");
      break;
    default:
      break;
  }
} catch (CopilotException e) {
  e.printStackTrace();
}

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Related APIs

• GuidanceSettings.isSpeedAlertEnabled()
• GuidanceSettings.setSpeedAlert()
• GuidanceSettings.isSpeedAlertAudioEnabled()
• GuidanceSettings.setSpeedAlertAudio()
• GuidanceSettings.isSpeedLimitOnMap()
• GuidanceSettings.setSpeedLimitOnMap()
• GuidanceSettings.setThreshold()
• GuidanceSettings.setThreshold()

GuidanceSettings.setThreshold

Syntax

void setThreshold(SpeedThreshold threshold)

Parameters

Threshold - How fast a driver can be over the speed limit before receiving a speed limit warning.

Return Value

Void

Sample Code

// Set CoPilot to warn when the current speed is greater than 5 MPH/KPH over the speed limit
GuidanceSettings.setThreshold(GuidanceSettings.SpeedThreshold.LEVEL_0);
// Set CoPilot to warn when the current speed is greater than 20 MPH/KPH over the speed limit
GuidanceSettings.setThreshold(GuidanceSettings.SpeedThreshold.LEVEL_3);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Related APIs

• GuidanceSettings.isSpeedAlertEnabled()
• GuidanceSettings.setSpeedAlert()
• GuidanceSettings.isSpeedAlertAudioEnabled()
• GuidanceSettings.setSpeedAlertAudio()
• GuidanceSettings.isSpeedLimitOnMap()
• GuidanceSettings.setSpeedLimitOnMap()
• GuidanceSettings.getSpeedLimitThreshold()

GuidanceSettings.isSafetyCameraAlertEnabled

Syntax

boolean areSafetyCamerasEnabled()

Return Value

Boolean - True if enabled, false if disabled.

Sample Code

// Print whether or not safety camera alerts are enabled
boolean safetyCamAlertsEnabled = GuidanceSettings.isSafetyCameraAlertEnabled();
if (safetyCamAlertsEnabled)
  System.out.println("Safety camera alerts are enabled");
else
  System.out.println("Safety camera alerts are NOT enabled");

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceSettings.setSafetyCameraAlert

Syntax

void enableSafetyCameraAlerts(boolean)

Parameters

boolean cameraEnabled - True to enable, false to disable.

Sample Code

// Enable safety camera alerts
GuidanceSettings.setSafetyCameraAlert(true);
// Disable safety camera alerts
GuidanceSettings.setSafetyCameraAlert(false);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceSettings.getSafetyCameraAlertRange

Syntax

SafetyCameraAlertRange getSafetyCameraLookaheadLevel()

Return Value

SafetyCameraAlertRange - An AlertRange object that represents how far in advance a driver should be warned about a safety camera.

Sample Code

// Display how far in advance warnings are shown for an approaching safety camera
GuidanceSettings.SafetyCameraAlertRange alertRange = GuidanceSettings.getSafetyCameraAlertRange();
switch (alertRange) {
  case SHORT:
    System.out.println("Safety camera warning display when the camera is within short range");
    break;
  case MEDIUM:
    System.out.println("Safety camera warning display when the camera is within medium range");
    break;
  case LONG:
    System.out.println("Safety camera warning display when the camera is within  long range");
    break;
  default:
    break;
}

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Related APIs

• GuidanceSettings.isSafetyCameraAlertEnabled()
• GuidanceSettings.setSafetyCameraAlert()
• GuidanceSettings.setSafetyCameraAlertRange()

GuidanceSettings.setSafetyCameraAlertRange

Type

Method

Package

com.alk.cpik.guidance

Syntax

void setSafetyCameraLookaheadLevel(AlertRange)

Parameters

AlertRange – An enum that represents how far in advance a driver should be warned about a safety camera.

Return Value

void

Sample Code

// Set safety camera warnings to display when the camera is within short range
GuidanceSettings.setSafetyCameraAlertRange(GuidanceSettings.SafetyCameraAlertRange.SHORT);

// Set safety camera warnings to display when the camera is within medium range
GuidanceSettings.setSafetyCameraAlertRange(GuidanceSettings.SafetyCameraAlertRange.MEDIUM);

// Set safety camera warnings to display when the camera is within long range
GuidanceSettings.setSafetyCameraAlertRange(GuidanceSettings.SafetyCameraAlertRange.LONG);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Related APIs

• GuidanceSettings.isSafetyCameraAlertEnabled()
• GuidanceSettings.setSafetyCameraAlert()
• GuidanceSettings.getSafetyCameraAlertRange()

GuidanceSettings.setMapMode

Syntax

void setMapMode(MapMode)

Parameters

Mode - MapMode to be set.

Sample Code

// Set the map into day mode
GuidanceSettings.setMapMode(GuidanceSettings.MapMode.DAY);

// Set the map into night mode
GuidanceSettings.setMapMode(GuidanceSettings.MapMode.NIGHT);

// Set the map into automatic day/night mode, based on time
GuidanceSettings.setMapMode(GuidanceSettings.MapMode.AUTO);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Related APIs

• Guidance.getMapMode

GuidanceSettings.getMapMode

Syntax

MapMode getMapMode()

Return Value

Returns the MapMode object being used with CoPilot.

Sample Code

// Get and print the current map display mode
GuidanceSettings.MapMode currMapMode = GuidanceSettings.getMapMode();
System.out.println("The current map display mode is: " + currMapMode.toString());

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Related APIs

• Guidance.serMapMode

GuidanceSettings.setDistanceToSayTurnNow

Syntax

void setDistanceToSayTurnNow(distanceForTurnNow)

Parameters

distanceForTurnNow - The distance where CoPilot should speak its “Turn Now” announcement in yards or meters.

Sample Code

// Set the "turn now" distance to 50 yards.
// Assumes CoPilot is set to use standard units of measure,
// Otherwise, (metric), this distance would be interpreted as meters.
int distanceForTurnNow = 50;
GuidanceSettings.setDistanceToSayTurnNow(distanceForTurnNow);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Related APIs

• Guidance.getDistanceToSayTurnNow

GuidanceSettings.getDistanceToSayTurnNow

Syntax

Static int getDistanceToSayTurnNow

Return Value

Integer value indicating the current setting. If getUnitsOfMeasure() returns metric then the returned value will be in meters. Otherwise, the return value will be in yards.

Sample Code

// Get and print the distance before the turn at which CoPilot
// will instruct the driver to "turn now"
try {
  String distanceUnits;
  if (CopilotMgr.getUnitsOfMeasure() == UnitsOfMeasure.METRIC)
    distanceUnits = "meters";
  else if (CopilotMgr.getUnitsOfMeasure() == UnitsOfMeasure.IMPERIAL)
    distanceUnits = "yards";
  int turnNowDistance = GuidanceSettings.getDistanceToSayTurnNow();
  System.out.println("CoPilot will speak the turn now instruction " + String.valueOf(turnNowDistance) + " " + distanceUnits + " before an approaching turn");
} catch (CopilotException e) {
  e.printStackTrace();
}

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Related APIs

• Guidance.setDistanceToSayTurnNow

SpeedThreshold

Values

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

SafetyCameraAlertRange

Package

com.alk.cpik.guidance

Values

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

MapMode

Values

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Coordinate

Constructors

Methods

double

double

void

void

Sample Code

{
  double latitude = 40.3571;
  double longitude = -74.6702;
  Coordinate sampleCoord = new Coordinate(latitude, longitude);
}

Coordinate *coordinate = [[Coordinate alloc] initWithLatLon: 40.3571 withLon: -74.6702];

Example Output

Coordinates: 50.85N, 4.35E

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

PositionInfo

Methods

Coordinate

Coordinate

double

double

double

Date

GPSFixQuality

int

int

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GPSFixQuality

Values

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

CPPositionInfo

Properties

CPGpsState

Values

Road

Methods

int

int

String

String

String

int

int

Boolean

Boolean

List<String>

List<AllowedVehicleType>

String

String

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

Boolean

List<HazmatRestrictions>

RestrictedDimensions

RoadClass

RoadSubClass

Example Output

Minimum address: 12; Maximum address: 206; Route numbers: [560, 49]; Road name: Church Lane; Region: Europe; Country: United Kingdom

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Road.RoadClass

Values

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

SafetyCamera

Methods

boolean

Double

Int

String

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Traffic

Methods

Void

Void

Void

Void

Int

boolean

Int

Int

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Country

Methods

String

String

String

DriveSide

String

UnitsOfMeasure

ArrayList<String>

String

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

LaneAssistInfo

Methods

List<Lane>

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

Lane

Methods

TurnCode

LaneMarker

boolean

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

OverSpeedLimitWarning

Methods

boolean

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

TruckWarning

Methods

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

TruckWarningType

Values

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

TurnInstruction

Methods

String

String

String

String

String

String

boolean

boolean

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

ItineraryInfo

Methods

String

String

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceMgr.getCurrentPosition

Syntax

PositionInfo getCurrentLocation()

+(CPPositionInfo*)

Return Value

A PositionInfo object populated with data pertaining to CoPilot’s current or last known position.

Sample Code

// Get and print details about CoPilot's current position
try {
  PositionInfo currentPosition = GuidanceMgr.getCurrentPosition();
  System.out.println("Current location: " + currentPosition.getPosition().toString());
  System.out.println("Heading: " + currentPosition.getHeading());
  System.out.println("Speed: " + currentPosition.getSpeed());
  System.out.println("SnappedPosition: " +  currentPosition.getSnappedPosition().toString());
  System.out.println("Timestamp: " +  currentPosition.getTimestamp().toString());
} catch (CopilotException e) {
  e.printStackTrace();
}

CPPositionInfo *position = [GuidanceMgr getCurrentPosition];

NSLog([@"Position"]);
NSLog([NSString stringWithFormat:@"Latitude: %f",
position.coordinate.latitude]);
NSLog([NSString stringWithFormat:@"Longitude: %f",
position.coordinate.longitude]);
NSLog([NSString stringWithFormat:@"Altitude: %f", position.altitude]);
NSLog([NSString stringWithFormat:@"Heading: %f", position.heading]);
NSLog([NSString stringWithFormat:@"Speed: %f", position.speed]);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceMgr.getLaneAssist

Syntax

LaneAssistInfo getLaneAssist() throws CopilotException

+(LaneAssistInfo*) getLaneAssist

Return Value

A LaneAssistInfo object with the current lane assist information.

Sample Code

// Get and print lane assist information
try {
  LaneAssistInfo currLaneAssist = GuidanceMgr.getLaneAssist();
  System.out.println("Current lane assist lane " +  currLaneAssist.getLanes());
  System.out.println("Current lane assist info " +  currLaneAssist.toString());
} catch (CopilotException e) {
  e.printStackTrace();
}

LaneAssistInfo *info = [GuidanceMgr getLaneAssist];
for(Lane *lane in info.lanes)
{
 NSLog(@"Lane");
 NSLog([NSString stringWithFormat:@"Turn Code: %d", lane.turnCode]);
 NSLog([NSString stringWithFormat:@"Lane Marker: %d", lane.laneMarker]);
 NSLog([NSString stringWithFormat:@"Valid: %@", (lane.valid == true) ? @"Yes" : @"No"]);
}

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceMgr.getTurnInstruction

Syntax

TurnInstruction getTurnInstruction() throws CopilotException

+(TurnInstruction*) getTurnInstruction

Return Value

A TurnInstruction object that contains the information about the upcoming turn.

Sample Code

// Get and print turn instruction information
try {
  TurnInstruction currentTurnInstruction = GuidanceMgr.getTurnInstruction();
  System.out.println("DistanceToNextTurn : " + currentTurnInstruction.getDistanceToNextTurn());
  System.out.println("ExitRoadName : " + currentTurnInstruction.getExitRoadName());
  System.out.println("GuidanceInstruction : " + currentTurnInstruction.getGuidanceInstruction());
  System.out.println("DistanceToTurnAfterNext : " + currentTurnInstruction.getDistanceToTurnAfterNext());
  System.out.println("StreetNameForNextTurn : " + currentTurnInstruction.getStreetNameForNextTurn());
  //for all values
  System.out.println("turn instruction information : " + currentTurnInstruction.toString());
} catch (CopilotException e) {
  e.printStackTrace();
}

TurnInstruction *instruction= [GuidanceMgr getTurnInstruction];
NSLog(@"Distance to Turn After Next: %@", instruction.distanceToTurnAfterNext);
NSLog(@"Exit Road Name: %@", instruction.exitRoadName);
NSLog(@"Icon for Turn After Next: %d", instruction.iconForTurnAfterNext);
NSLog(@"Unnamed Road: %@", (instruction.unnamedRoad == true) ? @"Yes" : @"No");
NSLog(@"Roundabout: %@", (instruction.roundAbout == true) ? @"Yes" : @"No");
NSLog(@"Roundabout Exit Number: %d", instruction.roundAboutExitNumber);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceMgr.getDistanceToDestination

Syntax

double getDistanceToDestination() throws CopilotException

+(double) getDistanceToDestination

Return Value

The distance remaining to the destination. This distance will be in miles if CoPilot is set to use imperial measurements or meters if CoPilot is set to use metric measurements.

Sample Code

// Get and print the distance to the destination
try {
  double distanceToDest = GuidanceMgr.getDistanceToDestination();
  String distanceUnits = "";
  if (CopilotMgr.getUnitsOfMeasure() == UnitsOfMeasure.METRIC)
    distanceUnits = "meters";
  else if (CopilotMgr.getUnitsOfMeasure() == UnitsOfMeasure.IMPERIAL)
    distanceUnits = "miles";
    System.out.println("Currently " + String.valueOf(distanceToDest) + " " + distanceUnits + " away from the destination");
} catch (CopilotException e) {
  e.printStackTrace();
}

NSLog([NSString stringWithFormat:@"Distance to Destination: %f",[GuidanceMgr getDistanceToDestination]]);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceMgr.getCurrentRoad

Syntax

Road getCurrentRoad()

+(Road*) getCurrentRoad

Return Value

A Road object containing information about the current road.

Sample Code

// Get and print the current road
Road currentRoad = GuidanceMgr.getCurrentRoad();
System.out.println("Current road name: " + currentRoad.getRoadName());
System.out.println("Current road city: " + currentRoad.getCity());
System.out.println("Current road state: " + currentRoad.getState());
System.out.println("Current road zip: " + currentRoad.getZip());
System.out.println("Current road HazmatRestrictions: " + currentRoad.getHazmatRestrictions());
System.out.println("Current road RoadClass: " + currentRoad.getRoadClass());
System.out.println("Current road SpeedLimit: " + currentRoad.getSpeedLimit());

//for all values
System.out.println("Current road info: " + currentRoad.toString());

Road *road = [GuidanceMgr getCurrentRoad];
NSLog(@"Minimum Address : %d", road.minimumAddress);
NSLog(@"Maximum Address : %d", road.maximumAddress);
NSLog(@"Truck Speed Limit: %d", road.truckSpeedLimit);
NSLog(@"Is Urban: %@", (road.isUrban == true) ? @"Yes" : @"No");
NSLog(@"Has Toll: %@", (road.hasToll == true) ? @"Yes" : @"No");

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceMgr.getRouteCoordinates

Syntax

Java ArrayList getRouteCoordinates(boolean bFromCurrentPosition, double dLookAhead, double dGranularity) throws CopilotException

+(NSArray*) getRouteCoordinates:(bool) (double) (double)

Parameters

Boolean bFromCurrentPosition - True if requesting only the points starting from the current position on the route. False if requesting the entire route.

Double dLookAhead – The distance in miles to look ahead on the route.

Double dGranularity – A value between 0.0 and 1.0 that will indicate how coarse the returned list of Coordinates will be. A value of 1.0 will return the finest possible route.

Return Value

An ArrayList object that contains the list of Coordinate objects that represents the route.

Sample Code

// Get and print the coordinates along the current route
// From the current position
// For a distance of 2.5 miles ahead
// With the medium granularity
boolean fromCurrentPosition = true;
double lookAheadMiles = 2.5;
double granularity = 0.50;
try {
  List<Coordinate> coordsAheadOnRoute = GuidanceMgr.getRouteCoordinates(fromCurrentPosition, lookAheadMiles, granularity);
  System.out.println("Coordinates ahead on route: " + coordsAheadOnRoute.toString());
} catch (CopilotException e) {
  e.printStackTrace();
}

NSArray* coords =
[GuidanceMgr getRouteCoordinates:true withLookAhead:5withGranularity:0.0];
for(Coordinate * coord in coords)
{
 NSLog(@"Coordinate");
 NSLog([NSString stringWithFormat:@"Latitude: %f", coord.latitude]);
 NSLog([NSString stringWithFormat:@"Latitude: %f",coord.latitude]);
}

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceMgr.getRouteTmcCodes

Syntax

ArrayList getRouteTmcCodes() throws CopilotException

Return Value

An ArrayList object that contains the list of TMC location codes describing the current route.

Sample Code

// Get and print the list of TMC codes for the roads taken by the current route
try {
  ArrayList<String> routeTMCCodes = GuidanceMgr.getRouteTmcCodes();
  for (String str : routeTMCCodes)
  System.out.println("Current route TMC codes: " + str);
} catch (CopilotException e) {
  e.printStackTrace();
}

NSArray* tmcCodes = [GuidanceMgr getRouteTmcCodes];
for(NSString * string in tmcCodes)
{
 NSLog(@"TmcCode");
 NSLog(string);
}

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceMgr.getRouteTmcCodes (No duplicates)

Syntax

ArrayList getRouteTmcCodes(boolean removeDuplicates) throws CopilotException

Parameters

bRemoveDuplicates – True if the duplicates should be removed from the returned list.

Return Value

An ArrayList object that contains the list of TMC location codes describing the current route.

Sample Code

// // Get and print the list of TMC codes for the roads taken by the current route and remove duplicates
try {
  boolean removeDuplicates = true;
  ArrayList<String> routeTMCCodes =
  GuidanceMgr.getRouteTmcCodes(removeDuplicates);
  for (String str : routeTMCCodes)
    System.out.println("Current route TMC codes without duplicates: " + str);
} catch (CopilotException e) {
  e.printStackTrace();
}

NSArray* tmcCodes = [GuidanceMgr getRouteTmcCodes:false];
for(NSString * string in tmcCodes)
{
 NSLog(@"TmcCode");
 NSLog(string);
}

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceMgr.getCurrentSafetyCamera

Syntax

SafetyCamera getCurrentSafetyCamera() throws CopilotException

+(SafetyCamera*) getCurrentSafetyCamera

Return Value

A SafetyCamera object that contains information about the safety camera that is currently displayed on the CoPilot guidance map.

Sample Code

// Get and print information about the safety camera alert currently being shown
try {
  SafetyCamera currentSafetyCam = GuidanceMgr.getCurrentSafetyCamera();
  System.out.println("Current safety camera speedLimit : " + currentSafetyCam.speedLimit());
  System.out.println("Current safety camera id : " + currentSafetyCam.id());
  System.out.println("Current safety camera isShowing: " + (currentSafetyCam.isShowing() ? "True" : "false"));
  // for all values
  System.out.println("Current safety camera: " + currentSafetyCam.toString());
} catch (CopilotException e) {
  e.printStackTrace();
}

SafetyCamera *camera = [GuidanceMgr getCurrentSafetyCamera];
NSLog(@"Safety Camera"];
NSLog(NSString stringWithFormat:@"Showing: %@", (camera.showing = true) ?@"Yes" : @"No"]);
NSLog([NSString stringWithFormat:@"Distance: %f", camera.distance]);
NSLog([NSString stringWithFormat:@"Speed Limit: %d", camera.speedLimit]);
NSLog([NSString stringWithFormat:@"Description: %@", camera.description]);

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceMgr.getETA

Syntax

Date getETA()

+(NSDate*) getETA

Return Value

A Date object indicating the estimated time of arrival.

Sample Code

// Get and print the ETA at the destination
try {
  Date eta = GuidanceMgr.getETA();
  System.out.println("Current ETA: " + eta.toString());
} catch (CopilotException e) {
  e.printStackTrace();
}