Class Turbine
Extends the data facade class
Implements
Namespace: Scripting
Syntax
public class Turbine : INamedItem
Constructors
Turbine(String, IReadable2DLocation, TurbineType)
Construct a Turbine
Declaration
public Turbine(string name, IReadable2DLocation location, TurbineType turbineType)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The turbine name |
IReadable2DLocation | location | The location of the turbine |
TurbineType | turbineType | The turbine model of this turbine |
Properties
AdjustedFreeStreamMeanWindSpeed
Gets the adjusted free stream mean wind speed.
Declaration
public double AdjustedFreeStreamMeanWindSpeed { get; }
Property Value
Type | Description |
---|---|
System.Double |
CalculatedDisplacementHeight
Gets the calculated displacement height of the turbine.
Declaration
public double CalculatedDisplacementHeight { get; }
Property Value
Type | Description |
---|---|
System.Double |
ConfidenceWeighting
Gets or sets the confidence weighting of the turbine.
Declaration
public double ConfidenceWeighting { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
CurtailmentRules
Gets the curtailment rules collection
Declaration
public ICollection<CurtailmentRule> CurtailmentRules { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<CurtailmentRule> |
DisplacementHeightCalculated
Get the calculated displacement height
Declaration
public double DisplacementHeightCalculated { get; }
Property Value
Type | Description |
---|---|
System.Double |
DisplacementHeightManual
Get and set the value to override the calculated displacement height (Setting a null value will reset to the calculated displacement height)
Declaration
public double? DisplacementHeightManual { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Double> |
ExcludeFromCalculation
Get and set is this turbine excluded from calculation
Declaration
public bool ExcludeFromCalculation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
FinalDisplacementHeight
Gets or sets the final displacement height of the turbine.
Declaration
public double FinalDisplacementHeight { get; }
Property Value
Type | Description |
---|---|
System.Double |
FreeStreamMeanWindSpeed
Gets the free stream mean wind speed.
Declaration
public double FreeStreamMeanWindSpeed { get; }
Property Value
Type | Description |
---|---|
System.Double |
HubHeightLocation
Get the 3D hub height location
Declaration
public IReadable3DLocation HubHeightLocation { get; }
Property Value
Type | Description |
---|---|
IReadable3DLocation |
InstallationDate
Gets or sets the installation date of the turbine.
Declaration
public DateTime InstallationDate { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
IsInstalled
Gets or sets whether the turbine is installed or not.
Declaration
public bool IsInstalled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsPositionLocked
Gets or sets whther the turbine position is locked or not.
Declaration
public bool IsPositionLocked { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Location
Gets and sets the location of the turbine
Declaration
public I2DLocation Location { get; set; }
Property Value
Type | Description |
---|---|
I2DLocation |
ManualDisplacementHeight
Gets or sets the manual displacement height of the turbine.
Declaration
public double? ManualDisplacementHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Double> |
Name
Gets or sets the name of the turbine.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Notes
Gets or sets the notes for the turbine.
Declaration
public string Notes { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Owner
Gets or sets the owner of the turbine.
Declaration
public string Owner { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ProductionYield
Gets or sets the production yield of the turbine.
Declaration
public double ProductionYield { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
TerrainHeight
Gets the terrain height of the turbine.
Declaration
public double TerrainHeight { get; }
Property Value
Type | Description |
---|---|
System.Double |
TurbineType
Get and set the TurbineType. If setting a value that does not exist in the data model collection of turbine types, it is added.
Declaration
public TurbineType TurbineType { get; set; }
Property Value
Type | Description |
---|---|
TurbineType |
WindFlowAdjustmentMode
Gets the wind flow adjustment mode.
Declaration
public WindFlowTurbineAdjustmentMode WindFlowAdjustmentMode { get; }
Property Value
Type | Description |
---|---|
Scripting.Internal.WindFlowTurbineAdjustmentMode |
Methods
Equals(Turbine)
Declaration
public bool Equals(Turbine val)
Parameters
Type | Name | Description |
---|---|---|
Turbine | val |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Equals(Object)
Tests a System.Object against this current Turbine for equality.
Declaration
public override bool Equals(object toCompare)
Parameters
Type | Name | Description |
---|---|---|
System.Object | toCompare |
Returns
Type | Description |
---|---|
System.Boolean | True if object is equal otherwise false is returned. |
Overrides
GetHashCode()
Gets the hash code for this object.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | The hash code for this object. |
Overrides
GetSectorManagementRules()
Gets all sector management rules that are associated with this turbine.
Declaration
public List<CurtailmentRule> GetSectorManagementRules()
Returns
Type | Description |
---|---|
System.Collections.Generic.List<CurtailmentRule> | All sector management rules that are associated with this turbine. |
SetInitiationMode(TurbineInitiationMode, MeasurementSite)
Sets the turbine initiation mode.
Declaration
public void SetInitiationMode(TurbineInitiationMode initiationMode, MeasurementSite measurementSite = null)
Parameters
Type | Name | Description |
---|---|---|
TurbineInitiationMode | initiationMode | The initiation mode. |
MeasurementSite | measurementSite | The measurement site for manual assignment. |
Operators
Equality(Turbine, Turbine)
Declaration
public static bool operator ==(Turbine a, Turbine b)
Parameters
Type | Name | Description |
---|---|---|
Turbine | a | |
Turbine | b |
Returns
Type | Description |
---|---|
System.Boolean | True if equal otherwise false is returned. |
Inequality(Turbine, Turbine)
Declaration
public static bool operator !=(Turbine a, Turbine b)
Parameters
Type | Name | Description |
---|---|---|
Turbine | a | |
Turbine | b |
Returns
Type | Description |
---|---|
System.Boolean | True if not equal otherwise false is returned. |