Static Public Member Functions
static void	switchMap (String loadPath, int maxTime) throws GeneralException
	Loads map from .mlm file. More...

static void	showCoordinatesOnMap (Position location, int zoom, int maxTime) throws GeneralException
	Shows taken location on BrowseMap. More...

static void	showRectangleOnMap (Rectangle rect, int maxTime) throws GeneralException
	Shows taken rectangle on the BrowseMap. More...

static int	addBitmapToMap (String bitmapPath, int x, int y, int maxTime) throws GeneralException
	Shows picture on BrowseMap. More...

static void	removeBitmap (int bitmapId, int maxTime) throws GeneralException
	Removes picture from BrowseMap. More...

static void	removeAllBitmaps (int maxTime) throws GeneralException
	Removes all pictures from BrowseMap. More...

static void	showBitmap (int bitmapId, boolean show, int maxTime) throws GeneralException
	Shows or hides picture on BrowseMap. More...

static void	moveBitmap (int bitmapId, int x, int y, int maxTime) throws GeneralException
	Moves picture on BrowseMap. More...

static void	loadGFFile (String path, int maxTime) throws GeneralException
	The function loads a GF file then draws GF data on map. More...

static void	unloadGFFile (String path, int maxTime) throws GeneralException
	The function unloads GF file and erases all lines drawn before. More...

static void	loadExternalFile (String path, int type, int maxTime) throws GeneralException
	Loads external file. More...

static void	unloadExternalFile (String path, int type, int maxTime) throws GeneralException
	Unloads external file. More...

static void	reloadExternalFiles (int maxTime) throws GeneralException
	Reloads all external files stored in geofiles folder. More...

Member Function Documentation

static int addBitmapToMap	(	String	bitmapPath,
		int	x,
		int	y,
		int	maxTime
	)		throws GeneralException

static

Shows picture on BrowseMap.

Parameters

bitmapPath	Full path to desired picture.
x	X-coordinate of picture position on BrowseMap.
y	Y-coordinate of picture position on BrowseMap.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Returns: int which contains returned picture ID that can be used later to manipulate with picture. Value is set by AddBitmapToMap function.

Notes:
Picture must be of 32 bit bmp format.
X and Y coordinates represents geographical longitude and latitude taken in meters.
BrowseMap is map shown on after clicking Browse Map menu button. BrowseMap allows browse the loaded maps and change zoom.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void loadExternalFile	(	String	path,
		int	type,
		int	maxTime
	)		throws GeneralException

static

Loads external file.

Parameters

path	the full path to file
type	External file type 1 - GF file, 2 - TMC file
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void loadGFFile	(	String	path,
		int	maxTime
	)		throws GeneralException

static

The function loads a GF file then draws GF data on map.

Parameters

path	Path to the GF file
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void moveBitmap	(	int	bitmapId,
		int	x,
		int	y,
		int	maxTime
	)		throws GeneralException

static

Moves picture on BrowseMap.

Parameters

bitmapId	Picture ID returned from addBitmapToMap(String, int, int, int) function. Identifies picture to be moved.
x	X-coordinate of picture position on BrowseMap.
y	Y-coordinate of picture position on BrowseMap.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Notes:
X and Y coordinates represents geographical longitude and latitude taken in meters.
BrowseMap is map shown on after clicking Browse Map menu button. BrowseMap allows browse the loaded maps and change zoom.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void reloadExternalFiles ( int maxTime ) throws GeneralException

static

Reloads all external files stored in geofiles folder.

Parameters

maxTime Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void removeAllBitmaps ( int maxTime ) throws GeneralException

static

Removes all pictures from BrowseMap.

Parameters

maxTime Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Notes:
RemoveBitmap function removes bitmap from BrowseMap and also deletes all alocated memory.
BrowseMap is map shown on after clicking Browse Map menu button. BrowseMap allows browse the loaded maps and change zoom.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void removeBitmap	(	int	bitmapId,
		int	maxTime
	)		throws GeneralException

static

Removes picture from BrowseMap.

Parameters

bitmapId	Picture ID retrieved from addBitmapToMap(String, int, int, int) function. Identifies picture to be removed.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Notes:
RemoveBitmap function removes bitmap from BrowseMap and also deletes all alocated memory.
BrowseMap is map shown on after clicking Browse Map menu button. BrowseMap allows browse the loaded maps and change zoom.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void showBitmap	(	int	bitmapId,
		boolean	show,
		int	maxTime
	)		throws GeneralException

static

Shows or hides picture on BrowseMap.

Parameters

bitmapId	Picture ID returned from addBitmapToMap(String, int, int, int) function. Identifies picture to be shown/hidden.
show	Determines whether picture will be shown or hidden. *true* - Picture will be shown. *false* - Picture will be hidden.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Notes:
BrowseMap is map shown on after clicking Browse Map menu button. BrowseMap allows browse the loaded maps and change zoom.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void showCoordinatesOnMap	(	Position	location,
		int	zoom,
		int	maxTime
	)		throws GeneralException

static

Shows taken location on BrowseMap.

Parameters

location	Position instance which contains location which will be shown on BrowseMap.
zoom	Distance (in meters) form ground.Range of this parameter should be between 50 and 30000000.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Notes:
Point with taken location will be shown in the middle of BrowseMap.
BrowseMap is map shown on after clicking Browse Map menu button. BrowseMap allows browse the loaded maps and change zoom.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void showRectangleOnMap	(	Rectangle	rect,
		int	maxTime
	)		throws GeneralException

static

Shows taken rectangle on the BrowseMap.

Parameters

rect	Rectangle instance which contains rectangle to show on the BrowseMap.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Notes:
Zoom will be adjusted so that entire rectangle will be shown.
BrowseMap is map shown on after clicking Browse Map menu button. BrowseMap allows browse the loaded maps and change zoom.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void switchMap	(	String	loadPath,
		int	maxTime
	)		throws GeneralException

static

Loads map from .mlm file.

Parameters

loadPath	Full path to .mlm file.
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void unloadExternalFile	(	String	path,
		int	type,
		int	maxTime
	)		throws GeneralException

static

Unloads external file.

Parameters

path	the full path to file
type	External file type 1 - GF file, 2 - TMC file
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

static void unloadGFFile	(	String	path,
		int	maxTime
	)		throws GeneralException

static

The function unloads GF file and erases all lines drawn before.

Parameters

path	Path to the GF file
maxTime	Maximum of time (in milliseconds) function can take. If maxTime=0 function execution is not time limited.

Exceptions

GeneralException the general exception

References Api.getInstance(), and Api.getService().

Static Public Member Functions

Member Function Documentation