GuidanceMgr - Navigation (CPIK Libraries)

Contents

GuidanceMgr.getCurrentPosition

Overview
Description	Provides information relating to CoPilot’s current or last known location. This will include coordinates as well as other location information detailing the quality of the GPS fix and the number of satellites contributing to the current GPS fix. Note: The last known position will be returned when the current location cannot be determined. This could potentially be from a previous run of the application, depending when this API is used. An object that contains data related to a trip’s itinerary. This information, provided by CoPilot, includes turn instructions, turn images and distances.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

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]);

GuidanceMgr.getLaneAssist

Overview
Description	Returns a LaneAssistInfo object representing the current lane assist information.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

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"]);
}

GuidanceMgr.getTurnInstruction

Overview
Description	Gets information about the upcoming turn instruction.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

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);

GuidanceMgr.getDistanceToDestination

Overview
Description	Provides the distance from the current location to the destination that has been entered into CoPilot. This will be returned in miles or kilometers depending on the settings. If CoPilot has not been started, an error will be returned.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

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]]);

GuidanceMgr.getCurrentRoad

Overview
Description	Gets information about the current road.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

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");

GuidanceMgr.getRouteCoordinates

Overview
Description	Gets a list of coordinates that describe the current guidance route.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

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]);
}

GuidanceMgr.getRouteTmcCodes

Overview
Description	Gets a list of TMC location codes that describe the current guidance route.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

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);
}

GuidanceMgr.getRouteTmcCodes (No duplicates)

Overview
Description	Gets a list of TMC location codes that describe the current guidance route, with the ability to remove duplicates from the list.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	Android, Linux
Type	Method
Package	com.alk.cpik.guidance

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);
}

GuidanceMgr.getCurrentSafetyCamera

Overview
Description	Gets the current Safety Camera info, if it exists.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

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]);

GuidanceMgr.getETA

Overview
Description	Provides details of the current estimated time of arrival (ETA) for the first destination of the trip that CoPilot is navigating. If CoPilot has not yet started or does not have a destination entered, an exception will be thrown.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	Android, Linux
Type	Method
Package	com.alk.cpik.guidance

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();
}

NSDate *date = [GuidanceMgr getETA];
NSLog(@"ETA");
NSLog([NSDateFormatter localizedStringFromDate:date dateStyle:NSDateFormatterShortStyle timeStyle:NSDateIntervalFormatterFullStyle]);

GuidanceMgr.getItineraryInfoList

Overview
Description	Returns the full itinerary currently stored within CoPilot. Itinerary information will be passed back via onItineraryUpdate. A subsequent onItineraryUpdate will be returned after any of the following events: - Route calculation finish - Route is finished - Refresh of the route calculation dialog - Current segment (link) is changed - Any Detour - Penalty added to link/segment (traffic received) - Penalty removed from link/segment (traffic is cleared) - Update itinerary report in case language or distance unit changed - Trip is changed
Supported on Android Since Version	9.6.0.1848
Supported on iOS Since Version	10.9
Type	Class
Package	com.alk.cpik.guidance

Methods

ItineraryEntryList getItineraryInfoList()

+(NSArray*) getItineraryInfoList

Return Value

A list representing each ItineraryInfo object.

Sample Code

// Get the entire itinerary
try {
  List<ItineraryInfo> itineraryList = GuidanceMgr.getItineraryInfoList();
  for (ItineraryInfo itinerary : itineraryList) {
    System.out.println("itinerary Instruction : " + itinerary.getInstruction());
    System.out.println("itinerary DistanceOnSegment : " + itinerary.getDistanceOnSegment());
    System.out.println("itinerary TurnIconForNextTurn : " + itinerary.getTurnIconForNextTurn());
    // for all values
    System.out.println("itinerary Instruction : " + itinerary.toString());
  }
} catch (CopilotException e) {
  e.printStackTrace();
}

GuidanceMgr.getGPSDevice

Overview
Description	Gets the CoPilot GPS Device used to manually push GPS Coordinates or NMEA sentences.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

GPSDevice getGPSDevice()

+(GPSDevice*) getGPSDevice

Return Value

Singleton instance of the CoPilot GPS Device.

Sample Code

// Get the instance of the GPS device
GPSDevice device = GuidanceMgr.getGPSDevice();
if (device != null)
System.out.println("GPSDevice is available");
else
System.out.println("GPSDevice is not available");

