KiCad PCB EDA Suite
Loading...
Searching...
No Matches
IO_ERROR Class Reference

Hold an error message and may be used when throwing exceptions containing meaningful error messages. More...

#include <ki_exception.h>

Inheritance diagram for IO_ERROR:
PARSE_ERROR FUTURE_FORMAT_ERROR

Public Member Functions

 IO_ERROR (const wxString &aProblem, const char *aThrowersFile, const char *aThrowersFunction, int aThrowersLineNumber)
 Use macro THROW_IO_ERROR() to wrap a call to this constructor at the call site. More...
 
 IO_ERROR ()
 
void init (const wxString &aProblem, const char *aThrowersFile, const char *aThrowersFunction, int aThrowersLineNumber)
 
virtual const wxString Problem () const
 what was the problem? More...
 
virtual const wxString Where () const
 where did the Problem() occur? More...
 
virtual const wxString What () const
 A composite of Problem() and Where() More...
 
virtual ~IO_ERROR () throw ()
 

Protected Attributes

wxString problem
 
wxString where
 

Detailed Description

Hold an error message and may be used when throwing exceptions containing meaningful error messages.

Author
Dick Hollenbeck

Definition at line 76 of file ki_exception.h.

Constructor & Destructor Documentation

◆ IO_ERROR() [1/2]

IO_ERROR::IO_ERROR ( const wxString &  aProblem,
const char *  aThrowersFile,
const char *  aThrowersFunction,
int  aThrowersLineNumber 
)
inline

Use macro THROW_IO_ERROR() to wrap a call to this constructor at the call site.

Parameters
aProblemis Problem() text.
aThrowersFileis the FILE preprocessor macro but generated at the source file of thrower.
aThrowersFunctionis the function name at the throw site.
aThrowersLineNumberis the source code line number of the throw.

Definition at line 88 of file ki_exception.h.

◆ IO_ERROR() [2/2]

IO_ERROR::IO_ERROR ( )
inline

Definition at line 94 of file ki_exception.h.

◆ ~IO_ERROR()

virtual IO_ERROR::~IO_ERROR ( )
throw (
)
inlinevirtual

Definition at line 104 of file ki_exception.h.

Member Function Documentation

◆ init()

void IO_ERROR::init ( const wxString &  aProblem,
const char *  aThrowersFile,
const char *  aThrowersFunction,
int  aThrowersLineNumber 
)

Definition at line 53 of file exceptions.cpp.

References _, problem, and where.

◆ Problem()

◆ What()

const wxString IO_ERROR::What ( ) const
virtual

A composite of Problem() and Where()

Definition at line 30 of file exceptions.cpp.

References Problem(), and Where().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), PCB_CONTROL::AppendBoard(), PL_EDIT_TOOL::Copy(), SIM_MODEL::Create(), SCH_EDIT_FRAME::CreateArchiveLibrary(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SIM_LIB_MGR::CreateModel(), PCB_BASE_EDIT_FRAME::createNewLibrary(), SCH_PLOTTER::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), DS_DATA_MODEL_FILEIO::DS_DATA_MODEL_FILEIO(), DS_DATA_MODEL_STRINGIO::DS_DATA_MODEL_STRINGIO(), PCB_EDIT_FRAME::Export_IDF3(), FOOTPRINT_EDIT_FRAME::ExportFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), PCB_EDIT_FRAME::ExportSpecctraFile(), SYMBOL_EDIT_FRAME::ExportSymbol(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), PCB_EDIT_FRAME::FetchNetlistFromSchematic(), PCB_IO_EAGLE::FootprintEnumerate(), PCB_IO_GEDA::FootprintEnumerate(), PCB_IO_KICAD_LEGACY::FootprintEnumerate(), PCB_IO_KICAD_SEXPR::FootprintEnumerate(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), PCB_EDIT_FRAME::GenIPC2581File(), SYMBOL_LIBRARY_MANAGER::GetAlias(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), SYMBOL_LIBRARY_MANAGER::getOriginalSymbols(), PGM_BASE::HandleException(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), PCB_EDIT_FRAME::ImportSpecctraSession(), SYMBOL_EDIT_FRAME::ImportSymbol(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), GPCB_FPL_CACHE::Load(), FP_CACHE::Load(), PNS_LOG_FILE::Load(), LTSPICE_SCHEMATIC::Load(), SYMBOL_LIBS::LoadAllLibraries(), KI_TEST::LoadBoard(), DS_DATA_MODEL::LoadDrawingSheet(), SCH::IFACE::loadGlobalLibTable(), PCB::IFACE::loadGlobalLibTable(), SCH_IO_KICAD_SEXPR::loadHierarchy(), SCH_IO_KICAD_LEGACY::loadHierarchy(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), main(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), APP_TEST::OnInit(), CV::IFACE::OnKifaceStart(), APP_TEST::OnRun(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), DIALOG_SIM_MODEL< T_symbol, T_field >::onWaveformChoice(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SPICE_LIBRARY_PARSER::parseFile(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), PROJECT::PcbFootprintLibs(), PROJECT_PCB::PcbFootprintLibs(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), PANEL_REGULATOR::ReadDataFile(), SPICE_LIBRARY_PARSER::readFallbacks(), CVPCB_MAINFRAME::readNetListAndFpFiles(), PCB_EDIT_FRAME::ReadNetlistFromFile(), CVPCB_MAINFRAME::readSchematicNetlist(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), PCB_EDIT_FRAME::RunEeschema(), LIB_BUFFER::SaveBuffer(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), FOOTPRINT_EDIT_FRAME::SaveLibraryAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveSchematicFile(), SCH_BASE_FRAME::saveSymbolLibTables(), SchGetLibSymbol(), PROJECT_SCH::SchLibs(), PROJECT_SCH::SchSymbolLibTable(), PCB_BASE_FRAME::setFPWatcher(), SIM_LIB_MGR::SetLibrary(), DS_DATA_MODEL::SetPageLayout(), SCH_BASE_FRAME::setSymWatcher(), PANEL_SYMBOL_CHOOSER::showFootprintFor(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDITOR_CONTROL::SimProbe(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), SCH_SCREEN::UpdateSymbolLinks(), PANEL_SYM_LIB_TABLE::verifyTables(), SYMBOL_ASYNC_LOADER::worker(), WriteDRCReport(), NETLIST_EXPORTER_KICAD::WriteNetlist(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ Where()

const wxString IO_ERROR::Where ( ) const
virtual

where did the Problem() occur?

Definition at line 40 of file exceptions.cpp.

References where.

Referenced by PCB_EDIT_FRAME::FetchNetlistFromSchematic(), and What().

Member Data Documentation

◆ problem

wxString IO_ERROR::problem
protected

◆ where

wxString IO_ERROR::where
protected

Definition at line 108 of file ki_exception.h.

Referenced by init(), PARSE_ERROR::init(), and Where().


The documentation for this class was generated from the following files: