Class ElevationProfileStatistics

The scripting version of the ElevationProfileStatistics class. Class encapsulating the statistics from an elevation profile calculation

Namespace: Scripting

Syntax

public class ElevationProfileStatistics

Constructors

ElevationProfileStatistics(Data.Common.Visualisation.ElevationProfileStatistics)

Initializes a new instance of the ElevationProfileStatistics class.

Declaration

public ElevationProfileStatistics(Data.Common.Visualisation.ElevationProfileStatistics inputStats)

Parameters

Type	Name	Description
GH.PlanningTools.Data.Common.Visualisation.ElevationProfileStatistics	inputStats	The data model version of the elevation profile statistics.

Properties

AverageDownSlope

Gets the average down slope (percentage).

Declaration

public double AverageDownSlope { get; }

Property Value

Type	Description
System.Double

AverageElevation

Gets the average elevation (in metres)

Declaration

public double AverageElevation { get; }

Property Value

Type	Description
System.Double

AverageUpSlope

Gets the average up slope (percentage).

Declaration

public double AverageUpSlope { get; }

Property Value

Type	Description
System.Double

DistanceBetweenSamplePoints

Gets the distance between sample points.

Declaration

public double DistanceBetweenSamplePoints { get; }

Property Value

Type	Description
System.Double

ElevationGain

Gets the elevation gain (across the whole line) (in metres)

Declaration

public double ElevationGain { get; }

Property Value

Type	Description
System.Double

ElevationLoss

Gets the elevation loss (across the whole line) (in metres)

Declaration

public double ElevationLoss { get; }

Property Value

Type	Description
System.Double

FollowGroundDistance

Gets the follow-ground distance (distance along the surface of the ground - the sum of the lengths of all the sections along the profile line).

Declaration

public double FollowGroundDistance { get; }

Property Value

Type	Description
System.Double

MaxDownSlope

Gets the maximum down slope (percentage).

Declaration

public double MaxDownSlope { get; }

Property Value

Type	Description
System.Double

MaxElevation

Gets the maximum elevation (in metres).

Declaration

public double MaxElevation { get; }

Property Value

Type	Description
System.Double

MaxSlopeThatIsConsideredFlat

Gets the maximum absolute slope that is considered flat.

Declaration

public double MaxSlopeThatIsConsideredFlat { get; }

Property Value

Type	Description
System.Double

MaxUpSlope

Gets the maximum up slope (percentage).

Declaration

public double MaxUpSlope { get; }

Property Value

Type	Description
System.Double

MinElevation

Gets the minimum elevation (in metres)

Declaration

public double MinElevation { get; }

Property Value

Type	Description
System.Double

NetElevationGain

Gets the net elevation gain (in metres)

Declaration

public double NetElevationGain { get; }

Property Value

Type	Description
System.Double

PlanViewDistance

Gets the plan view distance (2D distance) from the start to the end point

Declaration

public double PlanViewDistance { get; }

Property Value

Type	Description
System.Double

PlanViewDistanceOfDownSlopes

Gets the plan view distance (2D distance) of just the down slopes that are NOT considered flat (within the MaxSlopeThatIsConsideredFlat value).

Declaration

public double PlanViewDistanceOfDownSlopes { get; }

Property Value

Type	Description
System.Double

PlanViewDistanceOfFlattishDownSlopes

Gets the plan view distance (2D distance) of just the down slopes that are considered flat (within the MaxSlopeThatIsConsideredFlat value).

Declaration

public double PlanViewDistanceOfFlattishDownSlopes { get; }

Property Value

Type	Description
System.Double

PlanViewDistanceOfFlattishUpSlopes

Gets the plan view distance (2D distance) of just the up slopes that are considered flat (within the MaxSlopeThatIsConsideredFlat value).

Declaration

public double PlanViewDistanceOfFlattishUpSlopes { get; }

Property Value

Type	Description
System.Double

PlanViewDistanceOfTotallyFlatSlopes

Gets the plan view distance (2D distance) of totally flat slopes (slope of 0.0).

Declaration

public double PlanViewDistanceOfTotallyFlatSlopes { get; }

Property Value

Type	Description
System.Double

PlanViewDistanceOfUpSlopes

Gets the plan view distance (2D distance) of just the up slopes that are NOT considered flat (within the MaxSlopeThatIsConsideredFlat value).

Declaration

public double PlanViewDistanceOfUpSlopes { get; }

Property Value

Type	Description
System.Double

SamplePoints

Gets the list of sample points along the elevation profile line.

Declaration

public List<ElevationProfileSamplePoint> SamplePoints { get; }

Property Value

Type	Description
System.Collections.Generic.List<ElevationProfileSamplePoint>