• Home
  • User Guide
  • Automation
  • API
  • Calculation
  • Validation
  • Contact Us
Search Results for

    Show / Hide Table of Contents
    • Scripting
      • AcWiring
      • AddableCollection<T>
      • AddCentralInverterAndAssignStringsParameters
      • Angle
      • AngularModelEnum
      • AnnualEnergyYieldResults
      • AreaLimitation
      • AreaLimitationType
      • Azimuth
      • AzimuthVsAltitude
      • BackgroundImage
      • BuildingBoundaryType
      • BuildingRegion
      • CalculationSettings
      • CellTempModelParameters
      • CentralInverterLocationParameters
      • CircumsolarType
      • Climate
      • ComponentLibrary
      • ComponentStatistic
      • CustomDateTimeTrackerPositionAlgorithmBase
      • DiffuseMultipliers
      • DiffuseShadingScheme
      • DiffuseTranspositionModel
      • DigitalTerrainResultsSummary
      • DiodeModel
      • DisabledModels
      • DistanceType
      • DistributionType
      • Domain
      • Efficiency
      • EfficiencyBase
      • EfficiencyCurve
      • EfficiencyCurveType
      • ElectricalLimitation
      • ElectricalLimitationType
      • ElectricalPower
      • Elevation
      • ElevationContours
      • ElevationGrid
      • ElevationProfileSamplePoint
      • ElevationProfileStatistics
      • EnergyYieldCalculationScenario
      • EnergyYieldCalculationType
      • EnergyYieldEffects
      • EnumTechnology
      • ExceedanceLevel
      • ExclusionRegion
      • Export
      • FillOptionComponentOptions
      • FillOptionIndividualComponentsOptions
      • FillOptionInverterBlockOptions
      • FillOptionRackLayoutOptions
      • FillOptionsSpacingType
      • FillOptionsType
      • FillOptionTrackerLayoutOptions
      • FillOptionUseExistingLayoutOptions
      • FlatTerrainParameters
      • GenericLayout
      • GenericLayoutFillOption
      • GenericLayoutSettings
      • Geography
      • HorizonData
      • I2DLocation
      • I3DLocation
      • IAddableEnumerable<T>
      • IAddableKeyedEnumerable<TKey, TValue>
      • IClearableCollection<T>
      • IEditableKeyedCollection<tKeyType, tContainedType>
      • IEditableKeyedEnumerable<TKeyType, TContainedType>
      • IElevationSource
      • Import
      • INamedItem
      • InstantaneousCondition
      • InverterBlockSpecification
      • InverterEfficiencyType
      • InverterInputInstance
      • InverterInputSpecification
      • InverterInstance
      • InverterSpecification
      • InverterSpecificationDocumentType
      • InverterTemperatureCurveEntry
      • InverterType
      • IReadable2DLocation
      • IReadable3DLocation
      • IReadableKeyedCollection<tKeyType, tContainedType>
      • IReadableKeyedEnumerable<TKey, TValue>
      • IRemovableKeyedEnumerable<TKey, TValue>
      • IResolution
      • Irradiance
      • ISpeed
      • IvCurve
      • KeyedCollection<TKeyType, TContainedType>
      • LayoutBoundary
      • LayoutBoundaryMarginParameter
      • LayoutBoundaryMarginParameters
      • LayoutChoiceType
      • LayoutParamsPitchModel
      • LayoutStatistic
      • Location
      • Location3D
      • LogLevel
      • MarginType
      • ModuleCellLayoutType
      • ModuleIndex
      • ModuleOrientation
      • ModuleSpecification
      • ModuleSpecificationDocumentType
      • ModuleString
      • MonteCarloSettings
      • MonthlyAlbedo
      • MonthlyEnergyYieldEffects
      • MonthlyEnergyYieldResults
      • MonthlySoilingValue
      • PerformanceStatistics
      • PowerOptimiserElectricalData
      • PowerOptimiserInputSpecification
      • PowerOptimiserMechanicalData
      • PowerOptimiserOperationType
      • PowerOptimiserOutputSpecification
      • PowerOptimiserSpecification
      • Projection
      • ProjectionInformation
      • PvsystCellTempModelParameters
      • PvsystInputIrradianceType
      • PVsystModelParameters
      • Quad
      • RackInstanceInfo
      • RackLayoutDefinition
      • RackLayoutParameters
      • RackSpecification
      • RackSystemSpecification
      • ReadOnly3DLocation
      • ReadOnlyLocation
      • Rectangle
      • Region
      • ReportCategory
      • Reporting
      • Resolution
      • RoadLocationParameters
      • RoughnessContours
      • RowPositionParameters
      • ScenarioAlbedoData
      • ScenarioMonthlyAlbedo
      • ScriptingException
      • ShadingBoundaryType
      • ShadingRegion
      • ShadingTargetPointPattern
      • SiteLayout
      • SiteLayoutStatistics
      • SiteLayoutType
      • SiteReferencePoint
      • SoilingEffectData
      • SolarResource
      • SpacingZone
      • SpecifySiteConfiguration
      • SpecifySiteDefinition
      • SpecifySiteLayoutRegionFillChoice
      • Speed
      • StringPatternType
      • SubArray
      • SunGeography
      • SunPosition
      • SunriseSunset
      • Temperature
      • TimeStepCalculation
      • Toolbox
      • TrackerGroup
      • TrackerImport
      • TrackerInfo
      • TrackerLayoutDefinition
      • TrackerLayoutParameters
      • TrackerPlacementModeType
      • TrackerPositionAlgorithmBase
      • TrackerRotations
      • TrackerRotationsTimeStep
      • TrackerSystemSpecification
      • TrackerTemplateSpecification
      • TransformerInstance
      • TransformerModelType
      • TransformerSpecification
      • TransformerSpecificationDocumentType
      • TwoDiodeParameters
      • Uncertainty
      • UncertaintyAnnualVariabilities
      • Workbook
      • WorkbookSettings
      • WorkbookSpecificModuleSpecification
      • YearRange
      • YieldResult
      • YieldResults

    Class AnnualEnergyYieldResults

    Namespace: Scripting
    Syntax
    public class AnnualEnergyYieldResults

    Constructors

    AnnualEnergyYieldResults()

    Creates an instance of the AnnualEnergyYieldResults class.

    Declaration
    public AnnualEnergyYieldResults()

    Properties

    AllResults

    All the results for the year

    Declaration
    public YieldResults AllResults { get; set; }
    Property Value
    Type Description
    YieldResults

    AnnualEffects

    The annual effects for the year

    Declaration
    public EnergyYieldEffects AnnualEffects { get; set; }
    Property Value
    Type Description
    EnergyYieldEffects

    AverageTemperature

    The average temperature

    Declaration
    public double AverageTemperature { get; set; }
    Property Value
    Type Description
    System.Double

    EnergyYield

    The energy yield (kWh/kWp)

    Declaration
    public double EnergyYield { get; set; }
    Property Value
    Type Description
    System.Double

    GainOnTiltedPlane

    The gain on the tilted plane (%)

    Declaration
    public double GainOnTiltedPlane { get; set; }
    Property Value
    Type Description
    System.Double

    GHI

    The Global Horizontal Irradiance (kwh/m²)

    Declaration
    public double GHI { get; set; }
    Property Value
    Type Description
    System.Double

    GHIWithHorizon

    The Global Horizontal Irradiance with horizon (kwh/m²)

    Declaration
    public double GHIWithHorizon { get; set; }
    Property Value
    Type Description
    System.Double

    GI

    The Global Irradiance (kwh/m²)

    Declaration
    public double GI { get; set; }
    Property Value
    Type Description
    System.Double

    GIWithHorizon

    The Global Irradiance with horizon (kwh/m²)

    Declaration
    public double GIWithHorizon { get; set; }
    Property Value
    Type Description
    System.Double

    GlobalEffectiveIrradiance

    The Global Effective Irradiance (kwh/m²)

    Declaration
    public double GlobalEffectiveIrradiance { get; set; }
    Property Value
    Type Description
    System.Double

    ModulePower

    The module power (in kW)

    Declaration
    public double ModulePower { get; set; }
    Property Value
    Type Description
    System.Double

    ModulePowerAtReferenceIrradiance

    The module power at the reference irradiance (kW)

    Declaration
    public double ModulePowerAtReferenceIrradiance { get; set; }
    Property Value
    Type Description
    System.Double

    ModulePowerAtSTC

    The module power at STC (kW)

    Declaration
    public double ModulePowerAtSTC { get; set; }
    Property Value
    Type Description
    System.Double

    MonthlyEffects

    A list of monthly effects for the year

    Declaration
    public IList<MonthlyEnergyYieldEffects> MonthlyEffects { get; }
    Property Value
    Type Description
    System.Collections.Generic.IList<MonthlyEnergyYieldEffects>

    MonthlyResults

    A list of monthly energy yield results for the year

    Declaration
    public IList<MonthlyEnergyYieldResults> MonthlyResults { get; }
    Property Value
    Type Description
    System.Collections.Generic.IList<MonthlyEnergyYieldResults>

    NetEnergy

    The net energy (MWh/year)

    Declaration
    public double NetEnergy { get; set; }
    Property Value
    Type Description
    System.Double

    NominalEnergy

    The nominal energy (kWh)

    Declaration
    public double NominalEnergy { get; set; }
    Property Value
    Type Description
    System.Double

    PAC

    The AC production (kWh)

    Declaration
    public double PAC { get; set; }
    Property Value
    Type Description
    System.Double

    PDC

    The DC production (kWh)

    Declaration
    public double PDC { get; set; }
    Property Value
    Type Description
    System.Double

    PeakPower

    The peak power (kW)

    Declaration
    public double PeakPower { get; set; }
    Property Value
    Type Description
    System.Double

    PercentComplete

    The percentage of complete records for the full year

    Declaration
    public double PercentComplete { get; set; }
    Property Value
    Type Description
    System.Double

    PerformanceRatio

    The performance ratio (%)

    Declaration
    public double PerformanceRatio { get; set; }
    Property Value
    Type Description
    System.Double

    PerformanceRatioBifacial

    The bifacial performance ratio (%)

    Declaration
    public double PerformanceRatioBifacial { get; set; }
    Property Value
    Type Description
    System.Double

    RecordCount

    The number of records in the solar data

    Declaration
    public int RecordCount { get; set; }
    Property Value
    Type Description
    System.Int32

    Year

    The year the results are valid for

    Declaration
    public int Year { get; set; }
    Property Value
    Type Description
    System.Int32

    YearName

    The name of the year

    Declaration
    public string YearName { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    Equals(AnnualEnergyYieldResults)

    Tests a AnnualEnergyYieldResults against this current AnnualEnergyYieldResults for equality.

    Declaration
    public bool Equals(AnnualEnergyYieldResults val)
    Parameters
    Type Name Description
    AnnualEnergyYieldResults val
    Returns
    Type Description
    System.Boolean

    True if equal otherwise false is returned.

    Equals(Object)

    Tests a System.Object against this current AnnualEnergyYieldResults 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
    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) an AnnualEnergyYieldResults object from an XML file.

    Declaration
    public static AnnualEnergyYieldResults LoadFromFile(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    The file path to deserialize the data from.

    Returns
    Type Description
    AnnualEnergyYieldResults

    The AnnualEnergyYieldResults object.

    SaveToFile(String)

    Saves (serializes) the AnnualEnergyYieldResults to an XML file. It does not include the full list of AllResults. Just the annual and monthly results and effects.

    Declaration
    public void SaveToFile(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    The file path to serialize the data to.

    Operators

    Equality(AnnualEnergyYieldResults, AnnualEnergyYieldResults)

    Tests a AnnualEnergyYieldResults against this current AnnualEnergyYieldResults for equality.

    Declaration
    public static bool operator ==(AnnualEnergyYieldResults a, AnnualEnergyYieldResults b)
    Parameters
    Type Name Description
    AnnualEnergyYieldResults a
    AnnualEnergyYieldResults b
    Returns
    Type Description
    System.Boolean

    True if equal otherwise false is returned.

    Inequality(AnnualEnergyYieldResults, AnnualEnergyYieldResults)

    Tests a AnnualEnergyYieldResults against this current AnnualEnergyYieldResults for inequality.

    Declaration
    public static bool operator !=(AnnualEnergyYieldResults a, AnnualEnergyYieldResults b)
    Parameters
    Type Name Description
    AnnualEnergyYieldResults a
    AnnualEnergyYieldResults b
    Returns
    Type Description
    System.Boolean

    True if not equal otherwise false is returned.

    In This Article
    Back to top DNV SolarFarmer Home