GPSDevice *device = [GuidanceMgr getGPSDevice];

GuidanceMgr.enableEarlyTurnWarning

Overview
Description	Enables the early turn warning that occurs at 2 miles or 2 kilometers before the turn.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

void enableEarlyTurnWarning(boolean enable)

+(void) enableEarlyTurnWarning:(bool)enable

Sample Code

// Enable early turn warning
GuidanceMgr.enableEarlyTurnWarning(true);

[GuidanceMgr enableEarlyTurnWarning:true];

GuidanceMgr.isEarlyTurnWarningEnabled

Overview
Description	Checks whether or not the early turn warning, which occurs at 2 miles or 2 kilometers before the turn, is enabled.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

boolean isEarlyTurnWarningEnabled

+(bool) isEarlyTurnWarningEnabled

Return Value

Boolean - True if the early turn warning is enabled. False otherwise.

Sample Code

// Print whether or not early turn warning is enabled
boolean earlyTurnWarningEnabled = GuidanceMgr.isEarlyTurnWarningEnabled();
if (earlyTurnWarningEnabled)
  System.out.println("Early turn warning is enabled");
else
  System.out.println("Early turn warning is NOT enabled");

if ([GuidanceMgr isEarlyTurnWarningEnabled]])
 NSLog(@"Early Turn Warning On!");
else
 NSLog(@"Early Turn Warning Off!");

GuidanceMgr.enableNearTurnWarning

Overview
Description	Enables the near turn warning that occurs at .5 kilometers or .5 miles before the turn.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

void enableNearTurnWarning(boolean enable)

+(void)enableNearTurnWarning:(bool) enable

Sample Code

// Enable near turn warning
GuidanceMgr.enableNearTurnWarning(true);
// Disable near turn warning
GuidanceMgr.enableNearTurnWarning(false);

[GuidanceMgr enableNearTurnWarning:true];

GuidanceMgr.isNearTurnWarningEnabled

Overview
Description	Checks whether or not the near turn warning, which occurs at .5 kilometers or .5 miles before the turn, is enabled.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

boolean isNearTurnWarningEnabled

+(bool) isNearTurnWarningEnabled

Return Value

Boolean – True if the near turn warning is enabled. False otherwise.

Sample Code

// Print whether or not near turn warning is enabled
boolean nearTurnWarningEnabled = GuidanceMgr.isNearTurnWarningEnabled();
if (nearTurnWarningEnabled)
  System.out.println("Near turn warning is enabled");
else
  System.out.println("Near turn warning is NOT enabled");

if ([GuidanceMgr isNearTurnWarningEnabled]])
 NSLog(@"Near Turn Warning On!");
else
 NSLog(@"Near Turn Warning Off!");

GuidanceMgr.enableFarTurnWarning

Overview
Description	Enables the far turn warning that occurs at 1 kilometer or 1 mile before the turn.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	Android, Linux
Type	Method
Package	com.alk.cpik.guidance

Syntax

void enableFarTurnWarning(boolean enable)

+(void)enableFarTurnWarning:(bool) enable

Sample Code

// Enable near turn warning
GuidanceMgr.enableFarTurnWarning(true);
// Disable near turn warning
GuidanceMgr.enableFarTurnWarning(false);

[GuidanceMgr enableFarTurnWarning:true];

GuidanceMgr.isFarTurnWarningEnabled

Overview
Description	Checks whether or not the far turn warning, which occurs at 1 kilometer or 1 mile before the turn, is enabled.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	Android, Linux
Type	Method
Package	com.alk.cpik.guidance

Syntax

boolean isFarTurnWarningEnabled

+(bool) isFarTurnWarningEnabled

Return Value

Boolean true if the near turn warning is enabled. False otherwise.

Sample Code

// Print whether or not near turn warning is enabled
boolean farTurnWarningEnabled = GuidanceMgr.isFarTurnWarningEnabled();
if (farTurnWarningEnabled)
  System.out.println("Near turn warning is enabled");
else
  System.out.println("Near turn warning is NOT enabled");

if ([GuidanceMgr isFarTurnWarningEnabled]])
 NSLog(@"Far Turn Warning On!");
else
 NSLog(@"Far Turn Warning Off!");

GuidanceMgr.enableTurnRestrictions

