MSFRouteMatchingRequest

Objective-C


@interface MSFRouteMatchingRequest : NSObject {
  void *swigCPtr;
  BOOL swigCMemOwn;
}

Swift

class MSFRouteMatchingRequest : NSObject

A class that defines required attributes for route matching.

  • Checks if this object is equal to the specified object.

    Declaration

    Objective-C

    - (BOOL)isEqual:(id)object;

    Swift

    func isEqual(_ object: Any!) -> Bool

    Parameters

    object

    The reference object.

    Return Value

    True when objects are equal, false otherwise.

  • Returns the hash value of this object.

    Declaration

    Objective-C

    - (NSUInteger)hash;

    Swift

    func hash() -> UInt

    Return Value

    The hash value of this object.

  • Constructs a new RouteMatchingRequest instance from projection, measured points and accuracy.

    Declaration

    Objective-C

    - (id)initWithProjection:(MSFProjection *)projection
                  points:(MSFMapPosVector *)points
                accuracy:(float)accuracy;

    Swift

    init!(projection: MSFProjection!, points: MSFMapPosVector!, accuracy: Float)

    Parameters

    projection

    The projection of the points.
    points

    The list of points to match. Must contains at least 1 element.
    accuracy

    Accuracy of the points in meters.

  • Returns the projection of the points in the request.

    Declaration

    Objective-C

    - (MSFProjection *)getProjection;

    Swift

    func getProjection() -> MSFProjection!

    Return Value

    The projection of the request.

  • Returns the measured points of the request.

    Declaration

    Objective-C

    - (MSFMapPosVector *)getPoints;

    Swift

    func getPoints() -> MSFMapPosVector!

    Return Value

    The measured points of the request.

  • Returns the accuracy of the points in the request.

    Declaration

    Objective-C

    - (float)getAccuracy;

    Swift

    func getAccuracy() -> Float

    Return Value

    The accuracy of the points in the request.

  • Returns the parameter value for the given routing point.

    Declaration

    Objective-C

    - (MSFVariant *)getPointParameter:(int)index param:(NSString *)param;

    Swift

    func getPointParameter(_ index: Int32, param: String!) -> MSFVariant!

    Parameters

    index

    The routing point index.
    param

    The name of the parameter.

    Return Value

    The value of the specified parameter of the given routing point. If the parameter does not exist, empty variant is returned.

  • Sets the parameter value for the given routing point. This is currently supported by Valhalla routing engine and can be used to specify initial or final heading, for example.

    Declaration

    Objective-C

    - (void)setPointParameter:(int)index
                    param:(NSString *)param
                    value:(MSFVariant *)value;

    Swift

    func setPointParameter(_ index: Int32, param: String!, value: MSFVariant!)

    Parameters

    index

    The routing point index.
    param

    The name of the parameter to set.
    value

    The new value for the parameter of the given routing point.

  • Returns the custom parameter value of the request.

    Declaration

    Objective-C

    - (MSFVariant *)getCustomParameter:(NSString *)param;

    Swift

    func getCustomParameter(_ param: String!) -> MSFVariant!

    Parameters

    param

    The name of the parameter to return.

    Return Value

    The value of the parameter. If the parameter does not exist, empty variant is returned.

  • Sets a custom parameter for the the request.

    Declaration

    Objective-C

    - (void)setCustomParameter:(NSString *)param value:(MSFVariant *)value;

    Swift

    func setCustomParameter(_ param: String!, value: MSFVariant!)

    Parameters

    param

    The name of the parameter. For example, “trace_options.search_radius”.
    value

    The new value for the parameter.

  • Creates a string representation of this request object, useful for logging.

    Declaration

    Objective-C

    - (NSString *)description;

    Swift

    func description() -> String!

    Return Value

    The string representation of this request object.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()