Class CalculationSettings
Syntax
public class CalculationSettings
Constructors
CalculationSettings()
Declaration
public CalculationSettings()
Properties
AppendDateToResultsFolderName
Declaration
public bool AppendDateToResultsFolderName { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AppendDateToValidationFilesFolderName
Declaration
public bool AppendDateToValidationFilesFolderName { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Availability
Declaration
public double Availability { get; set; }
Property Value
Type |
Description |
System.Double |
|
CellTempModelParameters
Declaration
public CellTempModelParameters CellTempModelParameters { get; set; }
Property Value
DiffuseShadingScheme
How the diffuse value is calculated
Declaration
public DiffuseShadingScheme DiffuseShadingScheme { get; set; }
Property Value
DiffuseTranspositionModel
Declaration
public DiffuseTranspositionModel DiffuseTranspositionModel { get; set; }
Property Value
DisabledModels
Declaration
public DisabledModels DisabledModels { get; set; }
Property Value
EmulatePVsyst
Declaration
public bool EmulatePVsyst { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnergyYieldCalculationType
The type of energy yield calculation to run (full or simple model)
Declaration
public EnergyYieldCalculationType EnergyYieldCalculationType { get; set; }
Property Value
GridConnectionLimit
The limit imposed by the Plant Power Controller (PPC) that checks to make sure that the point of interconnect (POI) power doesn't exceed the grid limits.
Declaration
public double GridConnectionLimit { get; set; }
Property Value
Type |
Description |
System.Double |
|
HorizonData
The horizon to use in the energy calculation
Declaration
public HorizonData HorizonData { get; set; }
Property Value
IncidenceAngleBinWidth
Declaration
public double IncidenceAngleBinWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
MismatchEffect
Declaration
public double MismatchEffect { get; set; }
Property Value
Type |
Description |
System.Double |
|
NearShadingRadius
The radius distance from the site point that the terrain is considered for near shading
Declaration
public double NearShadingRadius { get; set; }
Property Value
Type |
Description |
System.Double |
|
NumShadingTargetPointsPerChunk
Declaration
public int NumShadingTargetPointsPerChunk { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
Declaration
public PerformanceStatistics PerformanceStatistics { get; set; }
Property Value
ResultFilesFolder
Declaration
public string ResultFilesFolder { get; set; }
Property Value
Type |
Description |
System.String |
|
SaveResultFiles
Declaration
public bool SaveResultFiles { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ShadingTargetPointPattern
The number of shading points to calculate per module or cell
Declaration
public ShadingTargetPointPattern ShadingTargetPointPattern { get; set; }
Property Value
SiteLayout
The site layout to use in the energy calculation
Declaration
public SiteLayout SiteLayout { get; set; }
Property Value
Declaration
public bool SkipWritingModulePerformanceOutput { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
SolarResource
The solar resource to use in the energy calculation
Declaration
public SolarResource SolarResource { get; set; }
Property Value
TiltAngleBinWidth
Declaration
public double TiltAngleBinWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
UseGridConnectionLimit
Use the grid connection limit value in the settings
Declaration
public bool UseGridConnectionLimit { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
UseHorizonLine
Use the selected horizon line
Declaration
public bool UseHorizonLine { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ValidationFilesFolder
Declaration
public string ValidationFilesFolder { get; set; }
Property Value
Type |
Description |
System.String |
|
WriteOutTestingValidationFiles
Declaration
public bool WriteOutTestingValidationFiles { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Year
Declaration
public int Year { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
Methods
Equals(CalculationSettings)
Declaration
public bool Equals(CalculationSettings val)
Parameters
Returns
Type |
Description |
System.Boolean |
True if equal otherwise false is returned.
|
Equals(Object)
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
System.Object.Equals(System.Object)
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
System.Object.GetHashCode()
LoadFromFile(String)
Loads (deserializes) the calculation statistics object from the XML file.
Declaration
public static CalculationSettings LoadFromFile(string xmlFilePath)
Parameters
Type |
Name |
Description |
System.String |
xmlFilePath |
The XML file path containing the CalculationSettings object data.
|
Returns
SaveToFile(String)
Saves (serializes) the calculation settings object to an XML file.
Declaration
public void SaveToFile(string xmlFilePath)
Parameters
Type |
Name |
Description |
System.String |
xmlFilePath |
The XML file path.
|
Operators
Equality(CalculationSettings, CalculationSettings)
Declaration
public static bool operator ==(CalculationSettings a, CalculationSettings b)
Parameters
Returns
Type |
Description |
System.Boolean |
True if equal otherwise false is returned.
|
Inequality(CalculationSettings, CalculationSettings)
Declaration
public static bool operator !=(CalculationSettings a, CalculationSettings b)
Parameters
Returns
Type |
Description |
System.Boolean |
True if not equal otherwise false is returned.
|