Overview
Description	Enables or disables turn restrictions - signs in the map view to show the driver where any restricted turns (e.g. no left or no right turn) are along the route.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

void enabledTurnRestrictions

+(void) enableTurnRestrictions

Parameters

Boolean true to enable turn restrictions. False to disable turn restrictions.

Sample Code

// Enable turn restrictions
GuidanceMgr.enableTurnRestrictions(true);
// Disable turn restrictions
GuidanceMgr.enableTurnRestrictions(false);

[GuidanceMgr enableTurnRestrictions:true];

GuidanceMgr.isTurnRestrictionEnabled

Overview
Description	Checks to see whether turn restrictions are enabled or disabled. Turn restrictions are signs in the map view to show the driver where any restricted turns (e.g. no left or no right turn) are along the route.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

boolean isTurnRestrictionEnabled

+(bool) isTurnRestrictionEnabled

Return Value

Boolean - True if the feature is enabled. False otherwise.

Sample Code

// Print whether or not turn restrictions are enabled
boolean turnRestrictionsEnabled = GuidanceMgr.isTurnRestrictionEnabled();
if (turnRestrictionsEnabled)
  System.out.println("Turn restrictions are enabled");
else
  System.out.println("Turn restrictions are NOT enabled");

if ([GuidanceMgr isTurnRestrictionEnabled]])
 NSLog(@"Turn Restriction On!");
else
 NSLog(@"Turn Restriction Off!");

GuidanceMgr.enableClearTurnView

Overview
Description	Enables or disables the ClearTurn feature, which displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

void enableClearTurnView

+(void) enableClearTurnView

Parameters

Enable - Boolean true to enable ClearTurn. False to disable ClearTurn.

Sample Code

// Enable clear turn view
GuidanceMgr.enableClearTurnView(true);
// Disable clear turn view
GuidanceMgr.enableClearTurnView(false);

[GuidanceMgr enableClearTurnView:true];

GuidanceMgr.isClearTurnViewEnabled

Overview
Description	Checks to see whether ClearTurn is enabled or disabled. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	Android, Linux
Type	Method
Package	com.alk.cpik.guidance

Syntax

boolean isClearTurnViewEnabled

+(bool) isClearTurnViewEnabled

Return Value

Boolean - True if the feature is enabled. False otherwise.

Sample Code

// Print whether or not clear turn view is enabled
boolean clearTurnViewEnabled = GuidanceMgr.isClearTurnViewEnabled();
if (clearTurnViewEnabled)
  System.out.println("Clear turn view is enabled");
else
  System.out.println("Clear turn view is NOT enabled");

if ([GuidanceMgr isClearTurnViewEnabled]])
 NSLog(@"Clear Turn On!");
else
 NSLog(@"Clear Turn Off!");

GuidanceMgr.enableClearTurnViewOnlyForHighways

Overview
Description	Enables or disables the ClearTurn feature only for highways. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

void enableClearTurnViewOnlyForHighways(boolean enable)

+(void) enableClearTurnViewOnlyForHighways:(bool) enable

Parameters

Boolean - True to enable ClearTurn. False to disable ClearTurn.

Return Value

// Enable clear turn view
GuidanceMgr.enableClearTurnViewOnlyForHighways (true);
// Disable clear turn view
GuidanceMgr.enableClearTurnViewOnlyForHighways (false);

[GuidanceMgr enableClearTurnViewOnlyForHighways:true];

GuidanceMgr.isClearTurnViewEnabledOnlyForHighways

Overview
Description	Checks whether or not ClearTurn is set to show only for highways. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	Android, Linux
Type	Method
Package	com.alk.cpik.guidance

Syntax

boolean isClearTurnViewEnabledOnlyForHighways

+(bool) isClearTurnViewEnabledOnlyForHighways

Return Value

Boolean - True if the feature is enabled. False otherwise.

Sample Code

// Print whether or not clear turn view is enabled only for highways
boolean clearTurnViewEnabledHwy = GuidanceMgr.isClearTurnViewEnabledOnlyForHighways();
if (clearTurnViewEnabledHwy)
  System.out.println("Clear turn view is enabled only for highways");
else
  System.out.println("Clear turn view is NOT enabled only for highways");

if ([GuidanceMgr isClearTurnViewEnabledOnlyForHighways]])
 NSLog(@"Clear Turn Highways On!");
