BaseParameters

Note

This is the parent class to many parameter classes, and not intended to be used on its own.

Parameters:

Name	Type	Description	Default
coordinates	list of floats pairs	Pairs of Longitude and Latitude Coordinates. (default [])	required
hints	list	Hint from previous request to derive position in street network. (default [])	required
radiuses	list of floats	Limits the search to given radius in meters. (default [])	required
bearings	list of int pairs	Limits the search to segments with given bearing in degrees towards true north in clockwise direction. (default [])	required
approaches	list	Keep waypoints on curb side. (default [])	required
generate_hints	bool	Adds a hint to the response which can be used in subsequent requests. (default True)	required
exclude	list of strings	Additive list of classes to avoid. (default [])	required
snapping	string 'default' | 'any'	'default' snapping avoids is_startpoint edges, 'any' will snap to any edge in the graph. (default \'\')	required

Returns:

Name	Type	Description
__init__	BaseParameters	A BaseParameter object, that is the parent object to many other Parameter objects.
IsValid	bool	A bool value denoting validity of parameter values.

Attributes:

Name	Type	Description
coordinates	list of floats pairs	Pairs of longitude & latitude coordinates.
hints	list	Hint from previous request to derive position in street network.
radiuses	list of floats	Limits the search to given radius in meters.
bearings	list of int pairs	Limits the search to segments with given bearing in degrees towards true north in clockwise direction.
approaches	list	Keep waypoints on curb side.
exclude	list of strings	Additive list of classes to avoid, order does not matter.
format	string	Specifies response type - currently only 'json' is supported.
generate_hints	bool	Adds a hint to the response which can be used in subsequent requests.
skip_waypoints	list	Removes waypoints from the response.
snapping	string	'default' snapping avoids is_startpoint edges, 'any' will snap to any edge in the graph.

Source code in osrm/osrm_ext.pyi

def __init__(self) -> None:
    r"""
    Instantiates an instance of BaseParameters.

    Note:
                    This is the parent class to many parameter classes, and not intended to be used on its own.

    Args:
                    coordinates (list of floats pairs): Pairs of Longitude and Latitude Coordinates. (default [])
                    hints (list): Hint from previous request to derive position in street network. (default [])
                    radiuses (list of floats): Limits the search to given radius in meters. (default [])
                    bearings (list of int pairs): Limits the search to segments with given bearing in degrees towards true north in clockwise direction. (default [])
                    approaches (list): Keep waypoints on curb side. (default [])
                    generate_hints (bool): Adds a hint to the response which can be used in subsequent requests. (default True)
                    exclude (list of strings): Additive list of classes to avoid. (default [])
                    snapping (string 'default' | 'any'): 'default' snapping avoids is_startpoint edges, 'any' will snap to any edge in the graph. (default \'\')

    Returns:
                    __init__ (osrm.osrm_ext.BaseParameters): A BaseParameter object, that is the parent object to many other Parameter objects.
                    IsValid (bool): A bool value denoting validity of parameter values.

    Attributes:
                    coordinates (list of floats pairs): Pairs of longitude & latitude coordinates.
                    hints (list): Hint from previous request to derive position in street network.
                    radiuses (list of floats): Limits the search to given radius in meters.
                    bearings (list of int pairs): Limits the search to segments with given bearing in degrees towards true north in clockwise direction.
                    approaches (list): Keep waypoints on curb side.
                    exclude (list of strings): Additive list of classes to avoid, order does not matter.
                    format (string): Specifies response type - currently only 'json' is supported.
                    generate_hints (bool): Adds a hint to the response which can be used in subsequent requests.
                    skip_waypoints (list): Removes waypoints from the response.
                    snapping (string): 'default' snapping avoids is_startpoint edges, 'any' will snap to any edge in the graph.
    """