SAP ABAP Interface IF_GIS_ROUTE (GIS: Routing functionality)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-FES-IGS (Application Component) Internet Graphics Service
     ⤷ SGIS (Package) GIS Integration with IGS (Routing and Mapping)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_GIS_ROUTE_IGS	GIS: Routing using IGS	20020521

Properties

Interface	IF_GIS_ROUTE
Short Description	GIS: Routing functionality

General Data

Package	SGIS	GIS Integration with IGS (Routing and Mapping)
Created	20020521	SAP
Last changed	00000000	SAP
Unicode checks active	☑

Forward declarations

Interface IF_GIS_ROUTE has no forward declaration.

Interfaces

Interface IF_GIS_ROUTE has no interface.

Friends

Interface IF_GIS_ROUTE has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_PROPERTY_PRECISION	Constant	Public	☐	Type reference (TYPE)	STRING	'precision'	Property: route precision	20020730
2	C_PROPERTY_ROUTETYPE	Constant	Public	☐	Type reference (TYPE)	STRING	'routetype'	Property: route type	20020730
3	C_PROPERTY_VELOCITY_HIGH	Constant	Public	☐	Type reference (TYPE)	STRING	'velocity_high'	Property: high velocity	20020730
4	C_PROPERTY_VELOCITY_LOW	Constant	Public	☐	Type reference (TYPE)	STRING	'velocity_low'	Property: low velocity	20020730
5	C_PROPERTY_VELOCITY_MEDIUM	Constant	Public	☐	Type reference (TYPE)	STRING	'velocity_medium'	Property: medium velocity	20020730
6	C_PROPVAL_ROUTETYPE_QUICKEST	Constant	Public	☐	Type reference (TYPE)	STRING	'quickest'	Property value: route type quickest	20020730
7	C_PROPVAL_ROUTETYPE_SHORTEST	Constant	Public	☐	Type reference (TYPE)	STRING	'shortest'	Property value: route type shortest	20020730

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_STOP	Instance method	Public	Method	Adds a stop to the route	20020521
2	EXECUTE	Instance method	Public	Method	Executes route request	20020521
3	GET_PART_BORDER	Instance method	Public	Method	Get the border of a specific part	20020521
4	GET_PART_COUNT	Instance method	Public	Method	Get the part count of the route	20020521
5	GET_PART_INFO	Instance method	Public	Method	Get informations about a specific part	20020521
6	GET_PART_PATH	Instance method	Public	Method	Get the path of a specific part	20020521
7	GET_ROUTE_BORDER	Instance method	Public	Method	Get the border of the whole route	20020521
8	GET_ROUTE_INFO	Instance method	Public	Method	Get informations about the whole route	20020521
9	GET_ROUTE_PATH	Instance method	Public	Method	Get the path of the whole route	20020521
10	GET_SEGMENT_BORDER	Instance method	Public	Method	Get the border of a specific segment	20020521
11	GET_SEGMENT_COUNT	Instance method	Public	Method	Get the segment count of a specific part	20020521
12	GET_SEGMENT_INFO	Instance method	Public	Method	Get informations about a specific segment	20020521
13	GET_SEGMENT_PATH	Instance method	Public	Method	Get the path of a specific segment	20020521
14	RESET	Instance method	Public	Method	Resets the route data	20020521
15	SET_PROPERTY	Instance method	Public	Method	Sets a route request property	20020521

Events

Interface IF_GIS_ROUTE has no event.

Types

Interface IF_GIS_ROUTE has no local type.

Method Signatures

Method ADD_STOP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Value transfer	☑	Type reference (TYPE)	STRING		Bezeichnung	20020521
2	Importing	ID	Value transfer	☐	Type reference (TYPE)	C		Identifizierung	20020521
3	Importing	POSITION	Call by reference	☐	Type reference (TYPE)	GEOPOSITION		Geographische Position in WGS84-Koordinaten	20020521

Method ADD_STOP on Interface IF_GIS_ROUTE has no exception.

Method EXECUTE Signature

Method EXECUTE on Interface IF_GIS_ROUTE has no parameter.

#	Exception	Resumable	Description	Created on
1	EMPTY_ROUTE	☐	Keine Stopps für Route definiert	20020521
2	INTERNAL_ERROR	☐	Interner Fehler	20020521
3	INVALID_ROUTE	☐	Ungültige Route angegeben	20020521

Method GET_PART_BORDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	BORDER	Value transfer	☐	Type reference (TYPE)	GEOBORDER		Geographischer Rahmen in WGS84-Koordinaten	20020521
2	Importing	PART	Value transfer	☐	Type reference (TYPE)	I		Teilstück	20020521

#	Exception	Resumable	Description	Created on
1	INVALID_INDEX	☐	Teilindex ungültig	20020722

Method GET_PART_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COUNT	Value transfer	☐	Type reference (TYPE)	I		Anzahl	20020521

Method GET_PART_COUNT on Interface IF_GIS_ROUTE has no exception.