else
 NSLog(@"Clear Turn Highways Off!");

GuidanceMgr.setClearTurnInstructionDrawDistance

Overview
Description	Sets the distance from the turn at which ClearTurn views will draw. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	Android, Linux
Type	Method
Package	com.alk.cpik.guidance

Syntax

void setClearTurnInstructionDrawDistance(int)

+(void) setClearTurnInstructionDrawDistance:(int)

Parameters

Integer distance measure in 1/10 of a mile or 1/10 of a kilometer.

Sample Code

// Set clear turn instruction draw distance to 1.3 miles
// This assumes CoPilot's units are set to imperial
int iDistance =13;
GuidanceMgr.setClearTurnInstructionDrawDistance(13);

[GuidanceMgr setClearTurnInstructionDrawDistance:13];

GuidanceMgr.getClearTurnInstructionDrawDistance

Overview
Description	Retrieves the distance at which ClearTurn view will draw. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version	9.6.0.868
Supported on Android Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

int getClearTurnInstructionDrawDistance

+(int) getClearTurnInstructionDrawDistance

Return Value

Integer distance at which Clear Turn will draw in 1/10 of a mile or 1/10 of a kilometer, depending on CoPilot’s unit setting.

Sample Code

// Print the clear turn instruction draw distance
int drawDistance = GuidanceMgr.getClearTurnInstructionDrawDistance();
System.out.println("Draw distance: " + String.valueOf(drawDistance));

int drawDistance = [GuidanceMgr getClearTurnInstructionDrawDistance];

GuidanceMgr.setClearTurnInstructionHideDistance

Overview
Description	Sets the distance from the turn at which ClearTurn views will hide. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

void setClearTurnInstructionHideDistance(int)

+(void) setClearTurnInstructionHideDistance:(int)

Parameters

Integer distance at which ClearTurn views will hide in 1/10 of a mile or 1/10 a kilometer.

Sample Code

// Set clear turn instruction draw distance to 1.3 miles
// This assumes CoPilot's units are set to imperial
int iDistance = 13;
GuidanceMgr.setClearTurnInstructionHideDistance(13);

[GuidanceMgr setClearTurnInstructionHideDistance:13];

GuidanceMgr.getClearTurnInstructionHideDistance

Overview
Description	Retrieves the distance at which the ClearTurn view will be hidden. ClearTurn displays a realistic view of a turn ahead, with lane indicator arrows and signposts at major junctions and exits.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

int getClearTurnInstructionHideDistance

+(int) getClearTurnInstructionHideDistance

Return Value

Integer distance at which the ClearTurn view will be hidden in 1/10 of a mile or 1/10 of a kilometer.

Sample Code

// Print the clear turn instruction hide distance
int hideDistance = GuidanceMgr.getClearTurnInstructionHideDistance();
System.out.println("Hide distance: " + String.valueOf(hideDistance));

int hideDistance = [GuidanceMgr getClearTurnInstructionHideDistance];

GuidanceMgr.showTurnAfterNext

Overview
Description	Enables or disables the display of the turn after the approaching turn.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

void showTurnAfterNext(Boolean)

+(void) showTurnAfterNext:(bool)

Parameters

Boolean - True to enable the feature. False to disable.

Sample Code

// Enable displaying the turn after next
GuidanceMgr.showTurnAfterNext(true);

// Disable displaying the turn after next
GuidanceMgr.showTurnAfterNext(false);

[GuidanceMgr showTurnAfterNext:true];

GuidanceMgr.isTurnAfterNextEnabled

Overview
Description	Checks whether or not the turn after the approaching turn will display.
Supported on Android Since Version	9.6.0.868
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

boolean isTurnAfterNextEnabled

+(bool) isTurnAfterNextEnabled

Return Value

Boolean - True if the feature is enabled. False otherwise.

Sample Code

// Print whether or not the turn after next will display
boolean turnAfterNextDisplay = GuidanceMgr.isTurnAfterNextEnabled();
if (turnAfterNextDisplay)
  System.out.println("Turn after next will display");
else
  System.out.println("Turn after next will NOT display");

if ([GuidanceMgr isTurnAfterNextEnabled]])
 NSLog(@"Turn After Next On!");
else
 NSLog(@"Turn After Next Off!");

GuidanceMgr.suspendNavigation

