Companion
Functions
Properties
Action: Request for calculating route to a position Arguments: calculateRoute: PFCalculateRoute Returns calculated routes: PFCalculateRouteResult Postcondition: User will be presented with calculated routes
Action: Request for getting current vehicle position Returns: PFGeoPosition
Action: Request for getting active map modes Returns: PFMapMode
Action: Request for getting categories list Returns: PFPoiCategoryResult
Action: Request for getting favorite by type Returns location info: PFLocationInfo
Action: List all itineraries managed by navigation Arguments: argBool true if detaile reports are required, if false only id and name is provided Returns : PFCmdItinerary
Action: Request for getting last destinations Returns list of locations: PFLocationInfo
Action: Request for getting waypoints for the current route Returns: PFGeoPosition
UseCase: User wants to change the guidance prompts setting Action: Changes guidance prompt setting by predefined value Arguments: guidancePrompt: PFGuidancePrompt Postcondition: Audio setting will be applied If argGuidancePrompt is PFGuidancePrompt:Unmute - Audio for route guidance will be unmuted If argGuidancePrompt is PFGuidancePrompt:Mute - Audio for route guidance will be muted
Action: Updates map camera setting Arguments: mapCamera: PFMapCamera Postcondition: If argZoom is PFMapCamera:Reset - Map display will reset to default zoom level. If actual zoom level is the same as default => nothing happens If argZoom is PFMapCamera:In - Map display will be zoomed in. If maxiumum zoom in => nothing happens If argZoom is PFMapCamera:Out - Map display will be zoomed out. If maximum zoom out => nothing happens If argZoom is PFMapCamera:Auto - Auto zoom setting for map display will be enabled If argZoom is PFMapCamera:twoDimensional - Shows map in 2D If argZoom is PFMapCamera:threeDimensional - Shows map in 3D
UseCase: User wants to navigate to an address / POI Precondition: Free drive, Navigating with visible map Action : Opens Profi Navi Route planner with computed route to the chosen address / POI Arguments: argStr: string == address / POI Postcondition: Profi Navi Route planner will show active route and if applicable other alternatives Alternative: If Route cannot be computed error will be shown
UseCase: User wants to see the location on map with information Precondition: Free drive, Navigating with visible map, other POI detail shown Action: Show POI detail. From here you can call "NaviLocationSet" to plan route Arguments: argStr: string == address / POI Postcondition: List of information for the POI is listed and a marker is shown on the map
Precondition: Navigating with visible map Action: Request to replace waypoint on provided position to another Postcondition: Route will be updated with the replaced waypoint Arguments: positions: PFGeoPosition
Action: Request for resolving location info from geo coordinates Arguments: position: PFGeoPosition Returns location info: PFLocationInfo
Action: Search request Arguments: search: PFSearch Returns search results: PFSearchResult
Action: Request for placing markers Arguments: positions: PFGeoPosition
UseCase: User wants to update route option for the ongoing route Precondition: Navigating with visible map Action: Profi Navi will calculate new route Arguments: routeOption: PFSetRouteOption == applied route option Postcondition: Profi Navi navigates to destination with updated route option Alternative: If route cannot be computed error will be shown