Method GET_PART_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DESCRIPTION	Value transfer	☐	Type reference (TYPE)	STRING		Bezeichnung	20020521
2	Exporting	DISTANCE	Value transfer	☐	Type reference (TYPE)	GEODIST		Distanz zwischen zwei geographischen Lokationen	20020521
3	Exporting	DURATION	Value transfer	☐	Type reference (TYPE)	GEODURAN		Dauer für eine Route zwischen zwei geographischen Lokationen	20020521
4	Importing	PART	Value transfer	☐	Type reference (TYPE)	I		Teilstück	20020521

#	Exception	Resumable	Description	Created on
1	INVALID_INDEX	☐	Teilindex ungültig	20020722

Method GET_PART_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PART	Value transfer	☐	Type reference (TYPE)	I		Teilstück	20020521
2	Returning	POSITIONS	Value transfer	☐	Type reference (TYPE)	GEOPOSITIONSTAB		Tabelle der geographischen Positionen	20020521

#	Exception	Resumable	Description	Created on
1	INVALID_INDEX	☐	Teilindex ungültig	20020722

Method GET_ROUTE_BORDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	BORDER	Value transfer	☐	Type reference (TYPE)	GEOBORDER		Geographischer Rahmen in WGS84-Koordinaten	20020521

Method GET_ROUTE_BORDER on Interface IF_GIS_ROUTE has no exception.

Method GET_ROUTE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DESCRIPTION	Value transfer	☐	Type reference (TYPE)	STRING		Bezeichnung	20020521
2	Exporting	DISTANCE	Value transfer	☐	Type reference (TYPE)	GEODIST		Distanz zwischen zwei geographischen Lokationen	20020521
3	Exporting	DURATION	Value transfer	☐	Type reference (TYPE)	GEODURAN		Dauer für eine Route zwischen zwei geographischen Lokationen	20020521

Method GET_ROUTE_INFO on Interface IF_GIS_ROUTE has no exception.

Method GET_ROUTE_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	POSITIONS	Value transfer	☐	Type reference (TYPE)	GEOPOSITIONSTAB		Tabelle der geographischen Positionen	20020521

Method GET_ROUTE_PATH on Interface IF_GIS_ROUTE has no exception.

Method GET_SEGMENT_BORDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	BORDER	Value transfer	☐	Type reference (TYPE)	GEOBORDER		Geographischer Rahmen in WGS84-Koordinaten	20020521
2	Importing	PART	Value transfer	☐	Type reference (TYPE)	I		Teilstück	20020521
3	Importing	SEGMENT	Value transfer	☐	Type reference (TYPE)	I		Segment	20020521

#	Exception	Resumable	Description	Created on
1	INVALID_INDEX	☐	Teil- oder Segmentindex ungültig	20020722

Method GET_SEGMENT_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	COUNT	Value transfer	☐	Type reference (TYPE)	I		Anzahl	20020521
2	Importing	PART	Value transfer	☐	Type reference (TYPE)	I		Teilstück	20020521

#	Exception	Resumable	Description	Created on
1	INVALID_INDEX	☐	Teilindex ungültig	20020722

Method GET_SEGMENT_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DESCRIPTION	Value transfer	☐	Type reference (TYPE)	STRING		Bezeichnung	20020521
2	Exporting	DISTANCE	Value transfer	☐	Type reference (TYPE)	GEODIST		Distanz zwischen zwei geographischen Lokationen	20020521
3	Exporting	DURATION	Value transfer	☐	Type reference (TYPE)	GEODURAN		Dauer für eine Route zwischen zwei geographischen Lokationen	20020521
4	Importing	PART	Value transfer	☐	Type reference (TYPE)	I		Teilstück	20020521
5	Importing	SEGMENT	Value transfer	☐	Type reference (TYPE)	I		Segment	20020521

#	Exception	Resumable	Description	Created on
1	INVALID_INDEX	☐	Teil- oder Segmentindex ungültig	20020722

Method GET_SEGMENT_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PART	Value transfer	☐	Type reference (TYPE)	I		Teilstück	20020521
2	Returning	POSITIONS	Value transfer	☐	Type reference (TYPE)	GEOPOSITIONSTAB		Tabelle der geographischen Positionen	20020521
3	Importing	SEGMENT	Value transfer	☐	Type reference (TYPE)	I		Segment	20020521

#	Exception	Resumable	Description	Created on
1	INVALID_INDEX	☐	Teil- oder Segmentindex ungültig	20020722

Method RESET Signature

Method RESET on Interface IF_GIS_ROUTE has no parameter.
Method RESET on Interface IF_GIS_ROUTE has no exception.

Method SET_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name	20020521
2	Importing	VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Wert	20020521

#	Exception	Resumable	Description	Created on
1	INVALID_PROPERTY	☐	Eigenschaft ungültig	20020722

History

Last changed by/on	SAP	00000000
SAP Release Created in