EESCHEMA_JOBS_HANDLER Class Reference

Handle Eeschema job dispatches. More...

#include <eeschema_jobs_handler.h>

Inheritance diagram for EESCHEMA_JOBS_HANDLER:

Public Member Functions
	EESCHEMA_JOBS_HANDLER (KIWAY *aKiway)
int	JobExportBom (JOB *aJob)
int	JobExportPythonBom (JOB *aJob)
int	JobExportNetlist (JOB *aJob)
int	JobExportPlot (JOB *aJob)
int	JobSchErc (JOB *aJob)
int	JobSymUpgrade (JOB *aJob)
int	JobSymExportSvg (JOB *aJob)
int	JobUpgrade (JOB *aJob)
void	InitRenderSettings (SCH_RENDER_SETTINGS *aRenderSettings, const wxString &aTheme, SCHEMATIC *aSch, const wxString &aDrawingSheetOverride=wxEmptyString)
	Configure the SCH_RENDER_SETTINGS object with the correct data to be used with plotting.
void	Register (const std::string &aJobTypeName, std::function< int(JOB *job)> aHandler, std::function< bool(JOB *job, wxWindow *aParent)> aConfigHandler)
int	RunJob (JOB *aJob, REPORTER *aReporter, PROGRESS_REPORTER *aProgressReporter)
bool	HandleJobConfig (JOB *aJob, wxWindow *aParent)
void	SetReporter (REPORTER *aReporter)
void	SetProgressReporter (PROGRESS_REPORTER *aReporter)

Protected Attributes
KIWAY *	m_kiway
REPORTER *	m_reporter
PROGRESS_REPORTER *	m_progressReporter

Private Member Functions
SCHEMATIC *	getSchematic (const wxString &aPath)
int	doSymExportSvg (JOB_SYM_EXPORT_SVG *aSvgJob, SCH_RENDER_SETTINGS *aRenderSettings, LIB_SYMBOL *symbol)
DS_PROXY_VIEW_ITEM *	getDrawingSheetProxyView (SCHEMATIC *aSch)

Private Attributes
SCHEMATIC *	m_cliSchematic
std::map< std::string, std::function< int(JOB *job)> >	m_jobHandlers
std::map< std::string, std::function< bool(JOB *job, wxWindow *aParent)> >	m_jobConfigHandlers

Detailed Description

Handle Eeschema job dispatches.

Definition at line 37 of file eeschema_jobs_handler.h.

Constructor & Destructor Documentation

EESCHEMA_JOBS_HANDLER()

EESCHEMA_JOBS_HANDLER::EESCHEMA_JOBS_HANDLER

(

KIWAY *

aKiway

)

Definition at line 82 of file eeschema_jobs_handler.cpp.

References _, DisplayErrorMessage(), FRAME_SCH, HPGL, JOB_DISPATCHER::JOB_DISPATCHER(), JobExportBom(), JobExportNetlist(), JobExportPlot(), JobExportPythonBom(), JobSchErc(), JobSymExportSvg(), JobSymUpgrade(), JobUpgrade(), m_cliSchematic, JOB_EXPORT_SCH_PLOT::m_plotFormat, KIWAY::Player(), JOB_DISPATCHER::Register(), and DIALOG_SHIM::ShowModal().

Member Function Documentation

doSymExportSvg()

int EESCHEMA_JOBS_HANDLER::doSymExportSvg ( JOB_SYM_EXPORT_SVG * aSvgJob, SCH_RENDER_SETTINGS * aRenderSettings, LIB_SYMBOL * symbol )

private

Definition at line 832 of file eeschema_jobs_handler.cpp.