Overview
Description	Suspends navigation. When this API is called, the position on the map will not update and guidance will stop until re-enabled. This is meant to reduce CPU usage at times when navigation is not necessary. GuidanceMgr.getCurrentRoad() will continue to work as expected. This API differs from CopilotMgr.enableGPS() / CopilotMgr.disableGPS()(Android only) in that the GPS device itself will remain open and the current position will be updated for the GuidanceMgr.getCurrentRoad() API.
Supported on Android Since Version	9.6.0.1453
Supported on iOS Since Version	10.9
Type	Method
Package	com.alk.cpik.guidance

Syntax

void suspendNavigation(Boolean)

+(void) suspendNavigation:(bool)

Parameters

bSuspend - true to suspend navigation, or false to re-enable navigation.

Sample Code

// Suspend navigation
GuidanceMgr.suspendNavigation(true);
// Re-enable later
GuidanceMgr.suspendNavigation(false);

ChevronDisplayType

Overview
Description	An enum of the information displayed beneath the chevron in CoPilot during guidance. The chevron is the arrow or dot displayed on the map to indicate the current position.
Supported on Android Since Version	9.6.0.821
Type	Enum
Package	com.alk.cpik.guidance

Values

Value	Description
NONE	Nothing is Displayed.
CURRENT_ROAD	Display the current road.
DESTINATION	Display the destination.
NEAREST_TOWN	Display the nearest town.
Heading	Display the current heading.
LAT_LON	Display the current latitude/longitude position.

DriveSide

Overview
Description	An enum of the side of the road on which a country drives.
Supported on Android Since Version	9.6.0.821
Type	Enum
Package	com.alk.cpik.trip

Values

Value	Description
DRIVE_SIDE_UNAVAILABLE	Drive side information for the country is unavailable.
DRIVE_SIDE_LEFT	A country in which they drive on the left side of the road.
DRIVE_SIDE_RIGHT	A country in which they drive on the right side of the road.

UnitsOfMeasure

Overview
Description	An enum that provides details on units of measurement.
Supported on Android Since Version	9.6.0.821
Type	Enum
Package	com.alk.cpik.trip

Values

Value	Description
UNAVAILABLE	Units of measure are unavailable
METRIC	Metric units of measure
IMPERIAL	Imperial units of measure

Hooks and Callbacks

CPUnitsOfMeasure

Overview
Description	An enum that provides details on units of measurement.
Supported on iOS Since Version	10.9
Type	Enum
Package	com.alk.cpik.trip

Values

Value	Description
CP_UNAVAILABLE	Units of measure are unavailable
CP_METRIC	Metric units of measure
CP_IMPERIAL	Imperial units of measure

SpeedLimitWarningThreshold

Overview
Description	An enum of the speed by which the driver must exceed the speed limit to receive a warning.
Supported on Android Since Version	9.6.0.821
Type	Enum
Package	com.alk.cpik.trip

Values

Value	Description
LEVEL_0	Exceeding the speed limit by 5 mph/kph
LEVEL_1	Exceeding the speed limit by 10 mph/kph
LEVEL_2	Exceeding the speed limit by 15 mph/kph
LEVEL_3	Exceeding the speed limit by 20 mph/kph
LEVEL_4	Exceeding the speed limit by 25 mph/kph
LEVEL_5	Exceeding the speed limit by 30 mph/kph

AlertRange

Overview
Description	An enum of the proximity to a safety camera at which the driver will be alerted.
Supported on Android Since Version	9.6.0.821
Type	Enum
Package	com.alk.cpik.trip

Values

Value	Description
SHORT_RANGE	This represent short range alert.
MEDIUM_RANGE	This represent medium range alert.
LONG_RANGE	This represent long range alert.

TurnArrowImage

Overview
Description	An enum of the turn arrow images used by CoPilot.
Supported on Android Since Version	9.6.0.821
Platforms Supported	Android, Linux
Type	Enum
Package	com.alk.cpik.trip

Values

ID	Value	V9 Image	V10 Image
	NONE
