com.ptvag.navigation.sdk

Class Tour

java.lang.Object

com.ptvag.navigation.sdk.Tour

public class Tour
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	jniCMemOwn
protected long	jniCPtr
com.ptvag.navigation.sdk.NativeObject	parent

Constructor Summary

Constructors

Constructor and Description
Tour(java.io.File f)
Tour(java.lang.String fileName)
Tour(WayPoint start)

Method Summary

Modifier and Type	Method and Description
void	addStation(WayPoint wayPoint) Add a regular station to a tour
void	addStations(NativeArray<WayPoint> wayPoints) Add multiple regular stations to a formerly created tour.
void	addSVPs(NativeArray<SVPWayPoint> wayPoints) Add SVP stations to a tour An SVP station is a set of coordinates + direction which describe an approximation of a route to a destination.
void	delete() Kills rubbish if owning the object.
protected void	finalize()
static long	getCPtr(com.ptvag.navigation.sdk.NativeObject obj)
WayPoint	getDestination(short index) Get a particular destination of a tour by their index.
int	getDestinationCount() Get the number of destinations of the tour.
NativeArray<SVPWayPoint>	getDestinationSVPs(int index) Get the SVPs of a tour station.
int	getDestinationType(short index) Get the type of a particular destination, identified by their index.
WayPoint	getStartStation() Get the start station of the tour.
void	saveTour(java.io.File file) Save a tour to a bcr file.
void	saveTour(java.lang.String fileName) Save a tour to a bcr file.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

jniCPtr

protected long jniCPtr

jniCMemOwn

protected boolean jniCMemOwn

parent

public com.ptvag.navigation.sdk.NativeObject parent

Constructor Detail

Tour

public Tour(WayPoint start)
     throws NavigationException

Throws:

NavigationException

Tour

public Tour(java.io.File f)
     throws NavigationException

Throws:

NavigationException

Tour

public Tour(java.lang.String fileName)
     throws NavigationException

Throws:

NavigationException

Method Detail

addSVPs

public void addSVPs(NativeArray<SVPWayPoint> wayPoints)
             throws NavigationException

Add SVP stations to a tour An SVP station is a set of coordinates + direction which describe an approximation of a route to a destination. The navigation sdk will try to calculate a route which comes close to the provided coordinates.

Parameters:

wayPoints - The provided SVP route coordinates

Throws:

NavigationException

addStations

public void addStations(NativeArray<WayPoint> wayPoints)
                 throws NavigationException

Add multiple regular stations to a formerly created tour.

Parameters:

wayPoints - An array of waypoints to add to the tour.

Throws:

NavigationException

addStation

public void addStation(WayPoint wayPoint)
                throws NavigationException

Add a regular station to a tour

Parameters:

wayPoint - The coordinate (and direction) of the station.

Throws:

NavigationException

saveTour

public void saveTour(java.io.File file)
              throws NavigationException

Save a tour to a bcr file. Attention: The start station will become the first station in the file, the target stations of the tour will be added as consecutive stations. No other information except the stations will be saved.

Parameters:

file - The file to save

Throws:

NavigationException

saveTour

public void saveTour(java.lang.String fileName)
              throws NavigationException

Save a tour to a bcr file. Attention: The start station will become the first station in the file, the target stations of the tour will be added as consecutive stations. No other information except the stations will be saved.

Parameters:

fileName - The name of the file to save

Throws:

NavigationException

getStartStation

public WayPoint getStartStation()
                         throws NavigationException

Get the start station of the tour.

Returns:

The start station

Throws:

NavigationException

getDestination

public WayPoint getDestination(short index)
                        throws NavigationException

Get a particular destination of a tour by their index. The number of destinations can be determined by calling getDestinationCount(). Accessing one particular stations is done by calling this function with the index of the destination that is wanted. If the destination station which is accessed is an SVP destination, the last SVP point of the SVP array will be returned.

Parameters:

index - The index of the station in the tour

Returns:

The destination as a Waypoint

Throws:

NavigationException

getDestinationSVPs

public NativeArray<SVPWayPoint> getDestinationSVPs(int index)
                                            throws NavigationException

Get the SVPs of a tour station. The SVP points will be returned as a array of SVPWaypoints If the station identified by the index is not an SVP station, an exception will be thrown.

Parameters:

index - The index of the station in the tour

Returns:

An array of SVPWaypoints

Throws:

NavigationException

getDestinationCount

public int getDestinationCount()
                        throws NavigationException

Get the number of destinations of the tour.

Returns:

The number of destinations

Throws:

NavigationException

getDestinationType

public int getDestinationType(short index)
                       throws NavigationException

Get the type of a particular destination, identified by their index. There are two types of destinations: - Regular and - SVP stations

Parameters:

index - The index of the station in the tour

Returns:

0 for a regular station, 1 for an SVP

Throws:

NavigationException

getCPtr

public static long getCPtr(com.ptvag.navigation.sdk.NativeObject obj)

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

delete

public void delete()

Kills rubbish if owning the object.