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)
 
int JobExportStep (JOB *aJob)
 
int JobExportRender (JOB *aJob)
 
int JobExportSvg (JOB *aJob)
 
int JobExportDxf (JOB *aJob)
 
int JobExportPdf (JOB *aJob)
 
int JobExportGerber (JOB *aJob)
 
int JobExportGerbers (JOB *aJob)
 
int JobExportGencad (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)
 
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)
 
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

BOARD * getBoard (const wxString &aPath=wxEmptyString)
 
void populateGerberPlotOptionsFromJob (PCB_PLOT_PARAMS &aPlotOpts, JOB_EXPORT_PCB_GERBER *aJob)
 
int doFpExportSvg (JOB_FP_EXPORT_SVG *aSvgJob, const FOOTPRINT *aFootprint)
 
void loadOverrideDrawingSheet (BOARD *brd, const wxString &aSheetPath)
 
DS_PROXY_VIEW_ITEM * getDrawingSheetProxyView (BOARD *aBrd)
 

Private Attributes

BOARD * m_cliBoard
 
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 34 of file pcbnew_jobs_handler.h.

Constructor & Destructor Documentation

◆ PCBNEW_JOBS_HANDLER()

PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER ( KIWAY *  aKiway)

Definition at line 103 of file pcbnew_jobs_handler.cpp.

References FRAME_PCB_EDITOR, JobExportDrc(), JobExportDrill(), JobExportDxf(), JobExportFpSvg(), JobExportFpUpgrade(), JobExportGencad(), JobExportGerber(), JobExportGerbers(), JobExportIpc2581(), JobExportOdb(), JobExportPdf(), JobExportPos(), JobExportRender(), JobExportStep(), JobExportSvg(), KIWAY::Player(), JOB_DISPATCHER::Register(), and DIALOG_SHIM::ShowModal().

Member Function Documentation

◆ doFpExportSvg()

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

Definition at line 1698 of file pcbnew_jobs_handler.cpp.

References _, ANGLE_0, FOOTPRINT::Clone(), CreateEmptyBoard(), CLI::EXIT_CODES::ERR_UNKNOWN, FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), JOB::GetVarOverrides(), IS_NEW, JOB_FP_EXPORT_SVG::m_blackAndWhite, PCB_PLOT_SVG_OPTIONS::m_blackAndWhite, JOB_FP_EXPORT_SVG::m_colorTheme, PCB_PLOT_SVG_OPTIONS::m_colorTheme, JOB_FP_EXPORT_SVG::m_crossoutDNPFPsOnFabLayers, PCB_PLOT_SVG_OPTIONS::m_crossoutDNPFPsOnFabLayers, JOB_FP_EXPORT_SVG::m_hideDNPFPsOnFabLayers, PCB_PLOT_SVG_OPTIONS::m_hideDNPFPsOnFabLayers, PCB_PLOT_SVG_OPTIONS::m_mirror, JOB_FP_EXPORT_SVG::m_outputDirectory, PCB_PLOT_SVG_OPTIONS::m_outputFile, PCB_PLOT_SVG_OPTIONS::m_pageSizeMode, PCB_PLOT_SVG_OPTIONS::m_plotFrame, JOB_FP_EXPORT_SVG::m_printMaskLayer, PCB_PLOT_SVG_OPTIONS::m_printMaskLayer, JOB_DISPATCHER::m_reporter, JOB_FP_EXPORT_SVG::m_sketchDNPFPsOnFabLayers, PCB_PLOT_SVG_OPTIONS::m_sketchDNPFPsOnFabLayers, JOB_FP_EXPORT_SVG::m_sketchPadsOnFabLayers, PCB_PLOT_SVG_OPTIONS::m_sketchPadsOnFabLayers, niluuid, CLI::EXIT_CODES::OK, pad, FOOTPRINT::Pads(), EXPORT_SVG::Plot(), REPORTER::Report(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, EDA_ITEM::SetFlags(), FOOTPRINT::SetLink(), FOOTPRINT::SetOrientation(), EDA_ITEM::SetParent(), FOOTPRINT::SetPosition(), FILEEXT::SVGFileExtension, and UTF8::wx_str().

Referenced by JobExportFpSvg().

◆ getBoard()

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

Definition at line 277 of file pcbnew_jobs_handler.cpp.

References _, FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), PROJECT::GetProjectFullName(), GetSettingsManager(), PGM_BASE::GetSettingsManager(), FILEEXT::KiCadPcbFileExtension, LoadBoard(), m_cliBoard, JOB_DISPATCHER::m_kiway, JOB_DISPATCHER::m_reporter, path, Pgm(), KIWAY::Player(), SETTINGS_MANAGER::Prj(), REPORTER::Report(), and RPT_SEVERITY_ERROR.