References _, SVG_PLOTTER::EndPlot(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, LIB_SYMBOL::Flatten(), LIB_SYMBOL::GetBodyStyleCount(), LIB_SYMBOL::GetBodyStyleNames(), BOX2< Vec >::GetCenter(), BOX2< Vec >::GetHeight(), PAGE_INFO::GetHeightIU(), LIB_SYMBOL::GetName(), LIB_SYMBOL::GetRootSymbol(), LIB_SYMBOL::GetUnitBoundingBox(), LIB_SYMBOL::GetUnitCount(), BOX2< Vec >::GetWidth(), PAGE_INFO::GetWidthIU(), LIB_SYMBOL::HasDeMorganBodyStyles(), LIB_SYMBOL::IsDerived(), JOB_SYM_EXPORT_SVG::m_blackAndWhite, JOB_SYM_EXPORT_SVG::m_includeHiddenFields, JOB_SYM_EXPORT_SVG::m_outputDirectory, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, PLOTTER::OpenFile(), LIB_SYMBOL::Plot(), LIB_SYMBOL::PlotFields(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, scale, schIUScale, PLOTTER::SetColorMode(), PLOTTER::SetCreator(), PAGE_INFO::SetHeightMils(), PLOTTER::SetPageSettings(), PLOTTER::SetRenderSettings(), SVG_PLOTTER::SetViewport(), PAGE_INFO::SetWidthMils(), SVG_PLOTTER::StartPlot(), FILEEXT::SVGFileExtension, and User.

Referenced by JobSymExportSvg().

getDrawingSheetProxyView()

DS_PROXY_VIEW_ITEM * EESCHEMA_JOBS_HANDLER::getDrawingSheetProxyView ( SCHEMATIC * aSch )

private

Definition at line 1255 of file eeschema_jobs_handler.cpp.

References SCH_SCREEN::GetFileName(), BASE_SCREEN::GetPageCount(), BASE_SCREEN::GetPageNumber(), SCH_SCREEN::GetPageSettings(), SCHEMATIC::GetProperties(), SCH_SCREEN::GetTitleBlock(), BASE_SCREEN::GetVirtualPageNumber(), LAYER_SCHEMATIC_DRAWINGSHEET, LAYER_SCHEMATIC_PAGE_LIMITS, SCHEMATIC::Project(), SCHEMATIC::RootScreen(), schIUScale, DS_PROXY_VIEW_ITEM::SetColorLayer(), DS_PROXY_VIEW_ITEM::SetFileName(), DS_PROXY_VIEW_ITEM::SetIsFirstPage(), DS_PROXY_VIEW_ITEM::SetPageBorderColorLayer(), DS_PROXY_VIEW_ITEM::SetPageNumber(), DS_PROXY_VIEW_ITEM::SetSheetCount(), DS_PROXY_VIEW_ITEM::SetSheetName(), DS_PROXY_VIEW_ITEM::SetSheetPath(), and TO_UTF8.

Referenced by JobSchErc().

getSchematic()

SCHEMATIC * EESCHEMA_JOBS_HANDLER::getSchematic ( const wxString & aPath )

private

Definition at line 171 of file eeschema_jobs_handler.cpp.

References _, FRAME_SCH, GetSettingsManager(), PGM_BASE::GetSettingsManager(), FILEEXT::KiCadSchematicFileExtension, EESCHEMA_HELPERS::LoadSchematic(), m_cliSchematic, JOB_DISPATCHER::m_kiway, JOB_DISPATCHER::m_reporter, path, Pgm(), SETTINGS_MANAGER::Prj(), project, RPT_SEVERITY_ERROR, and SCH_EDIT_FRAME::Schematic().

Referenced by JobExportBom(), JobExportNetlist(), JobExportPlot(), JobExportPythonBom(), JobSchErc(), and JobUpgrade().

HandleJobConfig()

bool JOB_DISPATCHER::HandleJobConfig ( JOB * aJob, wxWindow * aParent )

inherited

Definition at line 66 of file job_dispatcher.cpp.

References JOB::GetType(), and m_jobConfigHandlers.

InitRenderSettings()

void EESCHEMA_JOBS_HANDLER::InitRenderSettings	(	SCH_RENDER_SETTINGS *	aRenderSettings,
		const wxString &	aTheme,
		SCHEMATIC *	aSch,
		const wxString &	aDrawingSheetOverride = wxEmptyString )

Configure the SCH_RENDER_SETTINGS object with the correct data to be used with plotting.

It's sort of a kludge due to the plotter depending on this object normally managed by the frame and canvas.

Parameters

aRenderSettings	The object to populate with working settings.
aTheme	The theme to take color data from to stick into render settings, can be left blank for default.
aSch	The schematic to further copy settings from to be put into aRenderSettings.

Definition at line 211 of file eeschema_jobs_handler.cpp.

References _, GetColorSettings(), SCHEMATIC::GetEmbeddedFiles(), DS_DATA_MODEL::GetTheInstance(), SCH_RENDER_SETTINGS::LoadColors(), SCHEMATIC_SETTINGS::m_DashedLineDashRatio, SCHEMATIC_SETTINGS::m_DashedLineGapRatio, SCHEMATIC_SETTINGS::m_DefaultLineWidth, SCH_RENDER_SETTINGS::m_LabelSizeRatio, SCHEMATIC_SETTINGS::m_LabelSizeRatio, SCH_RENDER_SETTINGS::m_PinSymbolSize, SCHEMATIC_SETTINGS::m_PinSymbolSize, JOB_DISPATCHER::m_reporter, SCHEMATIC_SETTINGS::m_SchDrawingSheetFileName, SCH_RENDER_SETTINGS::m_ShowHiddenFields, SCH_RENDER_SETTINGS::m_ShowHiddenPins, SCH_RENDER_SETTINGS::m_ShowPinAltIcons, SCH_RENDER_SETTINGS::m_TextOffsetRatio, SCHEMATIC_SETTINGS::m_TextOffsetRatio, path, Pgm(), SCHEMATIC::Project(), FILENAME_RESOLVER::ResolvePath(), RPT_SEVERITY_ERROR, KIGFX::RENDER_SETTINGS::SetDashLengthRatio(), KIGFX::RENDER_SETTINGS::SetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::SetGapLengthRatio(), FILENAME_RESOLVER::SetProgramBase(), FILENAME_RESOLVER::SetProject(), and SCHEMATIC::Settings().

Referenced by JobExportPlot().

JobExportBom()

int EESCHEMA_JOBS_HANDLER::JobExportBom

(

JOB *

aJob

)

Definition at line 483 of file eeschema_jobs_handler.cpp.

References _, FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyBomPreset(), PROJECT::ApplyTextVars(), BOM_FMT_PRESET::BuiltInPresets(), BOM_PRESET::BuiltInPresets(), alg::contains(), copy, FILEEXT::CsvFileExtension, DO_TRANSLATE, PATHS::EnsurePathExists(), erc, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, BOM_PRESET::excludeDNP, FIELDS_EDITOR_GRID_DATA_MODEL::Export(), BOM_FMT_PRESET::fieldDelimiter, BOM_PRESET::fieldsOrdered, BOM_PRESET::filterString, GetCanonicalFieldName(), JOB::GetConfiguredOutputPath(), SCH_REFERENCE_LIST::GetCount(), GetDefaultFieldName(), SCH_SYMBOL::GetFields(), FIELDS_EDITOR_GRID_DATA_MODEL::GetFieldsOrdered(), SCHEMATIC::GetFileName(), JOB::GetFullOutputPath(), GetGeneratedFieldDisplayName(), getSchematic(), SCH_SHEET_LIST::GetSymbols(), TEMPLATES::GetTemplateFieldNames(), SCH_SCREEN::GetTitleBlock(), JOB::GetVarOverrides(), BOM_FIELD::groupBy, BOM_PRESET::groupSymbols, SCHEMATIC::Hierarchy(), IsGeneratedField(), BOM_FMT_PRESET::keepLineBreaks, BOM_FMT_PRESET::keepTabs, BOM_FIELD::label, JOB_EXPORT_SCH_BOM::m_bomFmtPresetName, SCHEMATIC_SETTINGS::m_BomFmtPresets, JOB_EXPORT_SCH_BOM::m_bomPresetName, SCHEMATIC_SETTINGS::m_BomPresets, JOB_EXPORT_SCH_BOM::m_excludeDNP, JOB_EXPORT_SCH_BOM::m_fieldDelimiter, JOB_EXPORT_SCH_BOM::m_fieldsGroupBy, JOB_EXPORT_SCH_BOM::m_fieldsLabels, JOB_EXPORT_SCH_BOM::m_fieldsOrdered, JOB_EXPORT_SCH_BOM::m_filename, JOB_EXPORT_SCH_BOM::m_filterString, JOB_EXPORT_SCH_BOM::m_keepLineBreaks, JOB_EXPORT_SCH_BOM::m_keepTabs, JOB_EXPORT_SCH_BOM::m_refDelimiter, JOB_EXPORT_SCH_BOM::m_refRangeDelimiter, JOB_DISPATCHER::m_reporter, JOB_EXPORT_SCH_BOM::m_sortAsc, JOB_EXPORT_SCH_BOM::m_sortField, JOB_EXPORT_SCH_BOM::m_stringDelimiter, SCHEMATIC_SETTINGS::m_TemplateFieldNames, MANDATORY_FIELDS, BOM_FIELD::name, CLI::EXIT_CODES::OK, SCHEMATIC::Project(), BOM_FMT_PRESET::refDelimiter, BOM_FMT_PRESET::refRangeDelimiter, res, SCHEMATIC::RootScreen(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, JOB::SetConfiguredOutputPath(), SCHEMATIC::Settings(), JOB::SetTitleBlock(), BOM_FIELD::show, BOM_PRESET::sortAsc, BOM_PRESET::sortField, and BOM_FMT_PRESET::stringDelimiter.

Referenced by EESCHEMA_JOBS_HANDLER().

JobExportNetlist()

int EESCHEMA_JOBS_HANDLER::JobExportNetlist

(

JOB *

aJob

)

Definition at line 365 of file eeschema_jobs_handler.cpp.

References _, JOB_EXPORT_SCH_NETLIST::ALLEGRO, PROJECT::ApplyTextVars(), JOB_EXPORT_SCH_NETLIST::CADSTAR, FILEEXT::CadstarNetlistFileExtension, SCH_REFERENCE_LIST::CheckAnnotation(), PATHS::EnsurePathExists(), erc, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, JOB_EXPORT_SCH_NETLIST::format, JOB::GetConfiguredOutputPath(), SCH_REFERENCE_LIST::GetCount(), SCHEMATIC::GetFileName(), JOB::GetFullOutputPath(), getSchematic(), SCH_SHEET_LIST::GetSymbols(), SCH_SCREEN::GetTitleBlock(), JOB::GetVarOverrides(), SCHEMATIC::Hierarchy(), JOB_EXPORT_SCH_NETLIST::KICADSEXPR, JOB_EXPORT_SCH_NETLIST::KICADXML, JOB_EXPORT_SCH_NETLIST::m_filename, JOB_DISPATCHER::m_reporter, FILEEXT::NetlistFileExtension, CLI::EXIT_CODES::OK, NETLIST_EXPORTER_SPICE::OPTION_SIM_COMMAND, JOB_EXPORT_SCH_NETLIST::ORCADPCB2, FILEEXT::OrCadPcb2NetlistFileExtension, JOB_EXPORT_SCH_NETLIST::PADS, SCHEMATIC::Project(), res, SCHEMATIC::RootScreen(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, JOB::SetConfiguredOutputPath(), JOB::SetTitleBlock(), JOB_EXPORT_SCH_NETLIST::SPICE, FILEEXT::SpiceFileExtension, and JOB_EXPORT_SCH_NETLIST::SPICEMODEL.

Referenced by EESCHEMA_JOBS_HANDLER().

JobExportPlot()

int EESCHEMA_JOBS_HANDLER::JobExportPlot

(

JOB *

aJob

)

Definition at line 263 of file eeschema_jobs_handler.cpp.

References _, PROJECT::ApplyTextVars(), EESCHEMA_SETTINGS::APPEARANCE::default_font, DXF, PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, GetAppSettings(), JOB::GetFullOutputPath(), JOB::GetOutputPathIsDirectory(), getSchematic(), SCH_SCREEN::GetTitleBlock(), JOB::GetVarOverrides(), HPGL, InitRenderSettings(), KICAD_FONT_NAME, EESCHEMA_SETTINGS::m_Appearance, JOB_EXPORT_SCH_PLOT::m_blackAndWhite, SCH_PLOT_OPTS::m_blackAndWhite, JOB_EXPORT_SCH_PLOT::m_defaultFont, JOB_EXPORT_SCH_PLOT::m_drawingSheet, SCH_PLOT_OPTS::m_DXF_File_Unit, JOB_EXPORT_SCH_PLOT::m_filename, JOB_EXPORT_SCH_PLOT::m_minPenWidth, SCH_PLOT_OPTS::m_outputDirectory, SCH_PLOT_OPTS::m_outputFile, JOB_EXPORT_SCH_PLOT::m_pageSizeSelect, SCH_PLOT_OPTS::m_pageSizeSelect, JOB_EXPORT_SCH_PLOT::m_PDFHierarchicalLinks, SCH_PLOT_OPTS::m_PDFHierarchicalLinks, JOB_EXPORT_SCH_PLOT::m_PDFMetadata, SCH_PLOT_OPTS::m_PDFMetadata, JOB_EXPORT_SCH_PLOT::m_PDFPropertyPopups, SCH_PLOT_OPTS::m_PDFPropertyPopups, JOB_EXPORT_SCH_PLOT::m_plotAll, SCH_PLOT_OPTS::m_plotAll, JOB_EXPORT_SCH_PLOT::m_plotDrawingSheet, SCH_PLOT_OPTS::m_plotDrawingSheet, JOB_EXPORT_SCH_PLOT::m_plotFormat, SCH_PLOT_OPTS::m_plotHopOver, JOB_EXPORT_SCH_PLOT::m_plotPages, SCH_PLOT_OPTS::m_plotPages, JOB_DISPATCHER::m_reporter, JOB_EXPORT_SCH_PLOT::m_show_hop_over, JOB_EXPORT_SCH_PLOT::m_theme, SCH_PLOT_OPTS::m_theme, JOB_EXPORT_SCH_PLOT::m_useBackgroundColor, SCH_PLOT_OPTS::m_useBackgroundColor, MM, CLI::EXIT_CODES::OK, PAGE_SIZE_A, PAGE_SIZE_A4, PAGE_SIZE_AUTO, PDF, POST, SCHEMATIC::Project(), SCHEMATIC::RootScreen(), RPT_SEVERITY_ERROR, JOB::SetTitleBlock(), and SVG.

Referenced by EESCHEMA_JOBS_HANDLER().

JobExportPythonBom()

int EESCHEMA_JOBS_HANDLER::JobExportPythonBom

(

JOB *

aJob

)

Definition at line 761 of file eeschema_jobs_handler.cpp.

References _, PROJECT::ApplyTextVars(), SCH_REFERENCE_LIST::CheckAnnotation(), PATHS::EnsurePathExists(), erc, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, JOB::GetConfiguredOutputPath(), SCH_REFERENCE_LIST::GetCount(), SCHEMATIC::GetFileName(), JOB::GetFullOutputPath(), getSchematic(), SCH_SHEET_LIST::GetSymbols(), SCH_SCREEN::GetTitleBlock(), JOB::GetVarOverrides(), GNL_OPT_BOM, SCHEMATIC::Hierarchy(), JOB_EXPORT_SCH_PYTHONBOM::m_filename, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, SCHEMATIC::Project(), res, SCHEMATIC::RootScreen(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, JOB::SetConfiguredOutputPath(), JOB::SetTitleBlock(), and FILEEXT::XmlFileExtension.

Referenced by EESCHEMA_JOBS_HANDLER().

JobSchErc()

int EESCHEMA_JOBS_HANDLER::JobSchErc

(

JOB *

aJob

)

Definition at line 1119 of file eeschema_jobs_handler.cpp.

References _, PROJECT::ApplyTextVars(), PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_RC_VIOLATIONS, CLI::EXIT_CODES::ERR_UNKNOWN, KIWAY::FACE_CVPCB, JOB::GetConfiguredOutputPath(), getDrawingSheetProxyView(), SCHEMATIC::GetFileName(), JOB::GetFullOutputPath(), getSchematic(), SCH_SCREEN::GetTitleBlock(), JOB::GetVarOverrides(), INCH, JOB_RC::INCH, JOB_RC::JSON, FILEEXT::JsonFileExtension, JOB_RC::m_exitCodeViolations, JOB_RC::m_filename, JOB_RC::m_format, JOB_DISPATCHER::m_kiway, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, JOB_RC::m_severity, JOB_RC::m_units, MILS, JOB_RC::MILS, MM, JOB_RC::MM, SCHEMATIC::Project(), FILEEXT::ReportFileExtension, SCHEMATIC::RootScreen(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, ERC_TESTER::RunTests(), JOB::SetConfiguredOutputPath(), JOB::SetTitleBlock(), CLI::EXIT_CODES::SUCCESS, ERC_REPORT::WriteJsonReport(), and ERC_REPORT::WriteTextReport().

Referenced by EESCHEMA_JOBS_HANDLER().

JobSymExportSvg()

int EESCHEMA_JOBS_HANDLER::JobSymExportSvg

(

JOB *

aJob

)

Definition at line 946 of file eeschema_jobs_handler.cpp.

References _, DEFAULT_LINE_WIDTH_MILS, doSymExportSvg(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_UNKNOWN, GetColorSettings(), SCH_IO_LIB_CACHE::GetSymbol(), SCH_IO_LIB_CACHE::GetSymbolMap(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Load(), SCH_RENDER_SETTINGS::LoadColors(), JOB_SYM_EXPORT_SVG::m_colorTheme, JOB_SYM_EXPORT_SVG::m_includeHiddenFields, JOB_SYM_EXPORT_SVG::m_includeHiddenPins, JOB_SYM_EXPORT_SVG::m_libraryPath, JOB_SYM_EXPORT_SVG::m_outputDirectory, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, SCH_RENDER_SETTINGS::m_ShowHiddenFields, SCH_RENDER_SETTINGS::m_ShowHiddenPins, JOB_SYM_EXPORT_SVG::m_symbol, name, CLI::EXIT_CODES::OK, RPT_SEVERITY_ERROR, schIUScale, and KIGFX::RENDER_SETTINGS::SetDefaultPenWidth().

Referenced by EESCHEMA_JOBS_HANDLER().

JobSymUpgrade()

int EESCHEMA_JOBS_HANDLER::JobSymUpgrade

(

JOB *

aJob

)

Definition at line 1033 of file eeschema_jobs_handler.cpp.

References _, SCH_IO_MGR::ConvertLibrary(), CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, fileType(), SCH_IO_KICAD_SEXPR_LIB_CACHE::GetFileFormatVersionAtLoad(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Load(), JOB_SYM_UPGRADE::m_force, JOB_SYM_UPGRADE::m_libraryPath, JOB_SYM_UPGRADE::m_outputLibraryPath, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, SCH_IO_KICAD_SEXPR_LIB_CACHE::Save(), SCH_IO_LIB_CACHE::SetFileName(), SCH_IO_LIB_CACHE::SetModified(), and SEXPR_SYMBOL_LIB_FILE_VERSION.

Referenced by EESCHEMA_JOBS_HANDLER().

JobUpgrade()

int EESCHEMA_JOBS_HANDLER::JobUpgrade

(

JOB *

aJob

)

Definition at line 1207 of file eeschema_jobs_handler.cpp.

References _, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, SCH_SCREEN::GetFileFormatVersionAtLoad(), getSchematic(), JOB_SCH_UPGRADE::m_filename, JOB_SCH_UPGRADE::m_force, JOB_DISPATCHER::m_reporter, SCHEMATIC::RootScreen(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, SEXPR_SCHEMATIC_FILE_VERSION, CLI::EXIT_CODES::SUCCESS, and IO_ERROR::What().

Referenced by EESCHEMA_JOBS_HANDLER().

Register()

void JOB_DISPATCHER::Register ( const std::string & aJobTypeName, std::function< int(JOB *job)> aHandler, std::function< bool(JOB *job, wxWindow *aParent)> aConfigHandler )

inherited

Definition at line 36 of file job_dispatcher.cpp.

References m_jobConfigHandlers, and m_jobHandlers.

Referenced by EESCHEMA_JOBS_HANDLER::EESCHEMA_JOBS_HANDLER(), and PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER().

RunJob()

int JOB_DISPATCHER::RunJob ( JOB * aJob, REPORTER * aReporter, PROGRESS_REPORTER * aProgressReporter )

inherited

Definition at line 45 of file job_dispatcher.cpp.

References JOB::ClearExistingOutputs(), CLI::EXIT_CODES::ERR_UNKNOWN, JOB::GetType(), m_jobHandlers, m_progressReporter, m_reporter, and result.

SetProgressReporter()

void JOB_DISPATCHER::SetProgressReporter ( PROGRESS_REPORTER * aReporter )

inherited

Definition at line 84 of file job_dispatcher.cpp.

References m_progressReporter.

SetReporter()

void JOB_DISPATCHER::SetReporter ( REPORTER * aReporter )

inherited

Definition at line 77 of file job_dispatcher.cpp.

References m_reporter.

Member Data Documentation

m_cliSchematic

SCHEMATIC* EESCHEMA_JOBS_HANDLER::m_cliSchematic

private

Definition at line 73 of file eeschema_jobs_handler.h.

Referenced by EESCHEMA_JOBS_HANDLER(), and getSchematic().

m_jobConfigHandlers

std::map<std::string, std::function<bool( JOB* job, wxWindow* aParent )> > JOB_DISPATCHER::m_jobConfigHandlers

privateinherited

Definition at line 55 of file job_dispatcher.h.

Referenced by HandleJobConfig(), and Register().

m_jobHandlers

std::map<std::string, std::function<int( JOB* job )> > JOB_DISPATCHER::m_jobHandlers

privateinherited

Definition at line 53 of file job_dispatcher.h.

Referenced by Register(), and RunJob().

m_kiway

KIWAY* JOB_DISPATCHER::m_kiway

protectedinherited

Definition at line 48 of file job_dispatcher.h.

Referenced by PCBNEW_JOBS_HANDLER::getBoard(), EESCHEMA_JOBS_HANDLER::getSchematic(), PCBNEW_JOBS_HANDLER::getToolManager(), JOB_DISPATCHER(), PCBNEW_JOBS_HANDLER::JobExportDrc(), and EESCHEMA_JOBS_HANDLER::JobSchErc().

m_progressReporter

PROGRESS_REPORTER* JOB_DISPATCHER::m_progressReporter

protectedinherited

Definition at line 50 of file job_dispatcher.h.

Referenced by JOB_DISPATCHER(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportOdb(), EESCHEMA_JOBS_HANDLER::JobSchErc(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), RunJob(), and SetProgressReporter().

m_reporter

REPORTER* JOB_DISPATCHER::m_reporter

protectedinherited

Definition at line 49 of file job_dispatcher.h.

Referenced by PCBNEW_JOBS_HANDLER::convertLayerArg(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), PCBNEW_JOBS_HANDLER::getBoard(), EESCHEMA_JOBS_HANDLER::getSchematic(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), JOB_DISPATCHER(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSchErc(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), EESCHEMA_JOBS_HANDLER::JobUpgrade(), PCBNEW_JOBS_HANDLER::JobUpgrade(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER(), RunJob(), and SetReporter().

---

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

• eeschema_jobs_handler.h
• eeschema_jobs_handler.cpp