Class LargerValueIsBetterCostBenefitAlgorithmBase
Base class to use for cost benefit algorithms where a larger value is better
Namespace: Scripting
Syntax
public class LargerValueIsBetterCostBenefitAlgorithmBase
Constructors
LargerValueIsBetterCostBenefitAlgorithmBase()
Initializes a new instance of the LargerValueIsBetterCostBenefitAlgorithmBase class.
Declaration
public LargerValueIsBetterCostBenefitAlgorithmBase()
Properties
CostBenefitComparer
Gets the cost benefit comparer.
Declaration
public ICostBenefitValueComparer<SimpleCostBenefitValue> CostBenefitComparer { get; }
Property Value
Type | Description |
---|---|
ICostBenefitValueComparer<Scripting.SimpleCostBenefitValue> |
Methods
GetValidationErrors(Layout, Guid, Guid)
Gets the validation errors.
Declaration
public virtual IEnumerable<string> GetValidationErrors(Layout proposedLayout, Guid turbineTypeGuidForNewTurbines, Guid windFarmGuidForNewTurbines)
Parameters
Type | Name | Description |
---|---|---|
Scripting.Layout | proposedLayout | The proposed layout. |
System.Guid | turbineTypeGuidForNewTurbines | The turbine type unique identifier for new turbines. |
System.Guid | windFarmGuidForNewTurbines | The wind farm unique identifier for new turbines. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | An enumerable containing any error validation strings, or an empty enumeration if no validation errors. |
Initialise()
Performs any initialisation required - called before each optimisation calculation is started.
Declaration
public virtual void Initialise()