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

    Show / Hide Table of Contents
    • Introduction
    • –––––––––––––––––––
    • Snippets - General
      • Write to Log
    • Snippets - Set up workbook
      • Site
      • Climate
      • Shading objects
      • Components
      • Layout
      • Energy
      • Report
    • Snippets - Calculation
      • Run Energy Calculation
      • Analyse Results
    • Snippets - Layout
      • Set the pitch value
      • Vary pitch by slope
      • Define inverter blocks
      • Specify site
      • Set the tracker system
      • Import regions from files
    • Snippets - Maps
      • Elevation Profile Tool
      • Projections
    • Snippets - Optimisation
      • Optimisation
    • Snippets - Trackers
      • Importing tracker positions
      • Using custom tracker rotations
    • –––––––––––––––––––
    • Class References
      • Scripting
        • AcWiring
        • AddableCollection<T>
        • AddCentralInverterAndAssignStringsParameters
        • Angle
        • AngularModelEnum
        • AnnualEnergyYieldResults
        • AreaLimitation
        • AreaLimitationType
        • Azimuth
        • AzimuthVsAltitude
        • BackgroundImage
        • 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
        • ModuleOrientation
        • ModuleSpecification
        • ModuleSpecificationDocumentType
        • MonteCarloSettings
        • MonthlyAlbedo
        • MonthlyEnergyYieldEffects
        • MonthlyEnergyYieldResults
        • MonthlySoilingValue
        • PerformanceStatistics
        • Projection
        • ProjectionInformation
        • PvsystCellTempModelParameters
        • PvsystInputIrradianceType
        • PVsystModelParameters
        • Quad
        • RackInstanceInfo
        • RackLayoutDefinition
        • RackLayoutParameters
        • RackSpecification
        • RackSystemSpecification
        • ReadOnly3DLocation
        • ReadOnlyLocation
        • Rectangle
        • Region
        • ReportCategory
        • Reporting
        • Resolution
        • RoadLocationParameters
        • RoughnessContours
        • RowPositionParameters
        • ScenarioAlbedoData
        • ScenarioMonthlyAlbedo
        • ScriptingException
        • 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 EnergyYieldCalculationScenario

    Namespace: Scripting
    Syntax
    public class EnergyYieldCalculationScenario

    Constructors

    EnergyYieldCalculationScenario()

    Creates an instance of the EnergyYieldCalculationScenario class.

    Declaration
    public EnergyYieldCalculationScenario()

    Properties

    CalculationSettings

    Declaration
    public CalculationSettings CalculationSettings { get; set; }
    Property Value
    Type Description
    CalculationSettings

    CalculationWasRunLocally

    Declaration
    public bool CalculationWasRunLocally { get; set; }
    Property Value
    Type Description
    System.Boolean

    CloudVersions

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

    DTM

    Declaration
    public DigitalTerrainResultsSummary DTM { get; set; }
    Property Value
    Type Description
    DigitalTerrainResultsSummary

    ProjectIdForApi

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

    SiteLocation

    Declaration
    public SiteReferencePoint SiteLocation { get; set; }
    Property Value
    Type Description
    SiteReferencePoint

    UseAsyncModelChainEndpoint

    Declaration
    public bool UseAsyncModelChainEndpoint { get; set; }
    Property Value
    Type Description
    System.Boolean

    YearlyResultsList

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

    Methods

    Equals(EnergyYieldCalculationScenario)

    Tests a EnergyYieldCalculationScenario against this current EnergyYieldCalculationScenario for equality.

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

    True if equal otherwise false is returned.

    Equals(Object)

    Tests a System.Object against this current EnergyYieldCalculationScenario 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()

    Operators

    Equality(EnergyYieldCalculationScenario, EnergyYieldCalculationScenario)

    Tests a EnergyYieldCalculationScenario against this current EnergyYieldCalculationScenario for equality.

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

    True if equal otherwise false is returned.

    Inequality(EnergyYieldCalculationScenario, EnergyYieldCalculationScenario)

    Tests a EnergyYieldCalculationScenario against this current EnergyYieldCalculationScenario for inequality.

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

    True if not equal otherwise false is returned.

    In This Article
    Back to top DNV SolarFarmer Home