• 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

    Namespace Scripting

    Classes

    AcWiring

    AddCentralInverterAndAssignStringsParameters

    Angle

    AnnualEnergyYieldResults

    AreaLimitation

    Azimuth

    AzimuthVsAltitude

    BackgroundImage

    BuildingRegion

    Building region

    CalculationSettings

    CellTempModelParameters

    CentralInverterLocationParameters

    Climate

    ComponentLibrary

    ComponentStatistic

    CustomDateTimeTrackerPositionAlgorithmBase

    Base class for custom date time tracker position algorithms.

    Just override the Initialise() function

    • Use the SetTrackerCount() to set the tracker count.
    • Use the AddTimeStep() function to add a time step along with positions (rotations) for each tracker. The trackerPositions collection should contain the same count as the tracker count.

    DiffuseMultipliers

    DigitalTerrainResultsSummary

    DisabledModels

    Domain

    Defines domain specific information. Site location, elevation, module locations, etc

    Efficiency

    An efficiency at a given power level

    EfficiencyBase

    EfficiencyCurve

    An inverter efficiency curve

    ElectricalLimitation

    ElectricalPower

    A scripting class holding an electrical power

    Elevation

    Wraps a value to represent a height

    ElevationContours

    ElevationGrid

    ElevationProfileSamplePoint

    The scripting version of the ElevationProfileSamplePoint class. A sample point along an elevation profile

    ElevationProfileStatistics

    The scripting version of the ElevationProfileStatistics class. Class encapsulating the statistics from an elevation profile calculation

    EnergyYieldCalculationScenario

    EnergyYieldEffects

    ExceedanceLevel

    ExclusionRegion

    Exclusion region

    Export

    Class containing Export functionality that is exposed in the scripting Toolbox

    FillOptionComponentOptions

    FillOptionIndividualComponentsOptions

    FillOptionInverterBlockOptions

    FillOptionRackLayoutOptions

    FillOptionTrackerLayoutOptions

    FillOptionUseExistingLayoutOptions

    FlatTerrainParameters

    GenericLayout

    Class containing Generic Layout functionality that is exposed in the scripting Toolbox

    GenericLayoutFillOption

    GenericLayoutSettings

    Geography

    A class to hold geographic information.

    HorizonData

    Import

    Class containing Import functionality that is exposed in the scripting Toolbox

    InstantaneousCondition

    The scripting representation of the InstantaneousCondition. All fields are readonly. If any of the irradiances are not present they are set to double.Nan.

    InverterBlockSpecification

    InverterInputInstance

    InverterInputSpecification

    InverterInstance

    InverterSpecification

    InverterTemperatureCurveEntry

    IvCurve

    Represents an IV curve for scripting

    KeyedCollection<TKeyType, TContainedType>

    Generic collection which allows lookup and adding of objects by a key

    LayoutBoundary

    LayoutBoundaryMarginParameter

    LayoutBoundaryMarginParameters

    LayoutStatistic

    Location

    Location class

    Location3D

    ReadOnly location with height above ground property

    ModuleIndex

    ModuleSpecification

    ModuleString

    MonteCarloSettings

    MonthlyAlbedo

    MonthlyEnergyYieldEffects

    MonthlyEnergyYieldResults

    MonthlySoilingValue

    PerformanceStatistics

    PowerOptimiserElectricalData

    PowerOptimiserInputSpecification

    PowerOptimiserMechanicalData

    PowerOptimiserOutputSpecification

    PowerOptimiserSpecification

    Projection

    Partial implemention of the Projection scripting class.

    ProjectionInformation

    A class to provide projection information.

    PvsystCellTempModelParameters

    PVsystModelParameters

    Quad

    RackInstanceInfo

    RackLayoutDefinition

    RackLayoutParameters

    Layout parameters for fixed-tilt rack layout regions

    RackSpecification

    RackSystemSpecification

    Rack System Specification

    ReadOnly3DLocation

    ReadOnly location with height above ground property

    ReadOnlyLocation

    A 2D location that is read only

    Rectangle

    Region

    ReportCategory

    Reporting

    Class containing Reporting functionality that is exposed in the scripting Toolbox

    Resolution

    Class specifies a horizontal and vertical resolution

    RoadLocationParameters

    RoughnessContours

    RowPositionParameters

    ScenarioAlbedoData

    ScenarioMonthlyAlbedo

    ScriptingException

    Exception used in scripting

    ShadingRegion

    Shading region

    SiteLayout

    A site layout

    SiteLayoutStatistics

    SiteReferencePoint

    SoilingEffectData

    SolarResource

    SpacingZone

    SpecifySiteDefinition

    Speed

    A Speed

    SubArray

    SunGeography

    Partial implementation of the scripting SunGeography class.

    SunPosition

    Represents the position of the sun in scripting

    SunriseSunset

    Class represents the sun rise and sunset times for a particular day

    TimeStepCalculation

    Scripting class which allows the energy calculation to be run for individual times

    Toolbox

    Static class exposed to the script.

    TrackerGroup

    Class representing a group of trackers from the input data.

    TrackerImport

    Class containing functionality related to import of trackers that is exposed in the scripting Toolbox

    TrackerInfo

    Information about a specific tracker taken from the input file.

    TrackerLayoutDefinition

    TrackerLayoutParameters

    Layout parameters for single-axis tracker layout regions

    TrackerPositionAlgorithmBase

    Base class that tracker position algorithms can inherit from

    TrackerRotations

    Class encapsulating tracker rotations (rotation angles with a time-step) for multiple trackers.

    TrackerRotationsTimeStep

    Class containing a time stamp and an array of tracker rotations (rotations in degrees). The order of the tracker rotations should be the same as in the TrackerNames array in the parent TrackerRotations class.

    TrackerSystemSpecification

    Tracker System Specification

    TrackerTemplateSpecification

    Tracker Template Specification

    TransformerInstance

    Partial implementation of the TransformerInstance scripting class.

    TransformerSpecification

    TwoDiodeParameters

    Uncertainty

    UncertaintyAnnualVariabilities

    Workbook

    Main scripting data model class. Static properties expose the data model to scripting.

    WorkbookSettings

    WorkbookSpecificModuleSpecification

    YearRange

    YieldResult

    YieldResults

    Structs

    Irradiance

    An Irradiance

    Temperature

    A temperature

    Interfaces

    AddableCollection<T>

    Interface for a collection of T to which items can be added

    I2DLocation

    Interface for a 2D location

    I3DLocation

    Interface for a 3D location

    IAddableEnumerable<T>

    Interface for a collection which is Addable and Enumerable

    IAddableKeyedEnumerable<TKey, TValue>

    Interface for a collection which is addable, enumerable and items can be retrieved by key

    IClearableCollection<T>

    Interface for a collection of T which can be cleared

    IEditableKeyedCollection<tKeyType, tContainedType>

    IEditableKeyedEnumerable<TKeyType, TContainedType>

    IElevationSource

    Interface defines a type which provides Elevation information

    INamedItem

    Interface for items which expose a name property

    IReadable2DLocation

    Interface for a readonly 2D location

    IReadable3DLocation

    Interface for a readonly 3D location

    IReadableKeyedCollection<tKeyType, tContainedType>

    Interface for a collection from which items can be retrieved by indexing with a key

    IReadableKeyedEnumerable<TKey, TValue>

    Interface for a collection which enumerable and items can be retrieved by key

    IRemovableKeyedEnumerable<TKey, TValue>

    Interface for a collection which is removable, enumerable and items can be retrieved by key

    IResolution

    Interface defines a type which specifies a horizontal and vertical resolution

    ISpeed

    Enums

    AngularModelEnum

    AreaLimitationType

    BuildingBoundaryType

    CircumsolarType

    DiffuseShadingScheme

    DiffuseTranspositionModel

    DiodeModel

    DistanceType

    DistributionType

    EfficiencyCurveType

    The type of an efficiency curve

    ElectricalLimitationType

    EnergyYieldCalculationType

    EnumTechnology

    FillOptionsSpacingType

    FillOptionsType

    InverterEfficiencyType

    InverterSpecificationDocumentType

    InverterType

    LayoutChoiceType

    LayoutParamsPitchModel

    LogLevel

    The different levels for logging

    MarginType

    ModuleCellLayoutType

    ModuleOrientation

    ModuleSpecificationDocumentType

    PowerOptimiserOperationType

    PvsystInputIrradianceType

    ShadingBoundaryType

    ShadingTargetPointPattern

    SiteLayoutType

    SpecifySiteConfiguration

    SpecifySiteLayoutRegionFillChoice

    StringPatternType

    TrackerPlacementModeType

    TransformerModelType

    TransformerSpecificationDocumentType

    In This Article
    Back to top DNV SolarFarmer Home