KiCad PCB EDA Suite: EESCHEMA_JOBS_HANDLER Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

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)

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)

int	RunJob (JOB *job)

void	SetReporter (REPORTER *aReporter)

void	SetProgressReporter (PROGRESS_REPORTER *aReporter)

Protected Attributes
KIWAY *	m_kiway

REPORTER *	m_reporter

PROGRESS_REPORTER *	m_progressReporter

Private Member Functions
int	doSymExportSvg (JOB_SYM_EXPORT_SVG aSvgJob, SCH_RENDER_SETTINGS aRenderSettings, LIB_SYMBOL *symbol)

DS_PROXY_VIEW_ITEM *	getDrawingSheetProxyView (SCHEMATIC *aSch)

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

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 71 of file eeschema_jobs_handler.cpp.

References JobExportBom(), JobExportNetlist(), JobExportPlot(), JobExportPythonBom(), JobSchErc(), JobSymExportSvg(), JobSymUpgrade(), and JOB_DISPATCHER::Register().

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 674 of file eeschema_jobs_handler.cpp.

References _, PAGE_INFO::Custom, SVG_PLOTTER::EndPlot(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, LIB_SYMBOL::Flatten(), BOX2< Vec >::GetCenter(), BOX2< Vec >::GetHeight(), PAGE_INFO::GetHeightIU(), LIB_SYMBOL::GetName(), LIB_SYMBOL::GetRootSymbol(), LIB_SYMBOL::GetUnitCount(), BOX2< Vec >::GetWidth(), PAGE_INFO::GetWidthIU(), LIB_SYMBOL::HasAlternateBodyStyle(), LIB_SYMBOL::IsAlias(), EDA_IU_SCALE::IU_PER_MILS, EDA_IU_SCALE::IUToMils(), 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(), REPORTER::Report(), 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(), and FILEEXT::SVGFileExtension.

Referenced by JobSymExportSvg().

◆ getDrawingSheetProxyView()

DS_PROXY_VIEW_ITEM * EESCHEMA_JOBS_HANDLER::getDrawingSheetProxyView ( SCHEMATIC * aSch )

private

◆ 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 92 of file eeschema_jobs_handler.cpp.

References _, SETTINGS_MANAGER::GetColorSettings(), SCHEMATIC::GetEmbeddedFiles(), PGM_BASE::GetSettingsManager(), DS_DATA_MODEL::GetTheInstance(), SCH_RENDER_SETTINGS::LoadColors(), DS_DATA_MODEL::LoadDrawingSheet(), 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_TextOffsetRatio, SCHEMATIC_SETTINGS::m_TextOffsetRatio, path, Pgm(), SCHEMATIC::Prj(), REPORTER::Report(), 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 354 of file eeschema_jobs_handler.cpp.

References _, FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyBomPreset(), PROJECT::ApplyTextVars(), SCHEMATIC::BuildUnorderedSheetList(), BOM_PRESET::BuiltInPresets(), BOM_FMT_PRESET::BuiltInPresets(), copy, FILEEXT::CsvFileExtension, erc, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, BOM_PRESET::excludeDNP, FIELDS_EDITOR_GRID_DATA_MODEL::Export(), BOM_FMT_PRESET::fieldDelimiter, BOM_PRESET::fieldsOrdered, BOM_PRESET::filterString, SCH_REFERENCE_LIST::GetCount(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), SCH_SYMBOL::GetFieldCount(), SCH_SYMBOL::GetFields(), FIELDS_EDITOR_GRID_DATA_MODEL::GetFieldsOrdered(), SCHEMATIC::GetFileName(), SCH_SHEET_LIST::GetSymbols(), TEMPLATES::GetTemplateFieldNames(), GetTextVars(), JOB::GetVarOverrides(), BOM_FIELD::groupBy, BOM_PRESET::groupSymbols, BOM_PRESET::includeExcludedFromBOM, IsTextVar(), BOM_FMT_PRESET::keepLineBreaks, BOM_FMT_PRESET::keepTabs, BOM_FIELD::label, EESCHEMA_HELPERS::LoadSchematic(), 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_includeExcludedFromBOM, JOB_EXPORT_SCH_BOM::m_keepLineBreaks, JOB_EXPORT_SCH_BOM::m_keepTabs, JOB_EXPORT_SCH_BOM::m_outputFile, 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::Prj(), BOM_FMT_PRESET::refDelimiter, BOM_FMT_PRESET::refRangeDelimiter, REPORTER::Report(), res, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, SCHEMATIC::Settings(), 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 243 of file eeschema_jobs_handler.cpp.

References _, JOB_EXPORT_SCH_NETLIST::ALLEGRO, SCHEMATIC::BuildUnorderedSheetList(), JOB_EXPORT_SCH_NETLIST::CADSTAR, FILEEXT::CadstarNetlistFileExtension, SCH_REFERENCE_LIST::CheckAnnotation(), erc, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, JOB_EXPORT_SCH_NETLIST::format, SCH_REFERENCE_LIST::GetCount(), SCHEMATIC::GetFileName(), SCH_SHEET_LIST::GetSymbols(), JOB_EXPORT_SCH_NETLIST::KICADSEXPR, JOB_EXPORT_SCH_NETLIST::KICADXML, EESCHEMA_HELPERS::LoadSchematic(), JOB_EXPORT_SCH_NETLIST::m_filename, JOB_EXPORT_SCH_NETLIST::m_outputFile, 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, REPORTER::Report(), res, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, 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 145 of file eeschema_jobs_handler.cpp.

References _, PROJECT::ApplyTextVars(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, JOB::GetVarOverrides(), InitRenderSettings(), EESCHEMA_HELPERS::LoadSchematic(), JOB_EXPORT_SCH_PLOT::m_blackAndWhite, SCH_PLOT_OPTS::m_blackAndWhite, JOB_EXPORT_SCH_PLOT::m_drawingSheet, JOB_EXPORT_SCH_PLOT::m_filename, JOB_EXPORT_SCH_PLOT::m_HPGLPaperSizeSelect, SCH_PLOT_OPTS::m_HPGLPaperSizeSelect, JOB_EXPORT_SCH_PLOT::m_HPGLPenSize, SCH_PLOT_OPTS::m_HPGLPenSize, JOB_EXPORT_SCH_PLOT::m_HPGLPlotOrigin, SCH_PLOT_OPTS::m_HPGLPlotOrigin, JOB_EXPORT_SCH_PLOT::m_outputDirectory, SCH_PLOT_OPTS::m_outputDirectory, JOB_EXPORT_SCH_PLOT::m_outputFile, SCH_PLOT_OPTS::m_outputFile, JOB_EXPORT_SCH_PLOT::m_pageSizeSelect, SCH_PLOT_OPTS::m_pageSizeSelect, 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, JOB_EXPORT_SCH_PLOT::m_plotPages, SCH_PLOT_OPTS::m_plotPages, JOB_DISPATCHER::m_reporter, JOB_EXPORT_SCH_PLOT::m_theme, SCH_PLOT_OPTS::m_theme, JOB_EXPORT_SCH_PLOT::m_useBackgroundColor, SCH_PLOT_OPTS::m_useBackgroundColor, CLI::EXIT_CODES::OK, SCHEMATIC::Prj(), REPORTER::Report(), and RPT_SEVERITY_ERROR.

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobExportPythonBom()

int EESCHEMA_JOBS_HANDLER::JobExportPythonBom ( JOB * aJob )

◆ JobSchErc()

int EESCHEMA_JOBS_HANDLER::JobSchErc ( JOB * aJob )

Definition at line 959 of file eeschema_jobs_handler.cpp.

References _, PROJECT::ApplyTextVars(), 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, getDrawingSheetProxyView(), SCHEMATIC::GetFileName(), JOB::GetVarOverrides(), JOB_SCH_ERC::INCHES, JOB_SCH_ERC::JSON, FILEEXT::JsonFileExtension, KIWAY::KiFACE(), EESCHEMA_HELPERS::LoadSchematic(), JOB_SCH_ERC::m_exitCodeViolations, JOB_SCH_ERC::m_filename, JOB_SCH_ERC::m_format, JOB_DISPATCHER::m_kiway, JOB_SCH_ERC::m_outputFile, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, JOB_SCH_ERC::m_severity, JOB_SCH_ERC::m_units, JOB_SCH_ERC::MILLIMETERS, JOB_SCH_ERC::MILS, SCHEMATIC::Prj(), REPORTER::Report(), FILEEXT::ReportFileExtension, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, ERC_TESTER::RunTests(), 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 798 of file eeschema_jobs_handler.cpp.

References _, DEFAULT_LINE_WIDTH_MILS, doSymExportSvg(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_UNKNOWN, SETTINGS_MANAGER::GetColorSettings(), PGM_BASE::GetSettingsManager(), SCH_IO_LIB_CACHE::GetSymbol(), SCH_IO_LIB_CACHE::GetSymbolMap(), EDA_IU_SCALE::IU_PER_MILS, 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_reporter, SCH_RENDER_SETTINGS::m_ShowHiddenFields, SCH_RENDER_SETTINGS::m_ShowHiddenPins, JOB_SYM_EXPORT_SVG::m_symbol, CLI::EXIT_CODES::OK, Pgm(), REPORTER::Report(), RPT_SEVERITY_ERROR, schIUScale, and KIGFX::RENDER_SETTINGS::SetDefaultPenWidth().

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobSymUpgrade()

int EESCHEMA_JOBS_HANDLER::JobSymUpgrade ( JOB * aJob )

◆ Register()

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

inherited

Definition at line 35 of file job_dispatcher.cpp.

References JOB_DISPATCHER::m_jobHandlers.

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

◆ RunJob()

int JOB_DISPATCHER::RunJob ( JOB * job )

inherited

Definition at line 42 of file job_dispatcher.cpp.

References CLI::EXIT_CODES::ERR_UNKNOWN, JOB::GetType(), and JOB_DISPATCHER::m_jobHandlers.

◆ SetProgressReporter()

void JOB_DISPATCHER::SetProgressReporter ( PROGRESS_REPORTER * aReporter )

inherited

Definition at line 60 of file job_dispatcher.cpp.

References JOB_DISPATCHER::m_progressReporter.

◆ SetReporter()

void JOB_DISPATCHER::SetReporter ( REPORTER * aReporter )

inherited

Definition at line 53 of file job_dispatcher.cpp.

References JOB_DISPATCHER::m_reporter.

Member Data Documentation

◆ m_jobHandlers

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

privateinherited

Definition at line 49 of file job_dispatcher.h.

Referenced by JOB_DISPATCHER::Register(), and JOB_DISPATCHER::RunJob().

◆ m_kiway

KIWAY* JOB_DISPATCHER::m_kiway

protectedinherited

Definition at line 44 of file job_dispatcher.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), and JobSchErc().

◆ m_progressReporter

PROGRESS_REPORTER* JOB_DISPATCHER::m_progressReporter

protectedinherited

Definition at line 46 of file job_dispatcher.h.

Referenced by JOB_DISPATCHER::JOB_DISPATCHER(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), JobSchErc(), and JOB_DISPATCHER::SetProgressReporter().

◆ m_reporter

REPORTER* JOB_DISPATCHER::m_reporter

protectedinherited

Definition at line 45 of file job_dispatcher.h.

Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), doSymExportSvg(), InitRenderSettings(), JOB_DISPATCHER::JOB_DISPATCHER(), JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), JobSchErc(), JobSymExportSvg(), JobSymUpgrade(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), and JOB_DISPATCHER::SetReporter().

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

EESCHEMA_JOBS_HANDLER
Generated on Thu Jul 18 2024 00:05:06 for KiCad PCB EDA Suite by 1.9.6