StopOffPoint class is used during manipulation with itinerary.
More...
|
| StopOffPoint () |
| Class constructor.
|
|
| StopOffPoint (boolean searchAddress, boolean visited, int pointType, int x, int y, int offset, int id, String iso, String caption, String address) |
| Class constructor.
|
|
String | getAddress () |
| Returns address of waypoint.
|
|
void | setAddress (String address) |
|
String | getCaption () |
| Returns name of waypoint.
|
|
void | setCaption (String caption) |
| Sets name of waypoint.
|
|
String | getIso () |
| Returns the iso code of country, where the waypoint is located.
|
|
void | setIso (String iso) |
| Sets the iso code of country, where the waypoint is located.
|
|
boolean | isSearchAddress () |
|
void | setSearchAddress (boolean searchAddress) |
|
boolean | isVisited () |
|
void | setVisited (boolean visited) |
|
int | getPointType () |
|
void | setPointType (int pointType) |
|
Position | getLocation () |
|
void | setLocation (Position location) |
|
int | getOffset () |
|
void | setOffset (int offset) |
|
int | getId () |
| Gets the unique id.
|
|
void | setId (int dwId) |
| Sets the unique id.
|
|
String | toString () |
|
StopOffPoint class is used during manipulation with itinerary.
◆ StopOffPoint() [1/2]
◆ StopOffPoint() [2/2]
StopOffPoint |
( |
boolean | searchAddress, |
|
|
boolean | visited, |
|
|
int | pointType, |
|
|
int | x, |
|
|
int | y, |
|
|
int | offset, |
|
|
int | id, |
|
|
String | iso, |
|
|
String | caption, |
|
|
String | address ) |
◆ getAddress()
Returns address of waypoint.
Notes:
Address of waypoint is set only if bSearchAddress was set to true when adding waypoint.
- Returns
- A new string to address of waypoint.
Referenced by StopOffPoint.writeBundle().
◆ getCaption()
Returns name of waypoint.
Notes:
Name of waypoint is shown in itinerary items list.
- Returns
- A new string to name of waypoint.
Referenced by StopOffPoint.writeBundle().
◆ getId()
◆ getIso()
Returns the iso code of country, where the waypoint is located.
- Returns
- A new string to iso code of the country.
Referenced by StopOffPoint.writeBundle().
◆ getLocation()
◆ getOffset()
- Returns
- Road offset from our map, where the waypoint is located. Use conversion table to obtain the offset from map provider segment ID.
When using offset, the ISO code has to be used.
Referenced by StopOffPoint.writeBundle().
◆ getPointType()
- Returns
- Flag determining type of waypoint.
Notes:
Possible values are:
-
1 Viapoint
-
2 Finish
-
3 Start
-
4 Invisible
Referenced by StopOffPoint.writeBundle().
◆ isSearchAddress()
boolean isSearchAddress |
( |
| ) |
|
- Returns
- Flag determining whether function processing instance of this class searches for address (for example when adding waypoint).
Notes:
Possible values are:
-
true Search for address.
-
false Do not search for address.
Referenced by StopOffPoint.writeBundle().
◆ isVisited()
- Returns
- Flag determinig whether waypoint was already visited.
Notes:
Possible values are:
-
true Waypoint was visited.
-
false Waypoint was not visited.
Referenced by StopOffPoint.writeBundle().
◆ readBundle()
◆ setAddress()
void setAddress |
( |
String | address | ) |
|
◆ setCaption()
void setCaption |
( |
String | caption | ) |
|
Sets name of waypoint.
Notes:
Name of waypoint is shown in itinerary items list.
- Parameters
-
caption | A string contains the name of waypoint. |
◆ setId()
Sets the unique id.
- Parameters
-
◆ setIso()
void setIso |
( |
String | iso | ) |
|
Sets the iso code of country, where the waypoint is located.
- Parameters
-
iso | A string to iso code of country. |
◆ setLocation()
- Parameters
-
location | Position class defining position of waypoint on map. |
◆ setOffset()
void setOffset |
( |
int | offset | ) |
|
- Parameters
-
offset | Road offset from our map, where the waypoint is located. Use conversion table to obtain the offset from map provider segment ID.
When using offset, the ISO code has to be used. |
◆ setPointType()
void setPointType |
( |
int | pointType | ) |
|
- Parameters
-
pointType | Flag determining type of waypoint. |
Notes:
Possible values are:
-
1 Viapoint
-
2 Finish
-
3 Start
-
4 Invisible
◆ setSearchAddress()
void setSearchAddress |
( |
boolean | searchAddress | ) |
|
- Parameters
-
searchAddress | Flag determining whether function processing instance of this class searches for address (for example when adding waypoint). |
Notes:
Possible values are:
-
true Search for address.
-
false Do not search for address.
◆ setVisited()
void setVisited |
( |
boolean | visited | ) |
|
- Parameters
-
visited | Flag determinig whether waypoint was already visited. |
Notes:
Possible values are:
-
true Waypoint was visited.
-
false Waypoint was not visited.
◆ toString()
◆ writeBundle()
References StopOffPoint.getAddress(), StopOffPoint.getCaption(), StopOffPoint.getId(), StopOffPoint.getIso(), StopOffPoint.getLocation(), StopOffPoint.getOffset(), StopOffPoint.getPointType(), StopOffPoint.isSearchAddress(), StopOffPoint.isVisited(), and Position.toArray().
Referenced by ApiItinerary.addEntryToItinerary(), and ApiItinerary.addItinerary().