Class SensitivityCurvesScenario
All the sensitivity curves (read-only) in a Scenario.
Namespace: Scripting
Syntax
public class SensitivityCurvesScenario
Properties
CombinedCurve
Gets the combined curve.
Declaration
public SensitivityCurve CombinedCurve { get; }
Property Value
Type | Description |
---|---|
SensitivityCurve |
WindClimateCurves
Gets the wind climate curves.
Declaration
public IEnumerable<WindClimateSensitivityCurve> WindClimateCurves { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<WindClimateSensitivityCurve> |
Methods
GetWindClimateCurveForMeasurementSiteAndHeight(String, Double)
Gets the wind climate curve for the wind climate at the given measurement site and height above ground.
Declaration
public WindClimateSensitivityCurve GetWindClimateCurveForMeasurementSiteAndHeight(string measurementSiteName, double heightAboveGround)
Parameters
Type | Name | Description |
---|---|---|
System.String | measurementSiteName | Name of the measurement site. |
System.Double | heightAboveGround | The height above ground. |
Returns
Type | Description |
---|---|
WindClimateSensitivityCurve | The WindClimateSensitivityCurve for the wind climate at the given measurement site and height above ground, or null if none found. |
GetWindClimateCurvesForHeight(Double)
Gets the wind climate curves for the given height above ground.
Declaration
public IEnumerable<WindClimateSensitivityCurve> GetWindClimateCurvesForHeight(double heightAboveGround)
Parameters
Type | Name | Description |
---|---|---|
System.Double | heightAboveGround | The height above ground. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<WindClimateSensitivityCurve> | The WindClimateSensitivityCurve objects (if any) for wind climates at the given height above ground. |
GetWindClimateCurvesForMeasurementSite(String)
Gets the wind climate curves for the given measurement site.
Declaration
public IEnumerable<WindClimateSensitivityCurve> GetWindClimateCurvesForMeasurementSite(string measurementSiteName)
Parameters
Type | Name | Description |
---|---|---|
System.String | measurementSiteName | Name of the measurement site. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<WindClimateSensitivityCurve> | The WindClimateSensitivityCurve objects (if any) for wind climates belonging to the measurement site with the given name. |