0	STRAIGHT
1	TURN_LEFT
2	TURN_RIGHT
3	SLIGHT_LEFT
4	SLIGHT_RIGHT
5	SHARP_LEFT
6	SHARP_RIGHT
7	LEFTSIDE_UTURN
8	WAYPOINT_FLAG
9	START_POINT_FLAG
10	END_POINT_FLAG
11	ROUNDABOUT_LEFTSIDE_STRAIGHT
12	ROUNDABOUT_LEFTSIDE_LEFT
13	ROUNDABOUT_LEFTSIDE_RIGHT
14	ROUNDABOUT_LEFTSIDE_SLIGHT_LEFT
15	ROUNDABOUT_LEFTSIDE_SLIGHT_RIGHT
16	ROUNDABOUT_LEFTSIDE_SHARP_LEFT
17	ROUNDABOUT_LEFTSIDE_SHARP_RIGHT
18	ROUNDABOUT_LEFTSIDE_UTURN
19	ROUNDABOUT_RIGHTSIDE_STRAIGHT
20	ROUNDABOUT_RIGHTSIDE_LEFT
21	ROUNDABOUT_RIGHTSIDE_RIGHT
22	ROUNDABOUT_RIGHTSIDE_SLIGHT_LEFT
23	ROUNDABOUT_RIGHTSIDE_SLIGHT_RIGHT
24	ROUNDABOUT_RIGHTSIDE_SHARP_LEFT
25	ROUNDABOUT_RIGHTSIDE_SHARP_RIGHT
26	ROUNDABOUT_RIGHTSIDE_UTURN
27	RIGHTSIDE_UTURN
28	MERGE_LEFT
29	MERGE_RIGHT
30	LEFTSIDE_OFFRAMP
31	RIGHTSIDE_OFFRAMP
33	INTERMEDIATE_STOP_FLAG

Hooks and Callbacks

Hooks and Callbacks related to Guidance can be found below.

GuidanceListener
onArrivedAtStop
onTruckWarningUpdate
onOverSpeedLimitEvent
onCrossedCountryBorder
onSafetyCamUpdate
onShowLaneAssist
onHideLaneAssist
onETAChanged
onEstimatedTravelTimeUpdated
onDistanceToDestinationUpdated
onPositionUpdate
onTurnInstructionEvent
onTrafficInfoProcessedForCurrentRoute
onTrafficInforProcessedForAlternateRoute
onSpeedLimitChanged
onItineraryUpdated

WEB SDK & APIs

INTERACTIVE MAPS

SOAP APIs (Web Services)

RESTful APIs (Web Services)

MOBILE SDK & APIs

COPILOT NAVIGATION

INTERACTIVE MAPS

GuidanceMgr - Navigation (CPIK Libraries)

GuidanceMgr.getCurrentPosition

GuidanceMgr.getLaneAssist

GuidanceMgr.getTurnInstruction

GuidanceMgr.getDistanceToDestination

GuidanceMgr.getCurrentRoad

GuidanceMgr.getRouteCoordinates

GuidanceMgr.getRouteTmcCodes

GuidanceMgr.getRouteTmcCodes (No duplicates)

GuidanceMgr.getCurrentSafetyCamera

GuidanceMgr.getETA

GuidanceMgr.getItineraryInfoList

GuidanceMgr.getGPSDevice

GuidanceMgr.enableEarlyTurnWarning

GuidanceMgr.isEarlyTurnWarningEnabled

GuidanceMgr.enableNearTurnWarning

GuidanceMgr.isNearTurnWarningEnabled

GuidanceMgr.enableFarTurnWarning

GuidanceMgr.isFarTurnWarningEnabled

GuidanceMgr.enableTurnRestrictions

GuidanceMgr.isTurnRestrictionEnabled

GuidanceMgr.enableClearTurnView

GuidanceMgr.isClearTurnViewEnabled

GuidanceMgr.enableClearTurnViewOnlyForHighways

GuidanceMgr.isClearTurnViewEnabledOnlyForHighways

GuidanceMgr.setClearTurnInstructionDrawDistance

GuidanceMgr.getClearTurnInstructionDrawDistance

GuidanceMgr.setClearTurnInstructionHideDistance

GuidanceMgr.getClearTurnInstructionHideDistance

GuidanceMgr.showTurnAfterNext

GuidanceMgr.isTurnAfterNextEnabled

GuidanceMgr.suspendNavigation

ChevronDisplayType

DriveSide

UnitsOfMeasure

CPUnitsOfMeasure

SpeedLimitWarningThreshold

AlertRange

TurnArrowImage

Hooks and Callbacks