Struct DataWriter

pub struct DataWriter {
    assets_path: PathBuf,
    flows_writer: Writer<File>,
    prices_writer: Writer<File>,
    debug_writer: Option<DebugDataWriter>,
}

An object for writing commodity prices to file

Fields

assets_path: PathBuf

flows_writer: Writer<File>

prices_writer: Writer<File>

debug_writer: Option<DebugDataWriter>

Implementations

impl DataWriter

pub fn create( output_path: &Path, model_path: &Path, save_debug_info: bool, ) -> Result<Self>

Open CSV files to write output data to

Arguments

• output_path - Folder where files will be saved
• model_path - Path to input model
• save_debug_info - Whether to include extra CSV files for debugging model

pub fn write_dispatch_debug_info( &mut self, milestone_year: u32, run_description: &str, solution: &Solution<'_>, ) -> Result<()>

Write debug info about the dispatch optimisation

pub fn write_appraisal_debug_info( &mut self, milestone_year: u32, run_description: &str, appraisal_results: &[AppraisalOutput], ) -> Result<()>

Write debug info about the investment appraisal

pub fn write_assets<'a, I>(&mut self, assets: I) -> Result<()>

where I: Iterator<Item = &'a AssetRef>,

Write assets to a CSV file.

The whole file is written at once and is overwritten with subsequent invocations. This is done so that partial results will be written in the case of errors and so that the user can see the results while the simulation is still running.

The file is sorted by asset ID.

Panics

Panics if any of the assets has not yet been commissioned (decommissioned assets are fine).

pub fn write_flows( &mut self, milestone_year: u32, flow_map: &FlowMap, ) -> Result<()>

Write commodity flows to a CSV file

pub fn write_prices( &mut self, milestone_year: u32, prices: &CommodityPrices, ) -> Result<()>

Write commodity prices to a CSV file

pub fn write_debug_reduced_costs( &mut self, milestone_year: u32, reduced_costs: &ReducedCosts, ) -> Result<()>

Write reduced costs to a CSV file

pub fn flush(&mut self) -> Result<()>

Flush the underlying streams

pub fn set_debug_context(&mut self, context: String)

Add context to the debug writer

pub fn clear_debug_context(&mut self)

Clear context from the debug writer