NTRoutingInstruction
@interface NTRoutingInstruction : NSObject {
void *swigCPtr;
BOOL swigCMemOwn;
}
A class that defines a routing instruction at specified position in the path.
-
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 RoutingInstruction instance with all values set to default.
Declaration
Objective-C
- (id)init;
-
Constructs a new RoutingInstruction instance given all instruction attributes.
Declaration
Objective-C
- (id)initWithAction:(enum NTRoutingAction)action pointIndex:(int)pointIndex streetName:(NSString *)streetName instruction:(NSString *)instruction turnAngle:(float)turnAngle azimuth:(float)azimuth distance:(double)distance time:(double)time geometryTag:(NTVariant *)geometryTag;
Parameters
action
Action to take.
pointIndex
Instruction starting point index in the point list.
streetName
Street name.
instruction
The optional instruction description.
turnAngle
Turn angle in degrees.
azimuth
Azimuth in degrees.
distance
The distance to move along the given street in meters.
time
The approximate duration of the instruction in seconds.
geometryTag
The geometry tag associated with the instruction.
-
Returns the action of the instruction.
Declaration
Objective-C
- (enum NTRoutingAction)getAction;
Return Value
The action to take.
-
Returns the index of the first geometry point in external point array.
Declaration
Objective-C
- (int)getPointIndex;
Return Value
The point index.
-
Returns the name of street.
Declaration
Objective-C
- (NSString *)getStreetName;
Return Value
The name of the street.
-
Returns the optional instruction description. This info is dependent on the routing engine (can be empty) and may be localized.
Declaration
Objective-C
- (NSString *)getInstruction;
Return Value
The optional instruction description.
-
Returns the turn angle of the action.
Declaration
Objective-C
- (float)getTurnAngle;
Return Value
The turn angle in degrees.
-
Returns the azimuth of the initial position.
Declaration
Objective-C
- (float)getAzimuth;
Return Value
The azimuth in degrees.
-
Returns the distance to move along the given street.
Declaration
Objective-C
- (double)getDistance;
Return Value
The distance to move in meters.
-
Returns the time approximate duration of the instruction.
Declaration
Objective-C
- (double)getTime;
Return Value
The approximate duration of the instruction in seconds.
-
Returns the geometry tag associated with the instructions.
Declaration
Objective-C
- (NTVariant *)getGeometryTag;
Return Value
The geometry tag associated with the instructions.
-
Creates a string representation of this instruction, useful for logging.
Declaration
Objective-C
- (NSString *)description;
Return Value
The string representation of this instruction.
-
Undocumented
Declaration
Objective-C
-(void)dealloc;