The VgINavigationListener allow users to be notified of Navigation related events that occur within a VgINavigation Object where the listener has been registered. More...
Public Member Functions | |
| virtual double | getLength () const =0 |
| Gets the distance between start of this instruction to the start of the next instruction. | |
| virtual VgManeuverType | getManeuverType () const =0 |
| Gets the maneuver type to perform at end of the instruction. | |
| virtual const std::string & | getLayer () const =0 |
| Gets the layer name of the instruction. | |
| virtual const std::string & | getModality () const =0 |
| Gets the name of the used modality. | |
| virtual float | getTime () const =0 |
| Gets the time (not duration) relative to full route start. | |
| virtual float | getTotalTime () const =0 |
| Gets the total duration of the route. | |
| virtual float | getETA () const =0 |
| Gets the estimated remaining time in seconds (at start of this instruction). | |
| virtual float | getDuration () const =0 |
| Gets the duration. | |
| virtual unsigned int | getIndex () const =0 |
| Gets the index of the instruction, the index is 0-based, thus always less than VgINavigation->getNumInstructions(). | |
| virtual const VgEngine::VgPosition & | getPosition () const =0 |
| Gets the position of the start of the instruction. | |
| virtual const std::vector < VgNearPlace > | getNearPlaces () const =0 |
| Get the PlaceIDs of places near the end of the instruction. | |
| virtual bool | isEndOrTransitionPoint () const =0 |
| virtual const std::vector < VgEngine::VgPosition > & | getInstructionPositions () const =0 |
| Returns all the intermediate positions of the instruction. | |
| virtual const std::set < std::string > & | getAttributes () const =0 |
| Returns all the attributes of the traversed edges in a std::set. | |
Detailed Description
The VgINavigationListener allow users to be notified of Navigation related events that occur within a VgINavigation Object where the listener has been registered.
Member Function Documentation
| virtual const std::set< std::string >& VgNavigationModule::VgINavigationInstruction::getAttributes | ( | ) | const [pure virtual] |
Returns all the attributes of the traversed edges in a std::set.
- Version:
- 2.0.7729
| virtual float VgNavigationModule::VgINavigationInstruction::getDuration | ( | ) | const [pure virtual] |
Gets the duration.
- Returns:
- The duration of the instruction in seconds
- Version:
- 2.0.7729
| virtual float VgNavigationModule::VgINavigationInstruction::getETA | ( | ) | const [pure virtual] |
Gets the estimated remaining time in seconds (at start of this instruction).
- Returns:
- The ETA of the instruction.
- Version:
- 2.0.7729
| virtual unsigned int VgNavigationModule::VgINavigationInstruction::getIndex | ( | ) | const [pure virtual] |
Gets the index of the instruction, the index is 0-based, thus always less than VgINavigation->getNumInstructions().
- Returns:
- index of the instruction.
| virtual const std::vector<VgEngine::VgPosition>& VgNavigationModule::VgINavigationInstruction::getInstructionPositions | ( | ) | const [pure virtual] |
Returns all the intermediate positions of the instruction.
| virtual const std::string& VgNavigationModule::VgINavigationInstruction::getLayer | ( | ) | const [pure virtual] |
Gets the layer name of the instruction.
- Returns:
- The layer name of the instruction.
- Version:
- 2.0
| virtual double VgNavigationModule::VgINavigationInstruction::getLength | ( | ) | const [pure virtual] |
Gets the distance between start of this instruction to the start of the next instruction.
- Returns:
- distance in meters. The value will be 0 if the instruction is at the end of the route.
| virtual VgManeuverType VgNavigationModule::VgINavigationInstruction::getManeuverType | ( | ) | const [pure virtual] |
Gets the maneuver type to perform at end of the instruction.
- Returns:
- the maneuver type of the maneuver.
| virtual const std::string& VgNavigationModule::VgINavigationInstruction::getModality | ( | ) | const [pure virtual] |
Gets the name of the used modality.
- Returns:
- The modality name of the instruction.
- Version:
- 2.0.7729
| virtual const std::vector<VgNearPlace> VgNavigationModule::VgINavigationInstruction::getNearPlaces | ( | ) | const [pure virtual] |
Get the PlaceIDs of places near the end of the instruction.
This information is useful to complement the navigation instructions. They are ordered by places that are closests to the inside of turns for natural guidance. The number of places available will be a function of the value of VgINavigationRequestParameters::mNearPlacesThreshold at the time the navigation instructions where computed. It may be empty if there are no places that are closer than VgINavigationRequestParameters::mNearPlacesThreshold.
| virtual const VgEngine::VgPosition& VgNavigationModule::VgINavigationInstruction::getPosition | ( | ) | const [pure virtual] |
Gets the position of the start of the instruction.
- Returns:
- Position of start of instruction.
| virtual float VgNavigationModule::VgINavigationInstruction::getTime | ( | ) | const [pure virtual] |
Gets the time (not duration) relative to full route start.
- Returns:
- The time of the instruction from start of navigation in seconds
- Version:
- 2.0.7729
| virtual float VgNavigationModule::VgINavigationInstruction::getTotalTime | ( | ) | const [pure virtual] |
Gets the total duration of the route.
- Returns:
- The total time of this instruction's route in seconds
- Version:
- 2.0.7729
| virtual bool VgNavigationModule::VgINavigationInstruction::isEndOrTransitionPoint | ( | ) | const [pure virtual] |
- Returns:
- true if the instruction is the last one or if the instruction is the first one at a given floor or overall. Used to customize the written navigation instructions.
The documentation for this class was generated from the following file:
- VgINavigationInstruction.h