Class Workbook
Central data store for data.
Namespace: Scripting
Syntax
public class Workbook
Properties
Climate
Gets the climate data from the workbook.
Declaration
public static Climate Climate { get; }
Property Value
Type | Description |
---|---|
Climate |
CurrentScenario
Gets the current energy results in the workbook.
Declaration
public static Scenario CurrentScenario { get; }
Property Value
Type | Description |
---|---|
Scenario |
CurtailmentTypes
Gets the curtailment types.
Declaration
public static IKeyedCurtailmentTypeCollection CurtailmentTypes { get; }
Property Value
Type | Description |
---|---|
IKeyedCurtailmentTypeCollection |
ExclusionRegions
Gets all the exclusion regions in the workbook (can also be accessed by their name).
Declaration
public static IKeyedRegionCollection ExclusionRegions { get; }
Property Value
Type | Description |
---|---|
IKeyedRegionCollection |
FrequencyTables
Gets the frequency tables.
Declaration
public static IEnumerable<FrequencyTableMetaData> FrequencyTables { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<FrequencyTableMetaData> |
GenericRegions
Gets all the generic regions in the workbook (can also be accessed by their name).
Declaration
public static IKeyedRegionCollection GenericRegions { get; }
Property Value
Type | Description |
---|---|
IKeyedRegionCollection |
Geography
Gets the geography data from the workbook.
Declaration
public static Geography Geography { get; }
Property Value
Type | Description |
---|---|
Geography |
InclusionRegions
Gets all the inclusion regions in the workbook (can also be accessed by their name).
Declaration
public static IKeyedRegionCollection InclusionRegions { get; }
Property Value
Type | Description |
---|---|
IKeyedRegionCollection |
LayoutScenarios
Declaration
public static IKeyedLayoutScenarioCollection LayoutScenarios { get; }
Property Value
Type | Description |
---|---|
Scripting.Internal.IKeyedLayoutScenarioCollection |
ModelSettings
Retrieves the model settings
Declaration
public static ModelSettings ModelSettings { get; }
Property Value
Type | Description |
---|---|
ModelSettings |
MonteCarloEnergyModel
Gets the Monte Carlo energy model.
Declaration
public static MonteCarloEnergyModel MonteCarloEnergyModel { get; }
Property Value
Type | Description |
---|---|
MonteCarloEnergyModel |
OptimisedLayouts
Gets the optimised layouts (the results of running an optimisation).
Declaration
public static IEnumerable<OptimisedLayout> OptimisedLayouts { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<OptimisedLayout> |
Receptors
Gets all the receptor instances in the workbook (can also be accessed by their name).
Declaration
public static IKeyedReceptorCollection Receptors { get; }
Property Value
Type | Description |
---|---|
IKeyedReceptorCollection |
Turbines
Gets all the turbine instances in the workbook (can also be accessed by their name).
Declaration
public static IReadableKeyedEnumerable<string, Turbine> Turbines { get; }
Property Value
Type | Description |
---|---|
IReadableKeyedEnumerable<System.String, Turbine> |
TurbineTypes
Gets all the turbine types in the workbook (can also be accessed by their name).
Declaration
public static IKeyedTurbineTypeCollection TurbineTypes { get; }
Property Value
Type | Description |
---|---|
IKeyedTurbineTypeCollection |
WindFarms
Gets all the wind farms in the workbook (can also be accessed by their name).
Declaration
public static IKeyedWindFarmCollection WindFarms { get; }
Property Value
Type | Description |
---|---|
IKeyedWindFarmCollection |
Methods
IsValidAveragingMeasurementSiteOption(MeasurementSite)
Determines whether a provided measurement site is a valid averaging measurement site option
Declaration
public static bool IsValidAveragingMeasurementSiteOption(MeasurementSite measurementSite)
Parameters
Type | Name | Description |
---|---|---|
MeasurementSite | measurementSite | The measurement site |
Returns
Type | Description |
---|---|
System.Boolean |