KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
PCBNEW_JOBS_HANDLER Class Reference

#include <pcbnew_jobs_handler.h>

Inheritance diagram for PCBNEW_JOBS_HANDLER:
JOB_DISPATCHER

Public Member Functions

 PCBNEW_JOBS_HANDLER (KIWAY *aKiway)
 
virtual ~PCBNEW_JOBS_HANDLER ()
 
int JobExportBom (JOB *aJob)
 
int JobExportStep (JOB *aJob)
 
int JobExportRender (JOB *aJob)
 
int JobExportSvg (JOB *aJob)
 
int JobExportDxf (JOB *aJob)
 
int JobExportPdf (JOB *aJob)
 
int JobExportPng (JOB *aJob)
 
int JobExportPs (JOB *aJob)
 
int JobExportGerber (JOB *aJob)
 
int JobExportGerbers (JOB *aJob)
 
int JobExportGencad (JOB *aJob)
 
int JobExportSpecctraDsn (JOB *aJob)
 
int JobExportDrill (JOB *aJob)
 
int JobExportPos (JOB *aJob)
 
int JobExportFpUpgrade (JOB *aJob)
 
int JobExportFpSvg (JOB *aJob)
 
int JobExportDrc (JOB *aJob)
 
int JobExportIpc2581 (JOB *aJob)
 
int JobExportOdb (JOB *aJob)
 
int JobExportIdf (JOB *aJob)
 
int JobExportIpcD356 (JOB *aJob)
 
int JobExportStats (JOB *aJob)
 
int JobExportStackup (JOB *aJob)
 
int JobUpgrade (JOB *aJob)
 
int JobDowngrade (JOB *aJob)
 
int JobImport (JOB *aJob)
 
int JobDiff (JOB *aJob)
 
int JobFpDiff (JOB *aJob)
 
int RunMerge (KICAD_DIFF::DOC_KIND aKind, const wxString &aAncestor, const wxString &aOurs, const wxString &aTheirs, const wxString &aOutput, bool aInteractive, bool aSingleFile, REPORTER *aReporter)
 Non-job entry points (reached via the kiface KIFACE_MERGE_DOCUMENT / KIFACE_OPEN_DIFF_DIALOG function exports, not the JOB system).
 
int OpenDiffDialog (KICAD_DIFF::DOC_KIND aKind, const wxString &aFileA, const wxString &aFileB, const wxString &aLabelA, const wxString &aLabelB, wxWindow *aParent, REPORTER *aReporter)
 
KICAD_DIFF::DIFF_CANVAS_CONTEXT * AttachDiffCanvases (KICAD_DIFF::DOC_KIND aKind, const wxString &aFileA, const wxString &aFileB, WIDGET_DIFF_CANVAS *aBefore, WIDGET_DIFF_CANVAS *aAfter, KICAD_DIFF::DOCUMENT_DIFF &aDiff, REPORTER *aReporter)
 Diff two boards for a window outside the kiface, drawing the first on aBefore and the second on aAfter.
 
void ClearCachedBoard ()
 Clear the cached CLI board so the next job reloads from the current project.
 
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

int runPcbMerge (const wxString &aAncestor, const wxString &aOurs, const wxString &aTheirs, const wxString &aOutput, bool aInteractive)
 
int runFpLibMerge (const wxString &aAncestor, const wxString &aOurs, const wxString &aTheirs, const wxString &aOutput, bool aSingleFile)
 
BOARD * getBoard (const wxString &aPath=wxEmptyString)
 
void refillFabZones (const JOB_EXPORT_PCB_FAB &aJob, BOARD *aBoard)
 
LSEQ convertLayerArg (wxString &aLayerString, BOARD *aBoard) const
 
bool preparePlotLayers (JOB_EXPORT_PCB_PLOT *aJob, BOARD *aBoard, TOOL_MANAGER *aToolManager)
 
wxString resolvePlotOutputPath (JOB_EXPORT_PCB_PLOT *aJob, BOARD *aBoard, PLOT_FORMAT aFormat, bool aSingleOutput)
 
void populateGerberPlotOptionsFromJob (PCB_PLOT_PARAMS &aPlotOpts, JOB_EXPORT_PCB_GERBER *aJob)
 
void populateGerberPlotOptionsFromJob (PCB_PLOT_PARAMS &aPlotOpts, JOB_EXPORT_PCB_GERBERS *aJob)
 
int doFpExportSvg (JOB_FP_EXPORT_SVG *aSvgJob, const FOOTPRINT *aFootprint)
 
void loadOverrideDrawingSheet (BOARD *brd, const wxString &aSheetPath)
 
wxString resolveJobOutputPath (JOB *aJob, BOARD *aBoard, const wxString *aDrawingSheet=nullptr)
 
DS_PROXY_VIEW_ITEM * getDrawingSheetProxyView (BOARD *aBrd)
 
TOOL_MANAGER * getToolManager (BOARD *aBrd)
 

Private Attributes

std::unique_ptr< BOARD > m_cliBoard
 
std::unique_ptr< TOOL_MANAGER > m_toolManager
 
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

Definition at line 49 of file pcbnew_jobs_handler.h.

Constructor & Destructor Documentation

◆ PCBNEW_JOBS_HANDLER()

PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER ( KIWAY * aKiway)

Definition at line 169 of file pcbnew_jobs_handler.cpp.

References _, DisplayErrorMessage(), CLI::EXIT_CODES::ERR_ARGS, FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), JOB_EXPORT_PCB_GENCAD::GetSettingsDialogTitle(), JOB_DISPATCHER::JOB_DISPATCHER(), JobDiff(), JobDowngrade(), JobExportBom(), JobExportDrc(), JobExportDrill(), JobExportDxf(), JobExportFpSvg(), JobExportFpUpgrade(), JobExportGencad(), JobExportGerber(), JobExportGerbers(), JobExportIdf(), JobExportIpc2581(), JobExportIpcD356(), JobExportOdb(), JobExportPdf(), JobExportPng(), JobExportPos(), JobExportPs(), JobExportRender(), JobExportSpecctraDsn(), JobExportStackup(), JobExportStats(), JobExportStep(), JobExportSvg(), JobFpDiff(), JobImport(), JobUpgrade(), m_cliBoard, JOB_EXPORT_PCB_STACKUP::m_filename, JOB_EXPORT_PCB_STATS::m_filename, JOB_DISPATCHER::m_reporter, m_toolManager, KIWAY::Player(), JOB_DISPATCHER::Register(), RPT_SEVERITY_ERROR, DIALOG_SHIM::ShowModal(), and DIALOG_FOOTPRINT_FIELDS_TABLE::WasAborted().

◆ ~PCBNEW_JOBS_HANDLER()

PCBNEW_JOBS_HANDLER::~PCBNEW_JOBS_HANDLER ( )
virtual

Definition at line 502 of file pcbnew_jobs_handler.cpp.

Member Function Documentation

◆ AttachDiffCanvases()

KICAD_DIFF::DIFF_CANVAS_CONTEXT * PCBNEW_JOBS_HANDLER::AttachDiffCanvases ( KICAD_DIFF::DOC_KIND aKind,
const wxString & aFileA,
const wxString & aFileB,
WIDGET_DIFF_CANVAS * aBefore,
WIDGET_DIFF_CANVAS * aAfter,
KICAD_DIFF::DOCUMENT_DIFF & aDiff,
REPORTER * aReporter )

Diff two boards for a window outside the kiface, drawing the first on aBefore and the second on aAfter.

The result keeps both loaded while the canvases show them.

Definition at line 4834 of file pcbnew_jobs_handler.cpp.

References KICAD_DIFF::ConfigurePcbDiffCanvasContext(), loadPcbDiffSides(), JOB_DISPATCHER::m_reporter, KICAD_DIFF::PCB, Pgm(), KICAD_DIFF::DIFF_COLOR_THEME::reference, and CLI::EXIT_CODES::SUCCESS.

◆ ClearCachedBoard()

void PCBNEW_JOBS_HANDLER::ClearCachedBoard ( )

Clear the cached CLI board so the next job reloads from the current project.

Called when the API server switches documents.

Definition at line 507 of file pcbnew_jobs_handler.cpp.

References m_cliBoard, and m_toolManager.

◆ convertLayerArg()

LSEQ PCBNEW_JOBS_HANDLER::convertLayerArg ( wxString & aLayerString,
BOARD * aBoard ) const
private

Definition at line 632 of file pcbnew_jobs_handler.cpp.

References _, LSET::AllCuMask(), LSET::AllLayersMask(), B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, BOARD::GetLayerName(), LSET::InternalCuMask(), LayerName(), JOB_DISPATCHER::m_reporter, LSET::Name(), and TO_UTF8.

Referenced by JobExportFpSvg(), JobExportGerber(), JobExportGerbers(), and preparePlotLayers().

◆ doFpExportSvg()

int PCBNEW_JOBS_HANDLER::doFpExportSvg ( JOB_FP_EXPORT_SVG * aSvgJob,
const FOOTPRINT * aFootprint )
private

Definition at line 2817 of file pcbnew_jobs_handler.cpp.

References _, JOB::AddOutput(), CLI::EXIT_CODES::ERR_UNKNOWN, FOOTPRINT::GetFPID(), JOB::GetFullOutputPath(), LIB_ID::GetLibItemName(), JOB::GetVarOverrides(), JOB_EXPORT_PCB_PLOT::m_plotLayerSequence, JOB_EXPORT_PCB_PLOT::m_plotOnAllLayersSequence, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, Pgm(), PlotFootprintToSVG(), PCB_PLOTTER::PlotJobToPlotOpts(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, FILEEXT::SVGFileExtension, and UTF8::wx_str().

Referenced by JobExportFpSvg().

◆ getBoard()

BOARD * PCBNEW_JOBS_HANDLER::getBoard ( const wxString & aPath = wxEmptyString)
private

Definition at line 540 of file pcbnew_jobs_handler.cpp.

References _, PCB_IO_MGR::FILE_TYPE_NONE, PCB_IO_MGR::FindPluginTypeFromBoardPath(), FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), SETTINGS_MANAGER::GetProject(), PROJECT::GetProjectFullName(), PGM_BASE::GetSettingsManager(), FILEEXT::KiCadPcbFileExtension, KICTL_KICAD_ONLY, BOARD_LOADER::Load(), SETTINGS_MANAGER::LoadProject(), m_cliBoard, JOB_DISPATCHER::m_kiway, JOB_DISPATCHER::m_reporter, path, Pgm(), SETTINGS_MANAGER::Prj(), project, FILEEXT::ProjectFileExtension, RPT_SEVERITY_ERROR, and IO_ERROR::What().

Referenced by JobExportBom(), JobExportDrc(), JobExportDrill(), JobExportDxf(), JobExportGencad(), JobExportGerber(), JobExportGerbers(), JobExportIdf(), JobExportIpc2581(), JobExportIpcD356(), JobExportOdb(), JobExportPdf(), JobExportPng(), JobExportPos(), JobExportPs(), JobExportRender(), JobExportSpecctraDsn(), JobExportStackup(), JobExportStats(), JobExportStep(), JobExportSvg(), and JobUpgrade().

◆ getDrawingSheetProxyView()

DS_PROXY_VIEW_ITEM * PCBNEW_JOBS_HANDLER::getDrawingSheetProxyView ( BOARD * aBrd)
private

Definition at line 3708 of file pcbnew_jobs_handler.cpp.

References BOARD::GetCurrentVariant(), BOARD::GetFileName(), BOARD::GetPageSettings(), BOARD::GetProject(), BOARD::GetProperties(), BOARD::GetTitleBlock(), BOARD::GetVariantDescription(), pcbIUScale, DS_PROXY_VIEW_ITEM::SetFileName(), DS_PROXY_VIEW_ITEM::SetIsFirstPage(), DS_PROXY_VIEW_ITEM::SetSheetName(), DS_PROXY_VIEW_ITEM::SetSheetPath(), DS_PROXY_VIEW_ITEM::SetVariantDesc(), DS_PROXY_VIEW_ITEM::SetVariantName(), and TO_UTF8.

Referenced by JobExportDrc().

◆ getToolManager()

TOOL_MANAGER * PCBNEW_JOBS_HANDLER::getToolManager ( BOARD * aBrd)
private

Definition at line 514 of file pcbnew_jobs_handler.cpp.

References FRAME_PCB_EDITOR, TOOLS_HOLDER::GetToolManager(), Kiface(), JOB_DISPATCHER::m_kiway, m_toolManager, Pgm(), and TOOL_MANAGER::SetEnvironment().

Referenced by JobExportDrc(), JobExportDxf(), JobExportGerber(), JobExportGerbers(), JobExportPdf(), JobExportPng(), JobExportPs(), JobExportSvg(), and refillFabZones().

◆ 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.

◆ JobDiff()

int PCBNEW_JOBS_HANDLER::JobDiff ( JOB * aJob)

Definition at line 4261 of file pcbnew_jobs_handler.cpp.

References _, KICAD_DIFF::DIFF_EMIT_OPTIONS::comparisonGeometry, KICAD_DIFF::PCB_DIFFER::Diff(), KICAD_DIFF::DiffExitCode(), SCRATCH_DOC< DOC >::doc, KICAD_DIFF::DIFF_EMIT_OPTIONS::docKind, KICAD_DIFF::EmitDiffResult(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, KICAD_DIFF::ExtractBoardGeometry(), PGM_BASE::GetSettingsManager(), loadScratchBoard(), JOB_DIFF_BASE::m_exitCodeOnly, JOB_DIFF_BASE::m_inputA, JOB_DIFF_BASE::m_inputB, JOB_DISPATCHER::m_reporter, KICAD_DIFF::MakeEmitOptions(), KICAD_DIFF::PCB, Pgm(), KICAD_DIFF::DIFF_EMIT_OPTIONS::referenceGeometry, result, and RPT_SEVERITY_ERROR.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobDowngrade()

int PCBNEW_JOBS_HANDLER::JobDowngrade ( JOB * aJob)

Definition at line 3410 of file pcbnew_jobs_handler.cpp.

References _, ClassifyBoardForDowngrade(), classifyFootprintLibraries(), DOWNGRADE_FILE_TRANSACTION::Commit(), DOWNGRADE_OUTPUT_DIRECTORIES::Commit(), CopyDowngradeLibraryDirectory(), DOWNGRADE_OUTPUT_DIRECTORIES::Create(), downgradeFootprintLibraries(), DowngradeLibraryCopyPath(), DowngradeTargetNames(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, ExportBoardToOlderVersion(), FindDowngradeTarget(), FIRST_PCB_VARIANTS, FlattenBoardVariant(), footprintRefusedMessage(), GetDowngradeTargets(), DOWNGRADE_FILE_TRANSACTION::GetRecoveryError(), COMPATIBILITY_REPORT::IsBlocked(), COMPATIBILITY_REPORT::IsLossy(), PCB_IO::LoadBoard(), DOWNGRADE_TARGET::m_boardVersion, JOB_PCB_DOWNGRADE::m_dropInsteadOfApproximate, JOB_PCB_DOWNGRADE::m_dryRun, JOB_PCB_DOWNGRADE::m_filename, JOB_PCB_DOWNGRADE::m_force, JOB_PCB_DOWNGRADE::m_inPlace, JOB_PCB_DOWNGRADE::m_libraryDir, DOWNGRADE_TARGET::m_name, JOB_PCB_DOWNGRADE::m_outputFile, JOB_PCB_DOWNGRADE::m_report, JOB_DISPATCHER::m_reporter, JOB_PCB_DOWNGRADE::m_target, JOB_PCB_DOWNGRADE::m_variant, COMPATIBILITY_REPORT::Print(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, RPT_SEVERITY_WARNING, DOWNGRADE_FILE_TRANSACTION::Stage(), CLI::EXIT_CODES::SUCCESS, ValidateDowngradeLibraryCopy(), ValidateDowngradeLibrarySource(), ValidateFreshDowngradeOutput(), and IO_ERROR::What().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportBom()

int PCBNEW_JOBS_HANDLER::JobExportBom ( JOB * aJob)

Definition at line 699 of file pcbnew_jobs_handler.cpp.

References _, FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::AddColumn(), JOB::AddOutput(), FIELDS_TABLE_DATA_MODEL_BASE::ApplyBomPreset(), PROJECT::ApplyTextVars(), BOM_FMT_PRESET::BuiltInPresets(), FILEEXT::CsvFileExtension, PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, ExpandVariantOutputPath(), FIELDS_TABLE_DATA_MODEL_BASE::Export(), BOM_FMT_PRESET::fieldDelimiter, BOARD::Footprints(), getBoard(), JOB::GetConfiguredOutputPath(), GetDefaultFieldName(), BOARD::GetDesignSettings(), FIELDS_TABLE_DATA_MODEL_BASE::GetFieldNameCol(), FOOTPRINT::GetFields(), FIELDS_TABLE_DATA_MODEL_BASE::GetFieldsOrdered(), BOARD::GetFileName(), JOB::GetFullOutputPath(), GetGeneratedFieldDisplayName(), BOARD::GetProject(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetReferenceList(), JOB_EXPORT_BOM::GetSelectedVariant(), BOARD::GetTitleBlock(), JOB::GetVarOverrides(), BOM_FIELD::groupBy, BOM_FMT_PRESET::includeByteOrderMark, IsGeneratedField(), FIELDS_TABLE_DATA_MODEL_BASE::ITEM_NUMBER_VARIABLE, BOM_FMT_PRESET::keepLineBreaks, BOM_FMT_PRESET::keepTabs, BOM_FIELD::label, JOB_EXPORT_BOM::m_bomFmtPresetName, FIELDS_TABLE_BOM_SETTINGS::m_BomFmtPresets, JOB_EXPORT_BOM::m_bomPresetName, FIELDS_TABLE_BOM_SETTINGS::m_BomPresets, JOB_EXPORT_BOM::m_excludeDNP, JOB_EXPORT_BOM::m_fieldDelimiter, JOB_EXPORT_BOM::m_fieldsGroupBy, JOB_EXPORT_BOM::m_fieldsLabels, JOB_EXPORT_BOM::m_fieldsOrdered, JOB_EXPORT_BOM::m_filename, JOB_EXPORT_BOM::m_filterScope, JOB_EXPORT_BOM::m_filterString, JOB_EXPORT_BOM::m_groupSymbols, JOB_EXPORT_BOM::m_includeByteOrderMark, JOB_EXPORT_BOM::m_keepLineBreaks, JOB_EXPORT_BOM::m_keepTabs, JOB_EXPORT_BOM::m_refDelimiter, JOB_EXPORT_BOM::m_refRangeDelimiter, JOB_DISPATCHER::m_reporter, JOB_EXPORT_BOM::m_sortAsc, JOB_EXPORT_BOM::m_sortField, JOB_EXPORT_BOM::m_stringDelimiter, JOB_EXPORT_BOM::m_variantNames, MANDATORY_FIELDS, BOM_FIELD::name, CLI::EXIT_CODES::OK, FIELDS_TABLE_DATA_MODEL_BASE::QUANTITY_VARIABLE, BOM_FMT_PRESET::refDelimiter, BOM_FMT_PRESET::refRangeDelimiter, res, RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, JOB::SetConfiguredOutputPath(), BOARD::SetCurrentVariant(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::SetCurrentVariant(), JOB::SetTitleBlock(), FIELDS_TABLE_DATA_MODEL_BASE::SetVariantNames(), BOM_FIELD::show, BOM_FMT_PRESET::stringDelimiter, TRANSLATED, UNTRANSLATED, and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportDrc()

int PCBNEW_JOBS_HANDLER::JobExportDrc ( JOB * aJob)

Definition at line 2845 of file pcbnew_jobs_handler.cpp.

References _, COMMIT::Add(), JOB::AddOutput(), LIBRARY_MANAGER_ADAPTER::AsyncLoad(), LIBRARY_MANAGER_ADAPTER::BlockUntilLoaded(), checkParity(), BOARD::DeleteMARKERs(), eeschema, 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_SCH, TOOL_MANAGER::FindTool(), PROJECT_PCB::FootprintLibAdapter(), FRAME_SCH, getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetDesignRulesPath(), BOARD::GetDesignSettings(), getDrawingSheetProxyView(), BOARD::GetFileName(), BOARD::GetProject(), TOOL_MANAGER::GetTool(), getToolManager(), INCH, JOB_RC::INCH, JOB_RC::JSON, FILEEXT::JsonFileExtension, FILEEXT::KiCadSchematicFileExtension, KIFACE_NETLIST_SCHEMATIC, FILEEXT::LegacySchematicFileExtension, KICAD_NETLIST_READER::LoadNetlist(), BOARD_DESIGN_SETTINGS::m_DRCEngine, JOB_RC::m_exitCodeViolations, JOB_RC::m_filename, JOB_RC::m_format, JOB_DISPATCHER::m_kiway, JOB_PCB_DRC::m_parity, JOB_DISPATCHER::m_progressReporter, JOB_PCB_DRC::m_refillZones, JOB_PCB_DRC::m_reportAllTrackErrors, JOB_DISPATCHER::m_reporter, JOB_PCB_DRC::m_saveBoard, JOB_RC::m_severity, JOB_RC::m_units, MAIL_SCH_GET_NETLIST, MAIL_SCH_GET_NETLIST_CANCELLED, MARKER_BASE::MARKER_DRAWING_SHEET, MARKER_BASE::MARKER_DRC, MARKER_BASE::MARKER_PARITY, MARKER_BASE::MARKER_RATSNEST, MILS, JOB_RC::MILS, MM, JOB_RC::MM, netlist, BOARD_COMMIT::Push(), BOARD::RecordDRCExclusions(), TOOL_MANAGER::RegisterTool(), FILEEXT::ReportFileExtension, BOARD::ResolveDRCExclusions(), resolveJobOutputPath(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, BOARD_LOADER::SaveBoard(), JOB::SetWorkingOutputPath(), SKIP_SET_DIRTY, SKIP_UNDO, CLI::EXIT_CODES::SUCCESS, IO_ERROR::What(), DRC_REPORT::WriteJsonReport(), DRC_REPORT::WriteTextReport(), and ZONE_FILLER_TOOL_NAME.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportDrill()

int PCBNEW_JOBS_HANDLER::JobExportDrill ( JOB * aJob)

Definition at line 2316 of file pcbnew_jobs_handler.cpp.

References _, JOB_EXPORT_PCB_DRILL::ABS, JOB::AddOutput(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), GERBER_WRITER::CreateDrillandMapFilesSet(), JOB_EXPORT_PCB_DRILL::DECIMAL, GENDRILL_WRITER_BASE::DECIMAL_FORMAT, JOB_EXPORT_PCB_DRILL::DXF, DXF, PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, JOB_EXPORT_PCB_DRILL::EXCELLON, GENDRILL_WRITER_BASE::GenDrillReportFile(), JOB_EXPORT_PCB_DRILL::GERBER, GERBER, JOB_EXPORT_PCB_DRILL::GERBER_X2, BOARD_DESIGN_SETTINGS::GetAuxOrigin(), getBoard(), BOARD::GetDesignSettings(), BOARD::GetFileName(), BOARD::GetProject(), JOB_EXPORT_PCB_DRILL::INCH, GENDRILL_WRITER_BASE::KEEP_ZEROS, JOB_EXPORT_PCB_DRILL::KEEP_ZEROS, JOB_EXPORT_PCB_DRILL::m_drillOrigin, JOB_EXPORT_PCB_DRILL::m_drillUnits, JOB_EXPORT_PCB_DRILL::m_excellonCombinePTHNPTH, JOB_EXPORT_PCB_DRILL::m_excellonMinimalHeader, JOB_EXPORT_PCB_DRILL::m_excellonMirrorY, JOB_EXPORT_PCB_DRILL::m_excellonOvalDrillRoute, JOB_EXPORT_PCB_DRILL::m_filename, JOB_EXPORT_PCB_DRILL::m_format, JOB_EXPORT_PCB_DRILL::m_generateMap, JOB_EXPORT_PCB_DRILL::m_generateReport, JOB_EXPORT_PCB_DRILL::m_generateTenting, JOB_EXPORT_PCB_DRILL::m_gerberPrecision, DRILL_PRECISION::m_Lhs, JOB_EXPORT_PCB_DRILL::m_mapFormat, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_DRILL::m_reportPath, DRILL_PRECISION::m_Rhs, JOB_EXPORT_PCB_DRILL::m_zeroFormat, JOB_EXPORT_PCB_DRILL::MM, CLI::EXIT_CODES::OK, JOB_EXPORT_PCB_DRILL::PDF, PDF, POST, JOB_EXPORT_PCB_DRILL::POSTSCRIPT, precisionListForInches, precisionListForMetric, FILEEXT::ReportFileExtension, resolveJobOutputPath(), JOB::ResolveOutputPath(), RPT_SEVERITY_ERROR, EXCELLON_WRITER::SetFormat(), GERBER_WRITER::SetFormat(), GENDRILL_WRITER_BASE::SetMapFileFormat(), EXCELLON_WRITER::SetOptions(), GERBER_WRITER::SetOptions(), EXCELLON_WRITER::SetRouteModeForOvalHoles(), GENDRILL_WRITER_BASE::SUPPRESS_LEADING, JOB_EXPORT_PCB_DRILL::SUPPRESS_LEADING, GENDRILL_WRITER_BASE::SUPPRESS_TRAILING, JOB_EXPORT_PCB_DRILL::SUPPRESS_TRAILING, JOB_EXPORT_PCB_DRILL::SVG, and SVG.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportDxf()

int PCBNEW_JOBS_HANDLER::JobExportDxf ( JOB * aJob)

Definition at line 1578 of file pcbnew_jobs_handler.cpp.

References _, 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, getBoard(), getToolManager(), JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_DXF::m_genMode, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_PLOT::m_variant, plotJob(), PCB_PLOTTER::PlotJobToPlotOpts(), preparePlotLayers(), resolvePlotOutputPath(), RPT_SEVERITY_ERROR, BOARD::SetCurrentVariant(), and JOB_EXPORT_PCB_DXF::SINGLE.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportFpSvg()

int PCBNEW_JOBS_HANDLER::JobExportFpSvg ( JOB * aJob)

Definition at line 2745 of file pcbnew_jobs_handler.cpp.

References _, LSET::AllLayersMask(), convertLayerArg(), CTL_FOR_LIBRARY, doFpExportSvg(), PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, FP_CACHE::GetFootprints(), JOB::GetFullOutputPath(), FP_CACHE::Load(), JOB_EXPORT_PCB_PLOT::m_argLayers, JOB_FP_EXPORT_SVG::m_footprint, JOB_FP_EXPORT_SVG::m_libraryPath, JOB_EXPORT_PCB_PLOT::m_plotLayerSequence, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, RPT_SEVERITY_ERROR, and LSET::SeqStackupForPlotting().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportFpUpgrade()

int PCBNEW_JOBS_HANDLER::JobExportFpUpgrade ( JOB * aJob)

Definition at line 2653 of file pcbnew_jobs_handler.cpp.

References _, PCB_IO_MGR::ConvertLibrary(), CTL_FOR_LIBRARY, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, fileType(), FP_CACHE::GetFootprints(), PCB_IO_MGR::GuessPluginTypeFromLibPath(), PCB_IO_MGR::KICAD_SEXP, FP_CACHE::Load(), JOB_FP_UPGRADE::m_force, JOB_FP_UPGRADE::m_libraryPath, JOB_FP_UPGRADE::m_outputLibraryPath, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, RPT_SEVERITY_ERROR, FP_CACHE::Save(), FP_CACHE::SetPath(), and SEXPR_BOARD_FILE_VERSION.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportGencad()

int PCBNEW_JOBS_HANDLER::JobExportGencad ( JOB * aJob)

Definition at line 1917 of file pcbnew_jobs_handler.cpp.

References _, JOB::AddOutput(), PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, GENCAD_EXPORTER::FlipBottomPads(), FILEEXT::GencadFileExtension, BOARD_DESIGN_SETTINGS::GetAuxOrigin(), getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetDesignSettings(), BOARD::GetFileName(), JOB_EXPORT_PCB_GENCAD::m_filename, JOB_EXPORT_PCB_GENCAD::m_flipBottomPads, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_GENCAD::m_storeOriginCoords, JOB_EXPORT_PCB_GENCAD::m_useDrillOrigin, JOB_EXPORT_PCB_GENCAD::m_useIndividualShapes, JOB_EXPORT_PCB_GENCAD::m_useUniquePins, CLI::EXIT_CODES::OK, resolveJobOutputPath(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, GENCAD_EXPORTER::SetPlotOffet(), JOB::SetWorkingOutputPath(), GENCAD_EXPORTER::StoreOriginCoordsInFile(), GENCAD_EXPORTER::UseIndividualShapes(), GENCAD_EXPORTER::UsePinNamesUnique(), GENCAD_EXPORTER::WriteFile(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER().

◆ JobExportGerber()

int PCBNEW_JOBS_HANDLER::JobExportGerber ( JOB * aJob)

Definition at line 2205 of file pcbnew_jobs_handler.cpp.

References _, convertLayerArg(), PLOTTER::EndPlot(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, TOOL_MANAGER::FindTool(), GERBER, getBoard(), JOB::GetConfiguredOutputPath(), GetDefaultPlotExtension(), BOARD::GetFileName(), BOARD::GetLayerName(), TOOL_MANAGER::GetTool(), getToolManager(), JOB::GetVarOverrides(), JOB_EXPORT_PCB_PLOT::m_argCommonLayers, JOB_EXPORT_PCB_PLOT::m_argLayers, JOB_EXPORT_PCB_PLOT::m_checkZonesBeforePlot, JOB_EXPORT_PCB_PLOT::m_drawingSheet, JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PLOT::m_plotLayerSequence, JOB_EXPORT_PCB_PLOT::m_plotOnAllLayersSequence, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_PLOT::m_variant, CLI::EXIT_CODES::OK, PlotBoardLayers(), PCB_PLOTTER::PlotJobToPlotOpts(), RefreshGeneratedTables(), TOOL_MANAGER::RegisterTool(), resolveJobOutputPath(), RPT_SEVERITY_ERROR, BOARD::SetCurrentVariant(), PCB_PLOT_PARAMS::SetLayerSelection(), PCB_PLOT_PARAMS::SetPlotOnAllLayersSequence(), JOB::SetWorkingOutputPath(), StartPlotBoard(), UNDEFINED_LAYER, and ZONE_FILLER_TOOL_NAME.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportGerbers()

int PCBNEW_JOBS_HANDLER::JobExportGerbers ( JOB * aJob)

Definition at line 1738 of file pcbnew_jobs_handler.cpp.

References _, GERBER_JOBFILE_WRITER::AddGbrFile(), JOB::AddOutput(), LSET::AllCuMask(), LSET::AllLayersMask(), LSET::AllNonCuMask(), PCB_PLOTTER::BuildPlotFileName(), convertLayerArg(), GERBER_JOBFILE_WRITER::CreateJobFile(), GERBER_PLOTTER::EndPlot(), PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, find, TOOL_MANAGER::FindTool(), FILEEXT::GerberFileExtension, FILEEXT::GerberJobFileExtension, getBoard(), BOARD::GetEnabledLayers(), BOARD::GetFileName(), GetGerberProtelExtension(), BOARD::GetLayerName(), PCB_PLOT_PARAMS::GetLayerSelection(), PCB_PLOT_PARAMS::GetPlotOnAllLayersSequence(), BOARD::GetPlotOptions(), TOOL_MANAGER::GetTool(), getToolManager(), PCB_PLOT_PARAMS::GetUseGerberProtelExtensions(), JOB::GetVarOverrides(), JOB_EXPORT_PCB_PLOT::m_argCommonLayers, JOB_EXPORT_PCB_PLOT::m_argLayers, JOB_EXPORT_PCB_PLOT::m_checkZonesBeforePlot, JOB_EXPORT_PCB_GERBERS::m_createJobsFile, JOB_EXPORT_PCB_PLOT::m_drawingSheet, JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PLOT::m_plotLayerSequence, JOB_EXPORT_PCB_PLOT::m_plotOnAllLayersSequence, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_GERBERS::m_useBoardPlotParams, JOB_EXPORT_PCB_PLOT::m_variant, CLI::EXIT_CODES::OK, PlotBoardLayers(), PCB_PLOTTER::PlotJobToPlotOpts(), RefreshGeneratedTables(), TOOL_MANAGER::RegisterTool(), resolveJobOutputPath(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, LSET::SeqStackupForPlotting(), BASE_SET::set(), BOARD::SetCurrentVariant(), StartPlotBoard(), LSET::UIOrder(), and ZONE_FILLER_TOOL_NAME.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportIdf()

int PCBNEW_JOBS_HANDLER::JobExportIdf ( JOB * aJob)

Definition at line 3196 of file pcbnew_jobs_handler.cpp.

References _, PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, IDF_EXPORTER::Export(), PROJECT_PCB::Get3DFilenameResolver(), getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetFileName(), BOARD::GetProject(), FILEEXT::IdfV3BoardFileExtension, JOB_EXPORT_PCB_IDF::m_filename, JOB_DISPATCHER::m_reporter, resolveJobOutputPath(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, JOB::SetWorkingOutputPath(), and CLI::EXIT_CODES::SUCCESS.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportIpc2581()

int PCBNEW_JOBS_HANDLER::JobExportIpc2581 ( JOB * aJob)

Definition at line 3101 of file pcbnew_jobs_handler.cpp.

References _, PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, GenerateIpc2581File(), getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetCurrentVariant(), BOARD::GetFileName(), FILEEXT::Ipc2581FileExtension, JOB_EXPORT_PCB_IPC2581::m_compress, JOB_EXPORT_PCB_FAB::m_filename, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_FAB::m_variantNames, refillFabZones(), resolveJobOutputPath(), RPT_SEVERITY_ERROR, BOARD::SetCurrentVariant(), JOB::SetWorkingOutputPath(), and CLI::EXIT_CODES::SUCCESS.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportIpcD356()

int PCBNEW_JOBS_HANDLER::JobExportIpcD356 ( JOB * aJob)

Definition at line 3149 of file pcbnew_jobs_handler.cpp.

References _, JOB::AddOutput(), PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetFileName(), FILEEXT::IpcD356FileExtension, JOB_EXPORT_PCB_IPCD356::m_filename, JOB_DISPATCHER::m_reporter, resolveJobOutputPath(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, JOB::SetWorkingOutputPath(), CLI::EXIT_CODES::SUCCESS, and IPC356D_WRITER::Write().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportOdb()

int PCBNEW_JOBS_HANDLER::JobExportOdb ( JOB * aJob)

Definition at line 3243 of file pcbnew_jobs_handler.cpp.

References JOB::AddOutput(), FILEEXT::ArchiveFileExtension, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, GenerateODBPPFiles(), getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetFileName(), JOB_EXPORT_PCB_ODB::m_compressionMode, JOB_EXPORT_PCB_FAB::m_filename, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_ODB::NONE, path, refillFabZones(), resolveJobOutputPath(), result, RPT_SEVERITY_ERROR, JOB::SetWorkingOutputPath(), CLI::EXIT_CODES::SUCCESS, JOB_EXPORT_PCB_ODB::TGZ, and JOB_EXPORT_PCB_ODB::ZIP.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportPdf()

int PCBNEW_JOBS_HANDLER::JobExportPdf ( JOB * aJob)

Definition at line 1617 of file pcbnew_jobs_handler.cpp.

References _, JOB_EXPORT_PCB_PDF::ALL_LAYERS_ONE_FILE, 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, getBoard(), getToolManager(), JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PDF::m_pdfGenMode, JOB_EXPORT_PCB_PDF::m_pdfSingle, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_PLOT::m_variant, PDF, plotJob(), PCB_PLOTTER::PlotJobToPlotOpts(), preparePlotLayers(), resolvePlotOutputPath(), RPT_SEVERITY_ERROR, and BOARD::SetCurrentVariant().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER().

◆ JobExportPng()

int PCBNEW_JOBS_HANDLER::JobExportPng ( JOB * aJob)

Definition at line 1660 of file pcbnew_jobs_handler.cpp.

References _, 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, getBoard(), getToolManager(), JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PNG::m_genMode, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_PLOT::m_variant, plotJob(), PCB_PLOTTER::PlotJobToPlotOpts(), PNG, preparePlotLayers(), resolvePlotOutputPath(), RPT_SEVERITY_ERROR, BOARD::SetCurrentVariant(), and JOB_EXPORT_PCB_PNG::SINGLE.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportPos()

int PCBNEW_JOBS_HANDLER::JobExportPos ( JOB * aJob)

Definition at line 2468 of file pcbnew_jobs_handler.cpp.

References _, JOB::AddOutput(), JOB_EXPORT_PCB_POS::ASCII, B_Cu, JOB_EXPORT_PCB_POS::BACK, JOB_EXPORT_PCB_POS::BOTH, PLACEFILE_GERBER_WRITER::CreatePlaceFile(), JOB_EXPORT_PCB_POS::CSV, FILEEXT::CsvFileExtension, PLACE_FILE_EXPORTER::DecorateFilename(), PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, F_Cu, FILEEXT::FootprintPlaceFileExtension, JOB_EXPORT_PCB_POS::FRONT, PLACE_FILE_EXPORTER::GenPositionData(), JOB_EXPORT_PCB_POS::GERBER, FILEEXT::GerberFileExtension, getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetFileName(), PLACEFILE_GERBER_WRITER::GetPlaceFileName(), JOB_EXPORT_PCB_POS::m_excludeBOM, JOB_EXPORT_PCB_POS::m_excludeDNP, JOB_EXPORT_PCB_POS::m_excludeFootprintsWithTh, JOB_EXPORT_PCB_POS::m_filename, JOB_EXPORT_PCB_POS::m_format, JOB_EXPORT_PCB_POS::m_gerberBoardEdge, JOB_EXPORT_PCB_POS::m_nakedFilename, JOB_EXPORT_PCB_POS::m_negateBottomX, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_POS::m_side, JOB_EXPORT_PCB_POS::m_singleFile, JOB_EXPORT_PCB_POS::m_smdOnly, JOB_EXPORT_PCB_POS::m_units, JOB_EXPORT_PCB_POS::m_useDrillPlaceFileOrigin, JOB_EXPORT_PCB_POS::m_variant, JOB_EXPORT_PCB_POS::MM, CLI::EXIT_CODES::OK, resolveJobOutputPath(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, PLACE_FILE_EXPORTER::SetVariant(), PLACEFILE_GERBER_WRITER::SetVariant(), and JOB::SetWorkingOutputPath().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportPs()

int PCBNEW_JOBS_HANDLER::JobExportPs ( JOB * aJob)

Definition at line 1699 of file pcbnew_jobs_handler.cpp.

References _, 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, getBoard(), getToolManager(), JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PS::m_genMode, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_PLOT::m_variant, plotJob(), PCB_PLOTTER::PlotJobToPlotOpts(), POST, preparePlotLayers(), resolvePlotOutputPath(), RPT_SEVERITY_ERROR, BOARD::SetCurrentVariant(), and JOB_EXPORT_PCB_PS::SINGLE.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportRender()

int PCBNEW_JOBS_HANDLER::JobExportRender ( JOB * aJob)

Definition at line 1185 of file pcbnew_jobs_handler.cpp.

References _, JOB_PCB_RENDER::BACK, JOB_PCB_RENDER::BASIC, BOARD_ADAPTER::BiuTo3dUnits(), JOB_PCB_RENDER::BOTTOM, JOB_PCB_RENDER::DEFAULT, DEG2RAD(), EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::differentiate_plated_copper, 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, EDA_3D_VIEWER_SETTINGS::FindPreset(), FOLLOW_PCB, FOLLOW_PLOT_SETTINGS, JOB_PCB_RENDER::FRONT, PROJECT_PCB::Get3DCacheManager(), GetAppSettings(), getBoard(), RENDER_3D_RAYTRACE_RAM::GetBuffer(), JOB::GetConfiguredOutputPath(), BOARD::GetFileName(), CAMERA::GetLookAtPos_T1(), BOARD::GetProject(), RENDER_3D_RAYTRACE_RAM::GetRealBufferSize(), BOARD_ADAPTER::GetVisibleLayers(), JOB_PCB_RENDER::HIGH, image, TRACK_BALL::Interpolate(), JOB_PCB_RENDER::JOB_SETTINGS, JOB_PCB_RENDER::JPEG, FILEEXT::JpegFileExtension, LAYER_3D_BACKGROUND_BOTTOM, LAYER_3D_BACKGROUND_TOP, JOB_PCB_RENDER::LEFT, JOB_PCB_RENDER::m_antiAlias, JOB_PCB_RENDER::m_appearancePreset, JOB_PCB_RENDER::m_bgStyle, EDA_3D_VIEWER_SETTINGS::m_Camera, BOARD_ADAPTER::m_Cfg, BOARD_ADAPTER::m_ColorOverrides, EDA_3D_VIEWER_SETTINGS::m_CurrentPreset, JOB_PCB_RENDER::m_filename, JOB_PCB_RENDER::m_floor, JOB_PCB_RENDER::m_format, JOB_PCB_RENDER::m_height, BOARD_ADAPTER::m_IsBoardView, EDA_3D_VIEWER_SETTINGS::m_LayerPresets, JOB_PCB_RENDER::m_lightBottomIntensity, JOB_PCB_RENDER::m_lightCameraIntensity, JOB_PCB_RENDER::m_lightSideElevation, JOB_PCB_RENDER::m_lightSideIntensity, JOB_PCB_RENDER::m_lightTopIntensity, JOB_PCB_RENDER::m_pan, JOB_PCB_RENDER::m_perspective, JOB_PCB_RENDER::m_pivot, JOB_PCB_RENDER::m_postProcess, JOB_PCB_RENDER::m_proceduralTextures, JOB_PCB_RENDER::m_quality, EDA_3D_VIEWER_SETTINGS::m_Render, JOB_DISPATCHER::m_reporter, JOB_PCB_RENDER::m_rotation, JOB_PCB_RENDER::m_side, JOB_PCB_RENDER::m_useBoardStackupColors, EDA_3D_VIEWER_SETTINGS::m_UseStackupColors, JOB_PCB_RENDER::m_variant, JOB_PCB_RENDER::m_width, JOB_PCB_RENDER::m_zoom, CLI::EXIT_CODES::OK, ORTHO, TRACK_BALL::Pan_T1(), CAMERA::ParametersChanged(), pcbIUScale, PERSPECTIVE, JOB_PCB_RENDER::PNG, FILEEXT::PngFileExtension, RANGE_SCALE_3D, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_anti_aliasing, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_backfloor, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightAzimuth, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColor, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColorBottom, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColorCamera, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightColorTop, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_lightElevation, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_post_processing, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_procedural_textures, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_recursivelevel_refractions, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_reflections, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_refractions, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::raytrace_shadows, RENDER_3D_RAYTRACE_RAM::Redraw(), reporter, resolveJobOutputPath(), JOB_PCB_RENDER::RIGHT, CAMERA::RotateX_T1(), CAMERA::RotateY_T1(), CAMERA::RotateZ_T1(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, BOARD_ADAPTER::Set3dCacheManager(), BOARD_ADAPTER::SetBoard(), BOARD::SetCurrentVariant(), CAMERA::SetCurWindowSize(), RENDER_3D_RAYTRACE_RAM::SetCurWindowSize(), BOARD_ADAPTER::SetLayerColors(), CAMERA::SetLookAtPos_T1(), CAMERA::SetProjection(), RENDER_3D_BASE::SetReporters(), TRACK_BALL::SetT0_and_T1_current_T(), BOARD_ADAPTER::SetVisibleLayers(), JOB::SetWorkingOutputPath(), EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_footprints_dnp, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_footprints_insert, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_footprints_normal, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_footprints_not_in_posfile, EDA_3D_VIEWER_SETTINGS::RENDER_SETTINGS::show_footprints_virtual, JOB_PCB_RENDER::TOP, JOB_PCB_RENDER::TRANSPARENT, VIEW3D_BACK, VIEW3D_BOTTOM, VIEW3D_FRONT, VIEW3D_LEFT, VIEW3D_RIGHT, VIEW3D_TOP, CAMERA::ViewCommand_T1(), VECTOR3< T >::x, VECTOR3< T >::y, VECTOR3< T >::z, and CAMERA::Zoom_T1().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportSpecctraDsn()

int PCBNEW_JOBS_HANDLER::JobExportSpecctraDsn ( JOB * aJob)

Definition at line 1973 of file pcbnew_jobs_handler.cpp.

References _, JOB::AddOutput(), PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, DSN::ExportBoardToSpecctraFile(), getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetFileName(), JOB_EXPORT_PCB_SPECCTRA_DSN::m_filename, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, resolveJobOutputPath(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, JOB::SetWorkingOutputPath(), FILEEXT::SpecctraDsnFileExtension, and IO_ERROR::What().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportStackup()

int PCBNEW_JOBS_HANDLER::JobExportStackup ( JOB * aJob)

Definition at line 2097 of file pcbnew_jobs_handler.cpp.

References _, JOB::AddOutput(), BuildStackupCsv(), CLOSE_STREAM, JOB_EXPORT_PCB_STACKUP::CSV, PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetDesignSettings(), BOARD::GetFileName(), BOARD::GetLayerName(), BOARD_STACKUP::GetList(), BOARD_DESIGN_SETTINGS::GetStackupDescriptor(), JOB::GetWorkingOutputPath(), INCH, STACKUP_CSV_OPTIONS::includeBoardOptions, STACKUP_CSV_OPTIONS::includeColor, STACKUP_CSV_OPTIONS::includeEpsilonR, STACKUP_CSV_OPTIONS::includeFinish, STACKUP_CSV_OPTIONS::includeLossTangent, STACKUP_CSV_OPTIONS::includeMaterial, STACKUP_CSV_OPTIONS::includeThickness, JOB_EXPORT_PCB_STACKUP::JSON, JOB_EXPORT_PCB_STACKUP::m_filename, JOB_EXPORT_PCB_STACKUP::m_format, JOB_EXPORT_PCB_STACKUP::m_includeBoardOptions, JOB_EXPORT_PCB_STACKUP::m_includeColor, JOB_EXPORT_PCB_STACKUP::m_includeEpsilonR, JOB_EXPORT_PCB_STACKUP::m_includeFinish, JOB_EXPORT_PCB_STACKUP::m_includeLossTangent, JOB_EXPORT_PCB_STACKUP::m_includeMaterial, JOB_EXPORT_PCB_STACKUP::m_includeThickness, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_STACKUP::m_units, MM, JOB_EXPORT_PCB_STACKUP::MM, CLI::EXIT_CODES::OK, OPEN_OSTREAM, kiapi::board::PackBoardStackup(), resolveJobOutputPath(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, JOB_EXPORT_PCB_STACKUP::SetDefaultOutputPath(), BOARD_STACKUP::SynchronizeWithBoard(), TO_UTF8, and UNDEFINED_LAYER.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportStats()

int PCBNEW_JOBS_HANDLER::JobExportStats ( JOB * aJob)

Definition at line 2019 of file pcbnew_jobs_handler.cpp.

References _, JOB::AddOutput(), ComputeBoardStatistics(), PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, BOARD_STATISTICS_OPTIONS::excludeFootprintsWithoutPads, FormatBoardStatisticsJson(), FormatBoardStatisticsReport(), getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetFileName(), BOARD::GetProject(), PROJECT::GetProjectName(), JOB::GetWorkingOutputPath(), INCH, InitializeBoardStatisticsData(), JOB_EXPORT_PCB_STATS::JSON, JOB_EXPORT_PCB_STATS::m_excludeFootprintsWithoutPads, JOB_EXPORT_PCB_STATS::m_filename, JOB_EXPORT_PCB_STATS::m_format, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_STATS::m_subtractHolesFromBoardArea, JOB_EXPORT_PCB_STATS::m_subtractHolesFromCopperAreas, JOB_EXPORT_PCB_STATS::m_units, MM, JOB_EXPORT_PCB_STATS::MM, CLI::EXIT_CODES::OK, pcbIUScale, resolveJobOutputPath(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, JOB_EXPORT_PCB_STATS::SetDefaultOutputPath(), BOARD_STATISTICS_OPTIONS::subtractHolesFromBoardArea, BOARD_STATISTICS_OPTIONS::subtractHolesFromCopperAreas, and TO_UTF8.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportStep()

int PCBNEW_JOBS_HANDLER::JobExportStep ( JOB * aJob)

Definition at line 1067 of file pcbnew_jobs_handler.cpp.

References _, EXPORTER_STEP_PARAMS::BREP, JOB_EXPORT_PCB_3D::BREP, FILEEXT::BrepFileExtension, BOARD::ComputeBoundingBox(), PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, EXPORTER_STEP::Export(), EXPORTER_VRML::ExportVRML_File(), getBoard(), BOX2< Vec >::GetCenter(), JOB::GetConfiguredOutputPath(), BOARD::GetFileName(), JOB::GetFullOutputPath(), BOARD::GetProject(), EXPORTER_STEP_PARAMS::GLB, JOB_EXPORT_PCB_3D::GLB, FILEEXT::GltfBinaryFileExtension, JOB_EXPORT_PCB_3D::INCH, JOB_EXPORT_PCB_3D::m_3dparams, JOB_EXPORT_PCB_3D::m_filename, EXPORTER_STEP_PARAMS::m_Format, JOB_EXPORT_PCB_3D::m_format, JOB_EXPORT_PCB_3D::m_hasUserOrigin, EXPORTER_STEP_PARAMS::m_IncludeDNP, EXPORTER_STEP_PARAMS::m_IncludeUnspecified, EXPORTER_STEP_PARAMS::m_Origin, EXPORTER_STEP::m_outputFile, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_3D::m_variant, JOB_EXPORT_PCB_3D::m_vrmlModelDir, JOB_EXPORT_PCB_3D::m_vrmlRelativePaths, JOB_EXPORT_PCB_3D::m_vrmlUnits, JOB_EXPORT_PCB_3D::METERS, JOB_EXPORT_PCB_3D::MM, CLI::EXIT_CODES::OK, pcbIUScale, EXPORTER_STEP_PARAMS::PDF, JOB_EXPORT_PCB_3D::PDF, FILEEXT::PdfFileExtension, EXPORTER_STEP_PARAMS::PLY, JOB_EXPORT_PCB_3D::PLY, FILEEXT::PlyFileExtension, resolveJobOutputPath(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, scale, BOARD::SetCurrentVariant(), JOB::SetWorkingOutputPath(), EXPORTER_STEP_PARAMS::STEP, JOB_EXPORT_PCB_3D::STEP, FILEEXT::StepFileExtension, EXPORTER_STEP_PARAMS::STEPZ, JOB_EXPORT_PCB_3D::STEPZ, EXPORTER_STEP_PARAMS::STL, JOB_EXPORT_PCB_3D::STL, FILEEXT::StlFileExtension, JOB_EXPORT_PCB_3D::TENTHS, EXPORTER_STEP_PARAMS::U3D, JOB_EXPORT_PCB_3D::U3D, FILEEXT::U3DFileExtension, JOB_EXPORT_PCB_3D::VRML, FILEEXT::VrmlFileExtension, VECTOR2< T >::x, EXPORTER_STEP_PARAMS::XAO, JOB_EXPORT_PCB_3D::XAO, FILEEXT::XaoFileExtension, and VECTOR2< T >::y.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportSvg()

int PCBNEW_JOBS_HANDLER::JobExportSvg ( JOB * aJob)

Definition at line 1540 of file pcbnew_jobs_handler.cpp.

References _, 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, getBoard(), getToolManager(), JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_SVG::m_genMode, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_PLOT::m_variant, plotJob(), PCB_PLOTTER::PlotJobToPlotOpts(), preparePlotLayers(), resolvePlotOutputPath(), RPT_SEVERITY_ERROR, BOARD::SetCurrentVariant(), JOB_EXPORT_PCB_SVG::SINGLE, and SVG.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobFpDiff()

int PCBNEW_JOBS_HANDLER::JobFpDiff ( JOB * aJob)

Definition at line 4706 of file pcbnew_jobs_handler.cpp.

References KICAD_DIFF::DIFF_EMIT_OPTIONS::comparisonGeometry, KICAD_DIFF::FP_LIB_DIFFER::Diff(), KICAD_DIFF::DiffExitCode(), KICAD_DIFF::DIFF_EMIT_OPTIONS::docKind, KICAD_DIFF::EmitDiffResult(), CLI::EXIT_CODES::ERR_UNKNOWN, footprintLibraryGeometry(), KICAD_DIFF::FP_LIB, loadFootprintLibrarySide(), JOB_DIFF_BASE::m_exitCodeOnly, JOB_DIFF_BASE::m_inputA, JOB_DIFF_BASE::m_inputB, JOB_DISPATCHER::m_reporter, KICAD_DIFF::MakeEmitOptions(), KICAD_DIFF::DIFF_EMIT_OPTIONS::referenceGeometry, result, and CLI::EXIT_CODES::SUCCESS.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobImport()

int PCBNEW_JOBS_HANDLER::JobImport ( JOB * aJob)

Definition at line 3778 of file pcbnew_jobs_handler.cpp.

References _, JOB_PCB_IMPORT::ALTIUM, PCB_IO_MGR::ALTIUM_DESIGNER, ApplyImportedNetNameMap(), JOB_PCB_IMPORT::AUTO, JOB_PCB_IMPORT::CADSTAR, PCB_IO_MGR::CADSTAR_PCB_ARCHIVE, DefaultImportOutputPath(), FILEEXT::DesignRulesFileExtension, JOB_PCB_IMPORT::EAGLE, PCB_IO_MGR::EAGLE, PCB_IO_MGR::EASYEDAPRO, PCB_IO_MGR::EASYEDAPRO_V3, JOB_PCB_IMPORT::EASYPC, PCB_IO_MGR::EASYPC, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, CLI::EXIT_CODES::ERR_UNKNOWN_FILE_FORMAT, JOB_PCB_IMPORT::FABMASTER, PCB_IO_MGR::FABMASTER, PCB_IO_MGR::FILE_TYPE_NONE, fileType(), PCB_IO_MGR::FindPlugin(), PCB_IO_MGR::FindPluginTypeFromBoardPath(), IMPORT_MESSAGE_COLLECTOR::Flush(), JOB::GetConfiguredOutputPath(), SETTINGS_MANAGER::GetProject(), PGM_BASE::GetSettingsManager(), PCB_IO_MGR::ImportGeneratesProjectLibrary(), SETTINGS_MANAGER::IsProjectOpenNotDummy(), PCB_IO_MGR::KICAD_SEXP, FILEEXT::KiCadPcbFileExtension, SETTINGS_MANAGER::LoadProject(), JOB_PCB_IMPORT::m_format, JOB_PCB_IMPORT::m_importPcbId, JOB_PCB_IMPORT::m_inputFile, JOB_PCB_IMPORT::m_isPartOfMultiBoardProject, JOB_PCB_IMPORT::m_layerMap, JOB_PCB_IMPORT::m_netNameMap, JOB_PCB_IMPORT::m_probeOnly, JOB_PCB_IMPORT::m_projectBoards, JOB_DISPATCHER::m_reporter, JOB_PCB_IMPORT::m_reportFile, JOB_PCB_IMPORT::m_reportFormat, LSET::Name(), NONE, PCB_IO_MGR::PADS, JOB_PCB_IMPORT::PADS_ASCII, PCB_IO_MGR::PADS_BINARY, JOB_PCB_IMPORT::PCAD, PCB_IO_MGR::PCAD, PCB_IO_MGR::PCB_FILE_UNKNOWN, PCB_VIA_T, Pgm(), SETTINGS_MANAGER::Prj(), FILEEXT::ProjectFileExtension, ReconcileImportedFootprints(), resolveKiCadLayerName(), result, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, RPT_SEVERITY_WARNING, PCB_IO_MGR::ShowType(), JOB_PCB_IMPORT::SOLIDWORKS, PCB_IO_MGR::SOLIDWORKS_PCB, source, CLI::EXIT_CODES::SUCCESS, JOB_PCB_IMPORT::TARGET3001, PCB_IO_MGR::TARGET3001, UNDEFINED_LAYER, SETTINGS_MANAGER::UnloadProject(), IO_ERROR::What(), and WriteImportReport().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobUpgrade()

int PCBNEW_JOBS_HANDLER::JobUpgrade ( JOB * aJob)

Definition at line 3300 of file pcbnew_jobs_handler.cpp.

References _, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, PCB_IO_MGR::FindPlugin(), getBoard(), BOARD::GetFileFormatVersionAtLoad(), BOARD::GetFileName(), PCB_IO_MGR::KICAD_SEXP, JOB_PCB_UPGRADE::m_filename, JOB_PCB_UPGRADE::m_force, JOB_DISPATCHER::m_reporter, RefreshGeneratedTables(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, SEXPR_BOARD_FILE_VERSION, CLI::EXIT_CODES::SUCCESS, and IO_ERROR::What().

Referenced by PCBNEW_JOBS_HANDLER().

◆ loadOverrideDrawingSheet()

void PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet ( BOARD * brd,
const wxString & aSheetPath )
private

Definition at line 3728 of file pcbnew_jobs_handler.cpp.

References _, BOARD::GetProject(), PROJECT::GetProjectFile(), PROJECT::GetProjectPath(), DS_DATA_MODEL::GetTheInstance(), PROJECT_FILE::m_BoardDrawingSheetFile, BASE_SCREEN::m_DrawingSheetFileName, JOB_DISPATCHER::m_reporter, path, Pgm(), FILENAME_RESOLVER::ResolvePath(), RPT_SEVERITY_ERROR, FILENAME_RESOLVER::SetProgramBase(), and FILENAME_RESOLVER::SetProject().

Referenced by resolveJobOutputPath().

◆ OpenDiffDialog()

int PCBNEW_JOBS_HANDLER::OpenDiffDialog ( KICAD_DIFF::DOC_KIND aKind,
const wxString & aFileA,
const wxString & aFileB,
const wxString & aLabelA,
const wxString & aLabelB,
wxWindow * aParent,
REPORTER * aReporter )

Definition at line 4862 of file pcbnew_jobs_handler.cpp.

References _, PCB_DIFF_SIDES::boardA, PCB_DIFF_SIDES::boardB, KICAD_DIFF::DIFF_COLOR_THEME::comparison, KICAD_DIFF::FP_LIB_DIFFER::Diff(), PCB_DIFF_SIDES::diff, CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, KICAD_DIFF::ExtractBoardGeometry(), KICAD_DIFF::ExtractFootprintGeometry(), KICAD_DIFF::FOOTPRINT, footprintLibraryGeometry(), KICAD_DIFF::FP_LIB, PGM_BASE::GetSettingsManager(), PCB_IO_KICAD_SEXPR::ImportFootprint(), loadFootprintLibrarySide(), loadPcbDiffSides(), JOB_DISPATCHER::m_reporter, name, KICAD_DIFF::PCB, Pgm(), KICAD_DIFF::DIFF_COLOR_THEME::reference, result, RPT_SEVERITY_ERROR, DIALOG_SHIM::ShowModal(), CLI::EXIT_CODES::SUCCESS, and IO_ERROR::What().

◆ populateGerberPlotOptionsFromJob() [1/2]

void PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob ( PCB_PLOT_PARAMS & aPlotOpts,
JOB_EXPORT_PCB_GERBER * aJob )
private

◆ populateGerberPlotOptionsFromJob() [2/2]

void PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob ( PCB_PLOT_PARAMS & aPlotOpts,
JOB_EXPORT_PCB_GERBERS * aJob )
private

◆ preparePlotLayers()

bool PCBNEW_JOBS_HANDLER::preparePlotLayers ( JOB_EXPORT_PCB_PLOT * aJob,
BOARD * aBoard,
TOOL_MANAGER * aToolManager )
private

Definition at line 1464 of file pcbnew_jobs_handler.cpp.

References _, convertLayerArg(), TOOL_MANAGER::FindTool(), TOOL_MANAGER::GetTool(), JOB_EXPORT_PCB_PLOT::m_argCommonLayers, JOB_EXPORT_PCB_PLOT::m_argLayers, JOB_EXPORT_PCB_PLOT::m_checkZonesBeforePlot, JOB_EXPORT_PCB_PLOT::m_plotLayerSequence, JOB_EXPORT_PCB_PLOT::m_plotOnAllLayersSequence, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, TOOL_MANAGER::RegisterTool(), RPT_SEVERITY_ERROR, and ZONE_FILLER_TOOL_NAME.

Referenced by JobExportDxf(), JobExportPdf(), JobExportPng(), JobExportPs(), and JobExportSvg().

◆ refillFabZones()

void PCBNEW_JOBS_HANDLER::refillFabZones ( const JOB_EXPORT_PCB_FAB & aJob,
BOARD * aBoard )
private

Definition at line 3083 of file pcbnew_jobs_handler.cpp.

References TOOL_MANAGER::FindTool(), TOOL_MANAGER::GetTool(), getToolManager(), JOB_EXPORT_PCB_FAB::m_checkZonesBeforeExport, JOB_DISPATCHER::m_progressReporter, TOOL_MANAGER::RegisterTool(), and ZONE_FILLER_TOOL_NAME.

Referenced by JobExportIpc2581(), and JobExportOdb().

◆ 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(), GERBVIEW_JOBS_HANDLER::GERBVIEW_JOBS_HANDLER(), and PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER().

◆ resolveJobOutputPath()

wxString PCBNEW_JOBS_HANDLER::resolveJobOutputPath ( JOB * aJob,
BOARD * aBoard,
const wxString * aDrawingSheet = nullptr )
private

Definition at line 3690 of file pcbnew_jobs_handler.cpp.

References JOB::GetFullOutputPath(), BOARD::GetProject(), BOARD::GetTitleBlock(), JOB::GetVarOverrides(), loadOverrideDrawingSheet(), project, JOB::SetTitleBlock(), and BOARD::SynchronizeProperties().

Referenced by JobExportDrc(), JobExportDrill(), JobExportGencad(), JobExportGerber(), JobExportGerbers(), JobExportIdf(), JobExportIpc2581(), JobExportIpcD356(), JobExportOdb(), JobExportPos(), JobExportRender(), JobExportSpecctraDsn(), JobExportStackup(), JobExportStats(), JobExportStep(), and resolvePlotOutputPath().

◆ resolvePlotOutputPath()

wxString PCBNEW_JOBS_HANDLER::resolvePlotOutputPath ( JOB_EXPORT_PCB_PLOT * aJob,
BOARD * aBoard,
PLOT_FORMAT aFormat,
bool aSingleOutput )
private

Definition at line 1491 of file pcbnew_jobs_handler.cpp.

References JOB::GetConfiguredOutputPath(), GetDefaultPlotExtension(), BOARD::GetFileName(), JOB_EXPORT_PCB_PLOT::m_drawingSheet, resolveJobOutputPath(), and JOB::SetWorkingOutputPath().

Referenced by JobExportDxf(), JobExportPdf(), JobExportPng(), JobExportPs(), and JobExportSvg().

◆ runFpLibMerge()

int PCBNEW_JOBS_HANDLER::runFpLibMerge ( const wxString & aAncestor,
const wxString & aOurs,
const wxString & aTheirs,
const wxString & aOutput,
bool aSingleFile )
private

Definition at line 5030 of file pcbnew_jobs_handler.cpp.

References _, KICAD_DIFF::LIB_MERGE_APPLIER< ITEM >::Apply(), KICAD_DIFF::FP_LIB_DIFFER::Diff(), UTF8::empty(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_RC_VIOLATIONS, PRETTIFIED_FILE_OUTPUTFORMATTER::Finish(), PCB_IO_KICAD_SEXPR::FootprintDelete(), PCB_IO_KICAD_SEXPR::FootprintEnumerate(), PCB_IO_KICAD_SEXPR::FootprintExists(), PCB_IO_KICAD_SEXPR::FootprintSave(), PCB_IO_KICAD_SEXPR::Format(), KICAD_DIFF::LIB_MERGE_APPLIER< ITEM >::GetReport(), PCB_IO_KICAD_SEXPR::ImportFootprint(), FILEEXT::KiCadFootprintFileExtension, KICAD_DIFF::FP_LIB_DIFFER::LoadLibrary(), JOB_DISPATCHER::m_reporter, name, KICAD_DIFF::KICAD_MERGE_ENGINE::Plan(), plan(), KICAD_DIFF::MERGE_PLAN::Resolved(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, PCB_IO_KICAD_SEXPR::SetOutputFormatter(), CLI::EXIT_CODES::SUCCESS, KICAD_DIFF::MERGE_PLAN::unresolved, IO_ERROR::What(), and UTF8::wx_str().

Referenced by RunMerge().

◆ 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.

◆ RunMerge()

int PCBNEW_JOBS_HANDLER::RunMerge ( KICAD_DIFF::DOC_KIND aKind,
const wxString & aAncestor,
const wxString & aOurs,
const wxString & aTheirs,
const wxString & aOutput,
bool aInteractive,
bool aSingleFile,
REPORTER * aReporter )

Non-job entry points (reached via the kiface KIFACE_MERGE_DOCUMENT / KIFACE_OPEN_DIFF_DIALOG function exports, not the JOB system).

Definition at line 4326 of file pcbnew_jobs_handler.cpp.

References KICAD_DIFF::FOOTPRINT, KICAD_DIFF::FP_LIB, JOB_DISPATCHER::m_reporter, runFpLibMerge(), and runPcbMerge().

◆ runPcbMerge()

int PCBNEW_JOBS_HANDLER::runPcbMerge ( const wxString & aAncestor,
const wxString & aOurs,
const wxString & aTheirs,
const wxString & aOutput,
bool aInteractive )
private

Definition at line 4343 of file pcbnew_jobs_handler.cpp.

References _, DIALOG_KICAD_MERGE_3WAY::ANCESTOR, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::ancestorGeometry, KICAD_DIFF::PCB_MERGE_APPLIER::Apply(), KICAD_DIFF::ApplyProjectFilePatches(), KICAD_DIFF::BuildConflictList(), KICAD_DIFF::CollectChangeBBoxes(), KICAD_DIFF::DIFF_COLOR_THEME::comparison, KICAD_DIFF::ConfigurePcbDiffCanvasContext(), KICAD_DIFF::MERGE_PLAN::ConflictCount(), NET_SETTINGS::CopyFrom(), KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::customDrcRules, KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::customDrcRulesSet, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::describeItem, FILEEXT::DesignRulesFileExtension, KICAD_DIFF::PCB_DIFFER::Diff(), SCRATCH_DOC< DOC >::doc, KICAD_DIFF::DOC_PROP_DRAWING_SHEET, KICAD_DIFF::DOC_PROP_DRC_SEVERITIES, KICAD_DIFF::DOC_PROP_NET_CLASSES, KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::drawingSheetFile, KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::drawingSheetFileSet, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::drawSide, KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::drcSeveritiesTouched, empty(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_CANCELLED, 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, KICAD_DIFF::ExtractBoardGeometry(), KICAD_DIFF::VALIDATION_REPORT::failures, FILEEXT::FootprintLibraryTableFileName, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::formatNotice, KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::fpLibTable, KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::fpLibTableSet, BOARD::GetDesignSettings(), BOARD::GetFileFormatVersionAtLoad(), BOARD::GetProject(), PROJECT::GetProjectFile(), KICAD_DIFF::PCB_MERGE_APPLIER::GetReport(), DIALOG_KICAD_MERGE_3WAY::GetResolvedPlan(), PGM_BASE::GetSettingsManager(), JSON_SETTINGS::Internals(), loadScratchBoard(), PROJECT_FILE::m_BoardDrawingSheetFile, BOARD_DESIGN_SETTINGS::m_DRCSeverities, BOARD_DESIGN_SETTINGS::m_NetSettings, JOB_DISPATCHER::m_reporter, MM, KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::netClassesTouched, KICAD_DIFF::OlderFormatNotice(), DIALOG_KICAD_MERGE_3WAY::OURS, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::oursBBoxes, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::oursGeometry, pcbIUScale, Pgm(), KICAD_DIFF::KICAD_MERGE_ENGINE::Plan(), plan(), FILEEXT::ProjectFileExtension, KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::projectFileTouched, KICAD_DIFF::DIFF_COLOR_THEME::reference, KICAD_DIFF::MERGE_PLAN::Resolved(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, PCB_IO_KICAD_SEXPR::SaveBoard(), SETTINGS_MANAGER::SaveProjectCopy(), NESTED_SETTINGS::SaveToFile(), SEXPR_BOARD_FILE_VERSION, DIALOG_SHIM::ShowModal(), PROJECT_FILE::Store(), CLI::EXIT_CODES::SUCCESS, FILEEXT::SymbolLibraryTableFileName, KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::symLibTable, KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::symLibTableSet, DIALOG_KICAD_MERGE_3WAY::THEIRS, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::theirsBBoxes, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::theirsGeometry, KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::validation, and IO_ERROR::What().

Referenced by RunMerge().

◆ 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.

Referenced by runDowngradeJob().

Member Data Documentation

◆ m_cliBoard

std::unique_ptr<BOARD> PCBNEW_JOBS_HANDLER::m_cliBoard
private

Definition at line 135 of file pcbnew_jobs_handler.h.

Referenced by ClearCachedBoard(), getBoard(), and PCBNEW_JOBS_HANDLER().

◆ 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(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), 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::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportOdb(), EESCHEMA_JOBS_HANDLER::JobSchErc(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), PCBNEW_JOBS_HANDLER::preparePlotLayers(), PCBNEW_JOBS_HANDLER::refillFabZones(), RunJob(), and SetProgressReporter().

◆ m_reporter

REPORTER* JOB_DISPATCHER::m_reporter
protectedinherited

Definition at line 49 of file job_dispatcher.h.

Referenced by EESCHEMA_JOBS_HANDLER::AttachDiffCanvases(), PCBNEW_JOBS_HANDLER::AttachDiffCanvases(), GERBVIEW_JOBS_HANDLER::checkStrictMode(), 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(), PCBNEW_JOBS_HANDLER::JobDiff(), EESCHEMA_JOBS_HANDLER::JobDowngrade(), PCBNEW_JOBS_HANDLER::JobDowngrade(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_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::JobExportIdf(), 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::JobExportPng(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportSpecctraDsn(), PCBNEW_JOBS_HANDLER::JobExportStackup(), PCBNEW_JOBS_HANDLER::JobExportStats(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), PCBNEW_JOBS_HANDLER::JobFpDiff(), GERBVIEW_JOBS_HANDLER::JobGerberDiff(), GERBVIEW_JOBS_HANDLER::JobGerberExportPng(), GERBVIEW_JOBS_HANDLER::JobGerberInfo(), EESCHEMA_JOBS_HANDLER::JobImport(), PCBNEW_JOBS_HANDLER::JobImport(), EESCHEMA_JOBS_HANDLER::JobSchDiff(), EESCHEMA_JOBS_HANDLER::JobSchErc(), EESCHEMA_JOBS_HANDLER::JobSymDiff(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), EESCHEMA_JOBS_HANDLER::JobUpgrade(), PCBNEW_JOBS_HANDLER::JobUpgrade(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), EESCHEMA_JOBS_HANDLER::OpenDiffDialog(), PCBNEW_JOBS_HANDLER::OpenDiffDialog(), PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER(), PCBNEW_JOBS_HANDLER::preparePlotLayers(), PCBNEW_JOBS_HANDLER::runFpLibMerge(), RunJob(), EESCHEMA_JOBS_HANDLER::RunMerge(), PCBNEW_JOBS_HANDLER::RunMerge(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), EESCHEMA_JOBS_HANDLER::runSymLibMerge(), and SetReporter().

◆ m_toolManager

std::unique_ptr<TOOL_MANAGER> PCBNEW_JOBS_HANDLER::m_toolManager
private

Definition at line 136 of file pcbnew_jobs_handler.h.

Referenced by ClearCachedBoard(), getToolManager(), and PCBNEW_JOBS_HANDLER().

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