NTGeocodingRequest
@interface NTGeocodingRequest : NSObject {
void *swigCPtr;
BOOL swigCMemOwn;
}
A geocoding request describing text-based query and other optional constraints.
-
Checks if this object is equal to the specified object.
Declaration
Objective-C
- (BOOL)isEqual:(id)object;
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;
Return Value
The hash value of this object.
-
Constructs a new GeocodingRequest object from a projection and a string-based query.
Declaration
Objective-C
- (id)initWithProjection:(NTProjection *)projection query:(NSString *)query;
Parameters
projection
The projection to use for the result and location data.
query
The text-based query.
-
Returns the text-based query of the request.
Declaration
Objective-C
- (NSString *)getQuery;
Return Value
The text-based query of the request.
-
Returns the projection of the request.
Declaration
Objective-C
- (NTProjection *)getProjection;
Return Value
The projection of the request.
-
Returns the location attribute of the request. The matching address near the specified location (up to a specified radius) are preferred.
Declaration
Objective-C
- (NTMapPos *)getLocation;
Return Value
The location attribute of the request.
-
Sets the location attribute of the request. The matching address near the specified location (up to a specified radius) are preferred.
Declaration
Objective-C
- (void)setLocation:(NTMapPos *)pos;
Parameters
pos
The new location for the request.
-
Returns the location radius attribute of the request (in meters).
Declaration
Objective-C
- (float)getLocationRadius;
Return Value
The location radius attribute of the request in meters.
-
Sets the location radius attribute of the request. The default is 0, which means that location based ranking is not applied.
Declaration
Objective-C
- (void)setLocationRadius:(float)radius;
Parameters
radius
The location radius attribute of the request in meters.
-
Returns the custom parameter value of the request.
Declaration
Objective-C
- (NTVariant *)getCustomParameter:(NSString *)param;
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 value for the the request.
Declaration
Objective-C
- (void)setCustomParameter:(NSString *)param value:(NTVariant *)value;
Parameters
param
The name of the parameter. For example, “ranking.location_sigma”.
value
The new value for the parameter.
-
Creates a string representation of this request object, useful for logging.
Declaration
Objective-C
- (NSString *)description;
Return Value
The string representation of this request object.
-
Undocumented
Declaration
Objective-C
-(void)dealloc;