de.infoware.android.mti.FollowMeRoute Class Reference

Static Public Member Functions
static native int	followMeStartAt (int meters)
static native int	getFollowMeEvents ()
static native int	getFollowMeEventAt (int index)
static native int	startFollowGpsPath (String followMeFile)
static native int	startFollowMeSimulation (String followMeFile)
static native int	setStopMode (FmrStopMode mode)
static native int	pauseFollowGpsPath ()
static native int	continueFollowGpsPath ()
static native int	stopFollowGpsPath ()
static native int	isFollowMeRoutePaused ()
static native int	getFollowMeRouteFile ()
static native int	addFollowMeEventToRecord (String eventValue)
static native int	getFollowMeRoutes ()
static native int	getFollowMeRouteAt (int index)
static void	addListener (FollowMeRouteListener listener)
static void	removeListener (FollowMeRouteListener listener)
static void	removeAllListeners ()

Detailed Description

Member Function Documentation

addFollowMeEventToRecord()

static native int de.infoware.android.mti.FollowMeRoute.addFollowMeEventToRecord ( String  eventValue )

static

Add the given follow me event to the follow me file that is recorded at the moment Only works if follow me recorder is started

Parameters

eventValue

- text to be spoken or shown

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.addFollowMeEventToRecordResult().

addListener()

static void de.infoware.android.mti.FollowMeRoute.addListener ( FollowMeRouteListener  listener )

static

continueFollowGpsPath()

static native int de.infoware.android.mti.FollowMeRoute.continueFollowGpsPath ( )

static

Switches to the Map view and continues the last paused follow me route to the segment where the follow me route was paused. This can be used to continue at the same route segment at a later point in time.

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.continueFollowGpsPathResult().

followMeStartAt()

static native int de.infoware.android.mti.FollowMeRoute.followMeStartAt ( int  meters )

static

Starts a followMe route guidance at a certain distance (in meters) to destination.

Parameters

meters

- Meters to destination of the entire route

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.followMeStartAtResult().

getFollowMeEventAt()

static native int de.infoware.android.mti.FollowMeRoute.getFollowMeEventAt ( int  index )

static

Returns an event of a FollowMe route. To iterate over the events, you first have to call FollowMeRoute.getFollowMeEvents() to initialize the list at a certain time.

Parameters

index

- Index of the event

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.getFollowMeEventAtResult().

getFollowMeEvents()

static native int de.infoware.android.mti.FollowMeRoute.getFollowMeEvents ( )

static

Initializes an iterator to get all events with FollowMeRoute.getFollowMeEventAt() of a FollowMe route.

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.getFollowMeEventsResult().

getFollowMeRouteAt()

static native int de.infoware.android.mti.FollowMeRoute.getFollowMeRouteAt ( int  index )

static

Returns a locally available FollowMe route that was published to this device from a pot. To iterate over the routes, you first have to call FollowMeRoute.getFollowMeRoutes() to initialize the list at a certain time.

Parameters

index

- Index of the event

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.getFollowMeRouteAtResult().

getFollowMeRouteFile()

static native int de.infoware.android.mti.FollowMeRoute.getFollowMeRouteFile ( )

static

Get the file that provides the the current active or paused follow me route

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.getFollowMeRouteFileResult().

getFollowMeRoutes()

static native int de.infoware.android.mti.FollowMeRoute.getFollowMeRoutes ( )

static

Initializes an iterator to get all available FollowMe routes that are published to this device with FollowMeRoute.getFollowMeRouteAt().

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.getFollowMeRoutesResult().

isFollowMeRoutePaused()

static native int de.infoware.android.mti.FollowMeRoute.isFollowMeRoutePaused ( )

static

Ask if a follow me route has been paused.

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.isFollowMeRoutePausedResult().

pauseFollowGpsPath()

static native int de.infoware.android.mti.FollowMeRoute.pauseFollowGpsPath ( )

static

Stops the follow me process and remembers the current position on the follow me route. A paused follow me route can be continued after a restart of MapTrip.

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.INVALID_OPERATION if a follow me simulation is running
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.pauseFollowGpsPathResult().

removeAllListeners()

static void de.infoware.android.mti.FollowMeRoute.removeAllListeners ( )

static

removeListener()

static void de.infoware.android.mti.FollowMeRoute.removeListener ( FollowMeRouteListener  listener )

static

setStopMode()

static native int de.infoware.android.mti.FollowMeRoute.setStopMode ( FmrStopMode  mode )

static

Set how remaining & missed points are handled if a FollowMe route has been stopped or is finished. Default is FmrStopMode.COLLECT.

Parameters

mode

FmrStopMode.COLLECT if set, remaining points will be kept on the map and can be collected after FMR has stopped or is finished FmrStopMode.DISCARD if set, remaining points will be hidden after follow me has stopped FmrStopMode.ASK_USER shows a dialog after FMR has stopped / is finished to let the user decide which mode to activate

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.setStopModeResult().

startFollowGpsPath()

static native int de.infoware.android.mti.FollowMeRoute.startFollowGpsPath ( String  followMeFile )

static

Switches to the Map view and starts a follow me route. The follow me file is passed as absolute path on the device OR the relative path of the FollowMeServer. The relative path of the FollowMeServer consists of the pot ID, the file name and the file extension ".csv".

Parameters

followMeFile

- absolute path and file name on the device or relative path FollowMeServer. The relative path of the FollowMeServer consists of the pot ID, the file name and the file extension ".csv".

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.startFollowGpsPathResult().

startFollowMeSimulation()

static native int de.infoware.android.mti.FollowMeRoute.startFollowMeSimulation ( String  followMeFile )

static

Switches to the Map view and starts a follow me route simulation. The follow me file is passed as absolute path on the device OR the relative path of the FollowMeServer. The relative path of the FollowMeServer consists of the pot ID, the file name and the file extension ".csv". A follow me simulation can not be paused.

Parameters

followMeFile

- absolute path and file name on the device or relative path FollowMeServer. The relative path of the FollowMeServer consists of the pot ID, the file name and the file extension ".csv".

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.startFollowMeSimulationResult().

stopFollowGpsPath()

static native int de.infoware.android.mti.FollowMeRoute.stopFollowGpsPath ( )

static

Indicate the server to stop the current running FollowMe route ( a paused route can not be stopped ).

Returns

• if > 0 unique Id of the request,
• ApiError.MESSAGE_NOT_SEND if the communication to the server does not work
• ApiError.NOT_INITIALIZED if Api.init() was not called before
• ApiError.QUEUE_LIMIT_EXCEEDED if the interface has received the max amount of messages without processing them

Invokes callback FollowMeRouteListener.stopFollowGpsPathResult().