Referenced by JobExportDrc(), JobExportDrill(), JobExportDxf(), JobExportGerber(), JobExportGerbers(), JobExportIpc2581(), JobExportOdb(), JobExportPdf(), JobExportPos(), JobExportRender(), JobExportStep(), and JobExportSvg().

◆ getDrawingSheetProxyView()

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

Definition at line 2074 of file pcbnew_jobs_handler.cpp.

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

Referenced by JobExportDrc().

◆ HandleJobConfig()

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

Definition at line 68 of file job_dispatcher.cpp.

References JOB::GetType(), and JOB_DISPATCHER::m_jobConfigHandlers.

◆ JobExportDrc()

int PCBNEW_JOBS_HANDLER::JobExportDrc ( JOB *  aJob)

Definition at line 1758 of file pcbnew_jobs_handler.cpp.

References _, COMMIT::Add(), PROJECT::ApplyTextVars(), BOARD::DeleteMARKERs(), 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::ExpressMail(), FRAME_SCH, getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetDesignSettings(), getDrawingSheetProxyView(), BOARD::GetFileName(), JOB::GetFullOutputPath(), BOARD::GetProject(), BOARD::GetTitleBlock(), JOB::GetVarOverrides(), JOB_RC::INCHES, JOB_RC::JSON, FILEEXT::JsonFileExtension, Kiface(), 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_PCB_DRC::m_reportAllTrackErrors, JOB_DISPATCHER::m_reporter, JOB_RC::m_severity, JOB_RC::m_units, MAIL_SCH_GET_NETLIST, MARKER_BASE::MARKER_DRAWING_SHEET, MARKER_BASE::MARKER_DRC, MARKER_BASE::MARKER_PARITY, MARKER_BASE::MARKER_RATSNEST, JOB_RC::MILLIMETERS, JOB_RC::MILS, netlist, BOARD_COMMIT::Push(), BOARD::RecordDRCExclusions(), REPORTER::Report(), FILEEXT::ReportFileExtension, BOARD::ResolveDRCExclusions(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, TOOL_MANAGER::SetEnvironment(), JOB::SetTitleBlock(), JOB::SetWorkingOutputPath(), SKIP_SET_DIRTY, SKIP_UNDO, CLI::EXIT_CODES::SUCCESS, BOARD::SynchronizeProperties(), DRC_REPORT::WriteJsonReport(), and DRC_REPORT::WriteTextReport().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportDrill()

int PCBNEW_JOBS_HANDLER::JobExportDrill ( JOB *  aJob)

Definition at line 1228 of file pcbnew_jobs_handler.cpp.

References _, JOB_EXPORT_PCB_DRILL::ABS, EXCELLON_WRITER::CreateDrillandMapFilesSet(), GERBER_WRITER::CreateDrillandMapFilesSet(), JOB_EXPORT_PCB_DRILL::DECIMAL, GENDRILL_WRITER_BASE::DECIMAL_FORMAT, JOB_EXPORT_PCB_DRILL::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, JOB_EXPORT_PCB_DRILL::GERBER, JOB_EXPORT_PCB_DRILL::GERBER_X2, BOARD_DESIGN_SETTINGS::GetAuxOrigin(), getBoard(), BOARD::GetDesignSettings(), JOB::GetFullOutputPath(), BOARD::GetProject(), BOARD::GetTitleBlock(), JOB_EXPORT_PCB_DRILL::INCHES, JOB_EXPORT_PCB_DRILL::KEEP_ZEROS, GENDRILL_WRITER_BASE::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_gerberPrecision, DRILL_PRECISION::m_Lhs, JOB_EXPORT_PCB_DRILL::m_mapFormat, JOB_DISPATCHER::m_reporter, DRILL_PRECISION::m_Rhs, JOB_EXPORT_PCB_DRILL::m_zeroFormat, JOB_EXPORT_PCB_DRILL::MILLIMETERS, CLI::EXIT_CODES::OK, JOB_EXPORT_PCB_DRILL::PDF, JOB_EXPORT_PCB_DRILL::POSTSCRIPT, precisionListForInches, precisionListForMetric, REPORTER::Report(), RPT_SEVERITY_ERROR, EXCELLON_WRITER::SetFormat(), GERBER_WRITER::SetFormat(), GENDRILL_WRITER_BASE::SetMapFileFormat(), EXCELLON_WRITER::SetOptions(), GERBER_WRITER::SetOptions(), EXCELLON_WRITER::SetRouteModeForOvalHoles(), JOB::SetTitleBlock(), JOB_EXPORT_PCB_DRILL::SUPPRESS_LEADING, GENDRILL_WRITER_BASE::SUPPRESS_LEADING, JOB_EXPORT_PCB_DRILL::SUPPRESS_TRAILING, GENDRILL_WRITER_BASE::SUPPRESS_TRAILING, and JOB_EXPORT_PCB_DRILL::SVG.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportDxf()

int PCBNEW_JOBS_HANDLER::JobExportDxf ( JOB *  aJob)

Definition at line 777 of file pcbnew_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_UNKNOWN, getBoard(), JOB::GetConfiguredOutputPath(), GetDefaultPlotExtension(), BOARD::GetFileName(), JOB::GetFullOutputPath(), BOARD::GetProject(), BOARD::GetTitleBlock(), JOB::GetVarOverrides(), loadOverrideDrawingSheet(), JOB_EXPORT_PCB_PLOT::m_drawingSheet, JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_DXF::m_genMode, JOB_EXPORT_PCB_PLOT::m_printMaskLayer, JOB_EXPORT_PCB_PLOT::m_printMaskLayersToIncludeOnAllLayers, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, PCB_PLOTTER::Plot(), PCB_PLOTTER::PlotJobToPlotOpts(), REPORTER::Report(), RPT_SEVERITY_ERROR, JOB::SetTitleBlock(), JOB::SetWorkingOutputPath(), JOB_EXPORT_PCB_DXF::SINGLE, and BOARD::SynchronizeProperties().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportFpSvg()

int PCBNEW_JOBS_HANDLER::JobExportFpSvg ( JOB *  aJob)

Definition at line 1635 of file pcbnew_jobs_handler.cpp.

References _, CTL_FOR_LIBRARY, doFpExportSvg(), CLI::EXIT_CODES::ERR_UNKNOWN, FP_CACHE::GetFootprints(), FOOTPRINT::GetFPID(), LIB_ID::GetLibItemName(), FP_CACHE::Load(), JOB_FP_EXPORT_SVG::m_footprint, JOB_FP_EXPORT_SVG::m_libraryPath, JOB_FP_EXPORT_SVG::m_outputDirectory, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, REPORTER::Report(), RPT_SEVERITY_ERROR, and UTF8::wx_str().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportFpUpgrade()

int PCBNEW_JOBS_HANDLER::JobExportFpUpgrade ( JOB *  aJob)

Definition at line 1541 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_reporter, CLI::EXIT_CODES::OK, REPORTER::Report(), 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 1068 of file pcbnew_jobs_handler.cpp.

References _, PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, GENCAD_EXPORTER::FlipBottomPads(), FILEEXT::GencadFileExtension, BOARD_DESIGN_SETTINGS::GetAuxOrigin(), JOB::GetConfiguredOutputPath(), BOARD::GetDesignSettings(), BOARD::GetFileName(), JOB::GetFullOutputPath(), BOARD::GetProject(), LoadBoard(), 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, REPORTER::Report(), 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 PCBNEW_JOBS_HANDLER().

◆ JobExportGerber()

int PCBNEW_JOBS_HANDLER::JobExportGerber ( JOB *  aJob)

Definition at line 1147 of file pcbnew_jobs_handler.cpp.

References _, PROJECT::ApplyTextVars(), GERBER_PLOTTER::EndPlot(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, getBoard(), JOB::GetConfiguredOutputPath(), GetDefaultPlotExtension(), BOARD::GetFileName(), JOB::GetFullOutputPath(), BOARD::GetLayerName(), BOARD::GetProject(), BOARD::GetTitleBlock(), JOB::GetVarOverrides(), JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PLOT::m_printMaskLayer, JOB_EXPORT_PCB_PLOT::m_printMaskLayersToIncludeOnAllLayers, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, PlotBoardLayers(), populateGerberPlotOptionsFromJob(), REPORTER::Report(), RPT_SEVERITY_ERROR, PCB_PLOT_PARAMS::SetLayerSelection(), PCB_PLOT_PARAMS::SetPlotOnAllLayersSelection(), JOB::SetTitleBlock(), JOB::SetWorkingOutputPath(), StartPlotBoard(), BOARD::SynchronizeProperties(), and UNDEFINED_LAYER.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportGerbers()

int PCBNEW_JOBS_HANDLER::JobExportGerbers ( JOB *  aJob)

Definition at line 928 of file pcbnew_jobs_handler.cpp.

References _, GERBER_JOBFILE_WRITER::AddGbrFile(), LSET::AllCuMask(), LSET::AllNonCuMask(), PROJECT::ApplyTextVars(), BuildPlotFileName(), GERBER_JOBFILE_WRITER::CreateJobFile(), dummy, 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, FILEEXT::GerberFileExtension, FILEEXT::GerberJobFileExtension, getBoard(), BOARD::GetEnabledLayers(), BOARD::GetFileName(), JOB::GetFullOutputPath(), GetGerberProtelExtension(), BOARD::GetLayerName(), PCB_PLOT_PARAMS::GetLayerSelection(), PCB_PLOT_PARAMS::GetPlotOnAllLayersSelection(), BOARD::GetPlotOptions(), BOARD::GetProject(), BOARD::GetTitleBlock(), PCB_PLOT_PARAMS::GetUseGerberProtelExtensions(), JOB::GetVarOverrides(), loadOverrideDrawingSheet(), JOB_EXPORT_PCB_PLOT::m_drawingSheet, JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_GERBERS::m_layersIncludeOnAll, JOB_EXPORT_PCB_GERBERS::m_layersIncludeOnAllSet, JOB_EXPORT_PCB_PLOT::m_printMaskLayer, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_GERBERS::m_useBoardPlotParams, CLI::EXIT_CODES::OK, PlotBoardLayers(), populateGerberPlotOptionsFromJob(), REPORTER::Report(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, LSET::SeqStackupForPlotting(), JOB::SetTitleBlock(), StartPlotBoard(), BOARD::SynchronizeProperties(), and LSET::UIOrder().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportIpc2581()

int PCBNEW_JOBS_HANDLER::JobExportIpc2581 ( JOB *  aJob)

Definition at line 1930 of file pcbnew_jobs_handler.cpp.

References _, JOB_EXPORT_PCB_IPC2581::C, 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(), JOB::GetFullOutputPath(), BOARD::GetProject(), BOARD::GetTitleBlock(), PCB_IO_MGR::IPC2581, FILEEXT::Ipc2581FileExtension, JOB_EXPORT_PCB_IPC2581::m_colDist, JOB_EXPORT_PCB_IPC2581::m_colDistPn, JOB_EXPORT_PCB_IPC2581::m_colInternalId, JOB_EXPORT_PCB_IPC2581::m_colMfg, JOB_EXPORT_PCB_IPC2581::m_colMfgPn, JOB_EXPORT_PCB_IPC2581::m_compress, JOB_EXPORT_PCB_IPC2581::m_filename, JOB_EXPORT_PCB_IPC2581::m_precision, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_IPC2581::m_units, JOB_EXPORT_PCB_IPC2581::m_version, JOB_EXPORT_PCB_IPC2581::MILLIMETERS, PCB_IO_MGR::PluginFind(), REPORTER::Report(), RPT_SEVERITY_ERROR, JOB::SetTitleBlock(), JOB::SetWorkingOutputPath(), CLI::EXIT_CODES::SUCCESS, IO_ERROR::What(), and zip.

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportOdb()

int PCBNEW_JOBS_HANDLER::JobExportOdb ( JOB *  aJob)

Definition at line 2025 of file pcbnew_jobs_handler.cpp.

References FILEEXT::ArchiveFileExtension, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), getBoard(), JOB::GetConfiguredOutputPath(), BOARD::GetFileName(), BOARD::GetTitleBlock(), JOB_EXPORT_PCB_ODB::m_compressionMode, JOB_EXPORT_PCB_ODB::m_filename, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, JOB_EXPORT_PCB_ODB::NONE, path, JOB::SetTitleBlock(), 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 848 of file pcbnew_jobs_handler.cpp.

References _, JOB_EXPORT_PCB_PDF::ALL_LAYERS_ONE_FILE, PROJECT::ApplyTextVars(), dummy, PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, getBoard(), JOB::GetConfiguredOutputPath(), GetDefaultPlotExtension(), BOARD::GetFileName(), JOB::GetFullOutputPath(), BOARD::GetProject(), BOARD::GetTitleBlock(), JOB::GetVarOverrides(), loadOverrideDrawingSheet(), JOB_EXPORT_PCB_PLOT::m_drawingSheet, JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_PDF::m_pdfGenMode, PCB_PLOT_PARAMS::m_PDFSingle, JOB_EXPORT_PCB_PLOT::m_printMaskLayer, JOB_EXPORT_PCB_PLOT::m_printMaskLayersToIncludeOnAllLayers, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, JOB_EXPORT_PCB_PDF::ONE_PAGE_PER_LAYER_ONE_FILE, PCB_PLOTTER::Plot(), PCB_PLOTTER::PlotJobToPlotOpts(), REPORTER::Report(), RPT_SEVERITY_ERROR, JOB::SetTitleBlock(), JOB::SetWorkingOutputPath(), and BOARD::SynchronizeProperties().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportPos()

int PCBNEW_JOBS_HANDLER::JobExportPos ( JOB *  aJob)

Definition at line 1348 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(), JOB::GetFullOutputPath(), PLACEFILE_GERBER_WRITER::GetPlaceFileName(), BOARD::GetProject(), BOARD::GetTitleBlock(), 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::MILLIMETERS, CLI::EXIT_CODES::OK, REPORTER::Report(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, JOB::SetTitleBlock(), and JOB::SetWorkingOutputPath().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportRender()

int PCBNEW_JOBS_HANDLER::JobExportRender ( JOB *  aJob)

Definition at line 453 of file pcbnew_jobs_handler.cpp.

References _, PROJECT::ApplyTextVars(), 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, JOB_PCB_RENDER::FRONT, PROJECT_PCB::Get3DCacheManager(), SETTINGS_MANAGER::GetAppSettings(), getBoard(), RENDER_3D_RAYTRACE_RAM::GetBuffer(), JOB::GetConfiguredOutputPath(), BOARD::GetFileName(), JOB::GetFullOutputPath(), CAMERA::GetLookAtPos_T1(), BOARD::GetProject(), RENDER_3D_RAYTRACE_RAM::GetRealBufferSize(), PGM_BASE::GetSettingsManager(), BOARD::GetTitleBlock(), JOB::GetVarOverrides(), JOB_PCB_RENDER::HIGH, image, TRACK_BALL::Interpolate(), JOB_PCB_RENDER::JPEG, FILEEXT::JpegFileExtension, LAYER_3D_BACKGROUND_BOTTOM, LAYER_3D_BACKGROUND_TOP, JOB_PCB_RENDER::LEFT, JOB_PCB_RENDER::m_bgStyle, BOARD_ADAPTER::m_Cfg, BOARD_ADAPTER::m_ColorOverrides, JOB_PCB_RENDER::m_colorPreset, 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, BOARD_ADAPTER::m_IsPreviewer, 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_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_width, JOB_PCB_RENDER::m_zoom, EDA_IU_SCALE::mmToIU(), CLI::EXIT_CODES::OK, TRACK_BALL::Pan_T1(), CAMERA::ParametersChanged(), pcbIUScale, Pgm(), 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::Report(), 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(), CAMERA::SetCurWindowSize(), RENDER_3D_RAYTRACE_RAM::SetCurWindowSize(), CAMERA::SetLookAtPos_T1(), CAMERA::SetProjection(), TRACK_BALL::SetT0_and_T1_current_T(), JOB::SetTitleBlock(), JOB::SetWorkingOutputPath(), BOARD::SynchronizeProperties(), JOB_PCB_RENDER::TOP, JOB_PCB_RENDER::TRANSPARENT, CAMERA::ViewCommand_T1(), VECTOR3< T >::x, VECTOR3< T >::y, VECTOR3< T >::z, and CAMERA::Zoom_T1().

Referenced by PCBNEW_JOBS_HANDLER().

◆ JobExportStep()

int PCBNEW_JOBS_HANDLER::JobExportStep ( JOB *  aJob)

Definition at line 317 of file pcbnew_jobs_handler.cpp.

References _, PROJECT::ApplyTextVars(), 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(), BOARD::GetTitleBlock(), JOB::GetVarOverrides(), EXPORTER_STEP_PARAMS::GLB, JOB_EXPORT_PCB_3D::GLB, FILEEXT::GltfBinaryFileExtension, JOB_EXPORT_PCB_3D::INCHES, EDA_IU_SCALE::IUTomm(), 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_vrmlModelDir, JOB_EXPORT_PCB_3D::m_vrmlRelativePaths, JOB_EXPORT_PCB_3D::m_vrmlUnits, JOB_EXPORT_PCB_3D::METERS, JOB_EXPORT_PCB_3D::MILLIMETERS, CLI::EXIT_CODES::OK, pcbIUScale, EXPORTER_STEP_PARAMS::PLY, JOB_EXPORT_PCB_3D::PLY, FILEEXT::PlyFileExtension, REPORTER::Report(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, scale, JOB::SetTitleBlock(), JOB::SetWorkingOutputPath(), EXPORTER_STEP_PARAMS::STEP, JOB_EXPORT_PCB_3D::STEP, FILEEXT::StepFileExtension, EXPORTER_STEP_PARAMS::STL, JOB_EXPORT_PCB_3D::STL, FILEEXT::StlFileExtension, BOARD::SynchronizeProperties(), JOB_EXPORT_PCB_3D::TENTHS, 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 704 of file pcbnew_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_UNKNOWN, getBoard(), JOB::GetConfiguredOutputPath(), GetDefaultPlotExtension(), BOARD::GetFileName(), JOB::GetFullOutputPath(), BOARD::GetProject(), BOARD::GetTitleBlock(), JOB::GetVarOverrides(), loadOverrideDrawingSheet(), JOB_EXPORT_PCB_PLOT::m_drawingSheet, JOB_EXPORT_PCB_PLOT::m_filename, JOB_EXPORT_PCB_SVG::m_genMode, JOB_EXPORT_PCB_PLOT::m_printMaskLayer, JOB_EXPORT_PCB_PLOT::m_printMaskLayersToIncludeOnAllLayers, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, PCB_PLOTTER::Plot(), PCB_PLOTTER::PlotJobToPlotOpts(), REPORTER::Report(), RPT_SEVERITY_ERROR, JOB::SetTitleBlock(), JOB::SetWorkingOutputPath(), JOB_EXPORT_PCB_SVG::SINGLE, and BOARD::SynchronizeProperties().

Referenced by PCBNEW_JOBS_HANDLER().

◆ loadOverrideDrawingSheet()

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

Definition at line 2092 of file pcbnew_jobs_handler.cpp.

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

Referenced by JobExportDxf(), JobExportGerbers(), JobExportPdf(), and JobExportSvg().

◆ populateGerberPlotOptionsFromJob()

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

Definition at line 1124 of file pcbnew_jobs_handler.cpp.

References JOB_EXPORT_PCB_GERBER::m_disableApertureMacros, JOB_EXPORT_PCB_GERBER::m_includeNetlistAttributes, JOB_EXPORT_PCB_PLOT::m_plotDrawingSheet, JOB_EXPORT_PCB_PLOT::m_plotFootprintValues, JOB_EXPORT_PCB_PLOT::m_plotRefDes, JOB_EXPORT_PCB_GERBER::m_precision, JOB_EXPORT_PCB_GERBER::m_subtractSolderMaskFromSilk, JOB_EXPORT_PCB_PLOT::m_useDrillOrigin, JOB_EXPORT_PCB_GERBER::m_useProtelFileExtension, JOB_EXPORT_PCB_GERBER::m_useX2Format, PCB_PLOT_PARAMS::SetDisableGerberMacros(), PCB_PLOT_PARAMS::SetDrillMarksType(), PCB_PLOT_PARAMS::SetFormat(), PCB_PLOT_PARAMS::SetGerberPrecision(), PCB_PLOT_PARAMS::SetIncludeGerberNetlistInfo(), PCB_PLOT_PARAMS::SetPlotFrameRef(), PCB_PLOT_PARAMS::SetPlotReference(), PCB_PLOT_PARAMS::SetPlotValue(), PCB_PLOT_PARAMS::SetSubtractMaskFromSilk(), PCB_PLOT_PARAMS::SetUseAuxOrigin(), PCB_PLOT_PARAMS::SetUseGerberProtelExtensions(), and PCB_PLOT_PARAMS::SetUseGerberX2format().

Referenced by JobExportGerber(), and JobExportGerbers().

◆ 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 JOB_DISPATCHER::m_jobConfigHandlers, and JOB_DISPATCHER::m_jobHandlers.

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

◆ RunJob()

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

Definition at line 45 of file job_dispatcher.cpp.

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

◆ SetProgressReporter()

void JOB_DISPATCHER::SetProgressReporter ( PROGRESS_REPORTER *  aReporter)
inherited

Definition at line 86 of file job_dispatcher.cpp.

References JOB_DISPATCHER::m_progressReporter.

◆ SetReporter()

void JOB_DISPATCHER::SetReporter ( REPORTER *  aReporter)
inherited

Definition at line 79 of file job_dispatcher.cpp.

References JOB_DISPATCHER::m_reporter.

Member Data Documentation

◆ m_cliBoard

BOARD* PCBNEW_JOBS_HANDLER::m_cliBoard
private

Definition at line 63 of file pcbnew_jobs_handler.h.

Referenced by getBoard().

◆ 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 JOB_DISPATCHER::HandleJobConfig(), and JOB_DISPATCHER::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 JOB_DISPATCHER::Register(), and JOB_DISPATCHER::RunJob().

◆ m_kiway

KIWAY* JOB_DISPATCHER::m_kiway
protectedinherited

Definition at line 48 of file job_dispatcher.h.

Referenced by getBoard(), EESCHEMA_JOBS_HANDLER::getSchematic(), 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::JOB_DISPATCHER(), JobExportIpc2581(), JobExportOdb(), EESCHEMA_JOBS_HANDLER::JobSchErc(), and JOB_DISPATCHER::SetProgressReporter().

◆ m_reporter

REPORTER* JOB_DISPATCHER::m_reporter
protectedinherited

Definition at line 49 of file job_dispatcher.h.

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

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