Namespace SolarFarmerApi.Client
Classes
AnnualEnergyYieldResults
Hold the results from an individual year, or a typical year
DcoElectricalData
Class for the electrical data of the DC power optimizers
DcoGeneralData
Class for the general data of the DC power optimizers.
DcoInputSpecification
Inputs specifications for the power optimizer.
DcoMechanicalData
Class for the mechanical data of the DC power optimizers
DcoOutputSpecification
Output specifications for the power optimizer
EnergyCalculationInputs
Holds all the inputs required for an energy calculation
EnergyCalculationOptions
Holds flags that switch on and off various bits of the model chain.
EnergyYieldResults
The yield results from an energy calculation
EnergyYieldResultsForMonth
IAMParameters
The parameters describing the IAM model
IndexedObject3D
Inverter
An inverter instance.
InverterEfficiencyPoints
A struct representing the 3 efficiency points of an inverter
InverterInput
An inverter input instance. Used for the 3D calculation only.
InverterSpecification
The data that describes an inverter model and it's performance.
Layout
Represents a layout of modules that could be connected to one inverter input
LayoutHintsForUI
Includes properties used in SolarFarmer Desktop to create the layout of the site when imported
using the 'Import from API JSON' functionality. These properties do not have an effect in the calculation.
Location
The data defining a location on the earth.
LossTreeEffects
The loss tree results in the format required by SF-Desktop
All effects are given as a fraction of 1
0.01 would represent a gain of 1%
-0.01 would represent a loss of 1%
LossTreeResultForMonth
Basic DTO class which holds the loss tree data for a particular month
It doesn't have data for the AC part of the plant, transformer losses, AC cabling losses and grid avialability losses.
The AC system losses are calculated later in the model chain.
MeteorologicalCondition
Contains the meteorological conditions for a particular instant
MeteorologicalConditionsDataset
A data-set of meteorological conditions and the metadata relating them to a location
They could represent a TMY, but it could be more or less than a year in duration
MiniSimpleTerrainDto
ModelChainAsyncQueryResponse
The response from a call to the model chain async status query.
ModelChainResponse
The results of running the model chain calculation using both endpoints.
ModuleGeometry
The data that defines the module geometry.
ModuleIndexRange
A range of indices denoting where modules are placed on a rack or tracker.
ModuleSpecification
The data describing the module specification
ModuleString
A string of modules. Defined as a list of module index ranges.
MountingTypeSpecification
Contains the data relating to one design of rack
MpptLimits
The limits of the maximum power point tracker
PanFileSupplements
This data supplements the module specification found in a pan file
Sensible defaults are provided, so all the properties are optional
PointInLossChain
Represents an energy or power in the loss tree chain.
PowerOptimizer
Base class for all objects in a DCO file defining the data model of the power (DC) optimizers
ProblemDetails
PVPlant
The PV plant described as a hierarchy of components starting with the transformers
And separately libraries of component specifications
PVsystDiodeModelParameters
These parameters characterize a module's electrical behavior according to the PVsyst diode model.
Parameters in here are with respect to one whole module, and are correct at reference temperature and irradiance.
QuadDouble
Rack
Response
AboutHandler response object.
Response2
The response object returned from this handler.
Response3
The response object for this handler.
SimpleTerrainDto
SolarPositionDto
Represents the position of the sun
SolarPositionRequest
Request object sent to the solar position endpoint.
SolarPositions
Data model class to hold the solar positions
These can be provided as input if the user does not want
to use the in-build SolarFarmer solar position algorithm
SystemAttributes
The attributes of the system (plant and calculation configuration) that were used
for an energy calculation.
TerrainRowDto
TerrainRowStartEndColumnsDto
ThreeEfficiencyCurves
Class representing the 3 efficiency curves as used in the CEC inverter test.
Tracker
TrackerSystem
The data required for modeling a tracker system
These are the inputs to the tracker algorithm that is controlling
a set of trackers.
Transformer
An instance of a transformer.
TransformerSpecification
The data that describes a transformer loss model.
Vector3Double
Enums
DiffuseModel
Enum for specifying choice of diffuse transposition model
EnumTechnology
The cell technologies.
IAMModelType
Enumerates the IAM model types
IAMModelTypeForOverride
Enumerates the IAM models available to be used in IamModelTypeOverride.
InverterEfficiencyModelType
Enumerates the types of inverter efficiency model
LossTreeEntry
The possible points in the loss tree chain at which we will calculate the power or energy.
MissingMetDataMethod
Enum to define the behaviour of missing data in required meteorological variables
PowerOptimizerOperationType
The different connection configurations for the operation of power optimizers
RuntimeStatus
The status of the model chain run.
See also: Microsoft.Azure.WebJobs.Extensions.DurableTask.OrchestrationRuntimeStatus
TransformerLossModelTypes
The different transformer loss models that SF can model