net.rim.device.api.lbs.travel
Class TravelTimeOptions

java.lang.Object
  extended by net.rim.device.api.lbs.travel.TravelTimeOptions

public final class TravelTimeOptions
extends Object

Represents optional settings for a travel time estimate request. To specify options for an estimate request, create an instance of this class, set the desired values, and pass the instance to the appropriate TravelTimeEstimator request method.

See Also:
TravelTimeEstimator
Since:
BlackBerry API 6.0.0

Constructor Summary
TravelTimeOptions()
          Constructs an instance of this class with all properties set to their unspecified values.
 
Method Summary
 float getStartCourse()
          Retrieves the course (also known as heading) at the starting point.
 float getStartSpeed()
          Retrieves the speed at the starting point.
 void setStartCourse(float startCourse)
          Sets the course (also known as heading) at the starting point.
 void setStartSpeed(float startSpeed)
          Sets the speed at the starting point.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

TravelTimeOptions

public TravelTimeOptions()
Constructs an instance of this class with all properties set to their unspecified values.

Since:
BlackBerry API 6.0.0


Method Detail

getStartCourse

public float getStartCourse()
Retrieves the course (also known as heading) at the starting point.

Returns:
The starting course specified in degrees [0.0, 360.0) clockwise from true north. If the course is not specified, NaN is returned.
Since:
BlackBerry API 6.0.0

setStartCourse

public void setStartCourse(float startCourse)
Sets the course (also known as heading) at the starting point. Specifying the course can help optimize the route at the starting point.

Parameters:
startCourse - The starting course specified in degrees [0.0, 360) clockwise from true north. Specify Float.NaN to indicate that the course is unknown.
Throws:
IllegalArgumentException - if startCourse is out of range.
Since:
BlackBerry API 6.0.0

getStartSpeed

public float getStartSpeed()
Retrieves the speed at the starting point.

Returns:
The starting speed expressed in meters per second. If the speed is not specified, Float.NaN is returned.
Since:
BlackBerry API 6.0.0

setStartSpeed

public void setStartSpeed(float startSpeed)
Sets the speed at the starting point. Specifying the speed can help optimize the route at the starting point.

Parameters:
startSpeed - The starting point speed expressed in meters per second. Specify Float.NaN to indicate that the speed is unknown.
Throws:
IllegalArgumentException - If startSpeed is negative.
Since:
BlackBerry API 6.0.0





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal