RouteTerrainProfileObject

Objective-C


@interface RouteTerrainProfileObject : NSObject

Swift

class RouteTerrainProfileObject : NSObject

This class encapsulates route terrain profile information.

  • Initializes and returns a newly allocated object using the model data.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithModelData:(nonnull void *)data;

  • Returns the model data.

    Declaration

    Objective-C

    - (nonnull void *)getModelData;

  • Returns the terrain minimum elevation.

    Declaration

    Objective-C

    - (float)getMinElevation;

    Swift

    func getMinElevation() -> Float

  • Returns the terrain maximum elevation.

    Declaration

    Objective-C

    - (float)getMaxElevation;

    Swift

    func getMaxElevation() -> Float

  • Returns the terrain minimum elevation distance ( from route start ).

    Declaration

    Objective-C

    - (int)getMinElevationDistance;

    Swift

    func getMinElevationDistance() -> Int32

  • Returns the terrain maximum elevation distance ( from route start ).

    Declaration

    Objective-C

    - (int)getMaxElevationDistance;

    Swift

    func getMaxElevationDistance() -> Int32

  • Returns the total terrain elevation up.

    Declaration

    Objective-C

    - (float)getTotalUp;

    Swift

    func getTotalUp() -> Float

  • Returns the total terrain elevation down.

    Declaration

    Objective-C

    - (float)getTotalDown;

    Swift

    func getTotalDown() -> Float

  • Returns the total terrain elevation up for specified route section.

    Declaration

    Objective-C

    - (float)getTotalUp:(int)distBegin end:(int)distEnd;

    Swift

    func getTotalUp(_ distBegin: Int32, end distEnd: Int32) -> Float

  • Returns the total terrain elevation down for specified route section.

    Declaration

    Objective-C

    - (float)getTotalDown:(int)distBegin end:(int)distEnd;

    Swift

    func getTotalDown(_ distBegin: Int32, end distEnd: Int32) -> Float

  • Returns the elevation samples list.

    Declaration

    Objective-C

    - (nonnull NSArray<NSNumber *> *)getElevationSamples:(int)countSamples;

    Swift

    func getElevationSamples(_ countSamples: Int32) -> [NSNumber]

    Parameters

    countSamples

    The number of samples.

  • Returns the elevation samples list.

    Declaration

    Objective-C

    - (nonnull NSArray<NSNumber *> *)getElevationSamples:(int)countSamples
                                           distBegin:(int)distBegin
                                             distEnd:(int)distEnd;

    Swift

    func getElevationSamples(_ countSamples: Int32, distBegin: Int32, distEnd: Int32) -> [NSNumber]

    Parameters

    countSamples

    The number of samples.
    distBegin

    The begin distance on route for sample interval.
    distEnd

    The end distance on route for sample interval.

  • Returns the elevation at the given distance.

    Declaration

    Objective-C

    - (float)getElevation:(int)distance;

    Swift

    func getElevation(_ distance: Int32) -> Float

    Parameters

    distance

    The distance in meters from departure point/start of route.

  • Returns the list of route climb sections, that is, which are increasing in elevation.

    Declaration

    Objective-C

    - (nonnull NSArray<ClimbSectionObject *> *)getClimbSections;

    Swift

    func getClimbSections() -> [ClimbSectionObject]

  • Returns the list of route sections which are flat, that is, no significant elevation change.

    Declaration

    Objective-C

    - (nonnull NSArray<SurfaceSectionObject *> *)getSurfaceSections;

    Swift

    func getSurfaceSections() -> [SurfaceSectionObject]

  • Returns the list of route sections which are of type road, typically, paved.

    Declaration

    Objective-C

    - (nonnull NSArray<RoadTypeSectionObject *> *)getRoadTypeSections;

    Swift

    func getRoadTypeSections() -> [RoadTypeSectionObject]

  • Get list of route sections which are abrupt, that is, they have a significant elevation change.

    Declaration

    Objective-C

    - (nonnull NSArray<RoadSteepSectionObject *> *)getSteepSections:
    (nonnull NSArray<NSNumber *> *)steepnessIntervals;

    Swift

    func getSteepSections(_ steepnessIntervals: [NSNumber]) -> [RoadSteepSectionObject]

    Parameters

    categs

    The user list of steep categories. Each entry contains the max slope for the steep category as diffX / diffY. @details A common steep categories list is { -16.f, -10.f, -7.f, -4.f, -1.f, 1.f, 4.f, 7.f, 10.f, 16.f } @details A positive value is for an ascension category, a negative value if a descent category. @details Each section has the start distance from route start and the category ( index in user defined steep categories ). @details The end of the section is the distance from start of the next section or route total length ( for the last section ).

  • Returns the elevation chart min value Oy.

    Declaration

    Objective-C

    - (float)getElevationChartMinValueY;

    Swift

    func getElevationChartMinValueY() -> Float

  • Returns the elevation chart max value Oy.

    Declaration

    Objective-C

    - (float)getElevationChartMaxValueY;

    Swift

    func getElevationChartMaxValueY() -> Float