goblin_lite.resource_manager.scenario_data_fetcher
The ScenarioDataFetcher class is designed to extract specific pieces of information from a scenario dataset.
Module Contents
Classes
The ScenarioDataFetcher class is designed to extract specific pieces of information from a scenario dataset. |
- class goblin_lite.resource_manager.scenario_data_fetcher.ScenarioDataFetcher(scenario_data)[source]
The ScenarioDataFetcher class is designed to extract specific pieces of information from a scenario dataset.
This class provides methods to retrieve various information from a scenario dataset.
- get_column_index(column_name)[source]
Retrieves the index of a specified column in the scenario data.
- get_afforestation_end_year()[source]
Retrieves the end year for afforestation activities for a specified scenario.
- get_catchment_name()[source]
Retrieves the name of the catchment area defined in the scenario data.
- get_afforest_scenario_index()
Retrieves a list of afforestation scenario indices, with -1 indicating a special scenario, followed by the indices of all available scenarios.
- get_column_index(column_name)[source]
Retrieves the index of a specified column in the scenario data.
- Parameters:
column_name (str) – The name of the column to retrieve.
- Returns:
The index of the column.
- Return type:
int
- get_afforestation_end_year()[source]
Retrieves the end year for afforestation activities for a specified scenario.
- Returns:
The afforestation end year.
- Return type:
int
- get_catchment_name()[source]
Retrieves the name of the catchment area defined in the scenario data.
- Returns:
The catchment name.
- Return type:
str
- get_scenario_list()[source]
Retrieves a list of all scenarios present in the scenario data.
- Returns:
A list of scenario identifiers.
- Return type:
list
- get_total_scenarios()[source]
Retrieves the total number of scenarios present in the scenario data.
- Returns:
The total number of scenarios.
- Return type:
int