|
KiCad PCB EDA Suite
|
Placeholder for a job type this version of KiCad does not know, for example a jobset saved by a newer version. More...
#include <job_unknown.h>
Public Member Functions | |
| JOB_UNKNOWN (const std::string &aType, const nlohmann::json &aSettings) | |
| void | FromJson (const nlohmann::json &j) override |
| void | ToJson (nlohmann::json &j) const override |
| wxString | GetDefaultDescription () const override |
| const std::string & | GetType () const |
| const std::map< wxString, wxString > & | GetVarOverrides () const |
| void | SetVarOverrides (const std::map< wxString, wxString > &aVarOverrides) |
| void | SetTitleBlock (const TITLE_BLOCK &aTitleBlock) |
| virtual wxString | GetSettingsDialogTitle () const |
| const std::vector< JOB_PARAM_BASE * > & | GetParams () |
| void | ClearExistingOutputs () |
| const std::vector< JOB_OUTPUT > & | GetOutputs () |
| void | AddOutput (wxString aOutputPath) |
| void | SetTempOutputDirectory (const wxString &aBase) |
| Sets the temporary output directory for the job, this is used to prefix with a given output path when GetFullOutputPath is called. | |
| void | SetConfiguredOutputPath (const wxString &aPath) |
| Sets the configured output path for the job, this path is always saved to file. | |
| wxString | GetConfiguredOutputPath () const |
| Returns the configured output path for the job. | |
| void | SetWorkingOutputPath (const wxString &aPath) |
| Sets a transient output path for the job, it takes priority over the configured output path when GetFullOutputPath is called. | |
| wxString | GetWorkingOutputPath () const |
| Returns the working output path for the job, if one has been set. | |
| wxString | GetFullOutputPath (PROJECT *aProject) const |
| Returns the full output path for the job, taking into account the configured output path, any configured working path and the temporary output directory. | |
| wxString | ResolveOutputPath (const wxString &aPath, bool aPathIsDirectory, PROJECT *aProject) const |
| bool | GetOutputPathIsDirectory () const |
Static Public Member Functions | |
| static wxString | AppendDefaultFileName (const wxString &aPath, const wxString &aDefaultName) |
| Complete a resolved file output path that names a folder, either by a trailing separator or by being an existing directory, with a default file name. | |
Protected Attributes | |
| std::string | m_type |
| std::map< wxString, wxString > | m_varOverrides |
| TITLE_BLOCK | m_titleBlock |
| wxString | m_tempOutputDirectory |
| wxString | m_outputPath |
| bool | m_outputPathIsDirectory |
| wxString | m_description |
| wxString | m_workingOutputPath |
| The working output path is a transient path that takes priority over the configured output path when determining where to write output files. | |
| std::vector< JOB_PARAM_BASE * > | m_params |
| std::vector< JOB_OUTPUT > | m_outputs |
Private Attributes | |
| nlohmann::json | m_settings |
Placeholder for a job type this version of KiCad does not know, for example a jobset saved by a newer version.
Keeps the original settings so the file round-trips intact.
Definition at line 29 of file job_unknown.h.
| JOB_UNKNOWN::JOB_UNKNOWN | ( | const std::string & | aType, |
| const nlohmann::json & | aSettings ) |
Definition at line 22 of file job_unknown.cpp.
References JOB::JOB(), and m_settings.
|
inlineinherited |
Definition at line 216 of file job.h.
References m_outputs.
Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), GenerateIpc2581File(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportSpecctraDsn(), PCBNEW_JOBS_HANDLER::JobExportStackup(), PCBNEW_JOBS_HANDLER::JobExportStats(), and plotJob().
|
staticinherited |
Complete a resolved file output path that names a folder, either by a trailing separator or by being an existing directory, with a default file name.
Definition at line 152 of file job.cpp.
Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), and JOBS_RUNNER::runSpecialExecute().
|
inlineinherited |
|
overridevirtual |
|
inlineinherited |
Returns the configured output path for the job.
Definition at line 235 of file job.h.
References m_outputPath.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIdf(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportSpecctraDsn(), PCBNEW_JOBS_HANDLER::JobExportStackup(), PCBNEW_JOBS_HANDLER::JobExportStats(), PCBNEW_JOBS_HANDLER::JobExportStep(), GERBVIEW_JOBS_HANDLER::JobGerberDiff(), GERBVIEW_JOBS_HANDLER::JobGerberExportPng(), EESCHEMA_JOBS_HANDLER::JobImport(), PCBNEW_JOBS_HANDLER::JobImport(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCB_PLOTTER::PlotJobToPlotOpts(), PCBNEW_JOBS_HANDLER::resolvePlotOutputPath(), JOBS_RUNNER::runSpecialArchive(), and JOBS_RUNNER::runSpecialExecute().
|
overridevirtual |
|
inherited |
Returns the full output path for the job, taking into account the configured output path, any configured working path and the temporary output directory.
Additionally variable resolution will take place
Definition at line 174 of file job.cpp.
References m_outputPath, m_outputPathIsDirectory, m_workingOutputPath, and ResolveOutputPath().
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), GenerateIpc2581File(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportStep(), EESCHEMA_JOBS_HANDLER::JobSchErc(), KICAD_DIFF::MakeEmitOptions(), PCBNEW_JOBS_HANDLER::resolveJobOutputPath(), JOBS_RUNNER::runSpecialArchive(), JOBS_RUNNER::runSpecialCopyFiles(), and JOBS_RUNNER::runSpecialExecute().
|
inlineinherited |
Definition at line 266 of file job.h.
References m_outputPathIsDirectory.
Referenced by BOOST_AUTO_TEST_CASE(), GenerateODBPPFiles(), and EESCHEMA_JOBS_HANDLER::JobExportPlot().
|
inlineinherited |
Definition at line 215 of file job.h.
References m_outputs.
Referenced by ExecuteBoardJob(), and ExecuteSchematicJob().
|
inlineinherited |
|
virtualinherited |
Reimplemented in JOB_EXPORT_BOM, JOB_EXPORT_PCB_3D, JOB_EXPORT_PCB_DRILL, JOB_EXPORT_PCB_DXF, JOB_EXPORT_PCB_GENCAD, JOB_EXPORT_PCB_GERBER, JOB_EXPORT_PCB_GERBERS, JOB_EXPORT_PCB_IDF, JOB_EXPORT_PCB_IPC2581, JOB_EXPORT_PCB_IPCD356, JOB_EXPORT_PCB_ODB, JOB_EXPORT_PCB_PDF, JOB_EXPORT_PCB_PNG, JOB_EXPORT_PCB_POS, JOB_EXPORT_PCB_PS, JOB_EXPORT_PCB_SPECCTRA_DSN, JOB_EXPORT_PCB_STACKUP, JOB_EXPORT_PCB_STATS, JOB_EXPORT_PCB_SVG, JOB_EXPORT_SCH_NETLIST, JOB_EXPORT_SCH_PLOT_DXF, JOB_EXPORT_SCH_PLOT_PDF, JOB_EXPORT_SCH_PLOT_PNG, JOB_EXPORT_SCH_PLOT_PS, JOB_EXPORT_SCH_PLOT_SVG, JOB_PCB_DRC, JOB_PCB_IMPORT, JOB_PCB_RENDER, JOB_SCH_ERC, JOB_SCH_IMPORT, and JOB_SCH_LINK_FOOTPRINTS.
Definition at line 80 of file job.cpp.
References _.
Referenced by DIALOG_PLOT::DIALOG_PLOT().
|
inlineinherited |
Definition at line 195 of file job.h.
References m_type.
Referenced by ExecuteBoardJob(), ExecuteSchematicJob(), JOB_UNKNOWN::GetDefaultDescription(), JOB_DISPATCHER::HandleJobConfig(), PANEL_JOBSET::OpenJobOptionsForListItem(), and JOB_DISPATCHER::RunJob().
|
inlineinherited |
Definition at line 197 of file job.h.
References m_varOverrides.
Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), plotJob(), and PCBNEW_JOBS_HANDLER::resolveJobOutputPath().
|
inlineinherited |
Returns the working output path for the job, if one has been set.
Definition at line 246 of file job.h.
References m_workingOutputPath.
Referenced by BOOST_AUTO_TEST_CASE(), GenerateODBPPFiles(), PCBNEW_JOBS_HANDLER::JobExportStackup(), and PCBNEW_JOBS_HANDLER::JobExportStats().
|
inherited |
Definition at line 100 of file job.cpp.
References ExpandPathVariables(), INTERNAL, m_tempOutputDirectory, m_titleBlock, PrependDirectoryToPath(), and PROJECT::TextVarResolver().
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GenerateODBPPFiles(), GetFullOutputPath(), PCBNEW_JOBS_HANDLER::JobExportDrill(), and JOBS_RUNNER::runSpecialExecute().
|
inherited |
Sets the configured output path for the job, this path is always saved to file.
Any transient working output path is cleared so the new configured path takes precedence on the next call to GetFullOutputPath().
Definition at line 181 of file job.cpp.
References m_outputPath, and m_workingOutputPath.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CLI::IMPORT_COMMAND::doPerform(), API_HANDLER_PCB::handleRunBoardJobExport3D(), API_HANDLER_PCB::handleRunBoardJobExportDrill(), API_HANDLER_PCB::handleRunBoardJobExportDxf(), API_HANDLER_PCB::handleRunBoardJobExportGencad(), API_HANDLER_PCB::handleRunBoardJobExportGerbers(), API_HANDLER_PCB::handleRunBoardJobExportIdf(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), API_HANDLER_PCB::handleRunBoardJobExportIpcD356(), API_HANDLER_PCB::handleRunBoardJobExportODB(), API_HANDLER_PCB::handleRunBoardJobExportPdf(), API_HANDLER_PCB::handleRunBoardJobExportPng(), API_HANDLER_PCB::handleRunBoardJobExportPosition(), API_HANDLER_PCB::handleRunBoardJobExportPs(), API_HANDLER_PCB::handleRunBoardJobExportRender(), API_HANDLER_PCB::handleRunBoardJobExportSpecctraDsn(), API_HANDLER_PCB::handleRunBoardJobExportStats(), API_HANDLER_PCB::handleRunBoardJobExportSvg(), API_HANDLER_SCH::handleRunSchematicJobExportBOM(), API_HANDLER_SCH::handleRunSchematicJobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), DIALOG_EXPORT_ODBPP::populateJob(), JOBS_RUNNER::runSpecialArchive(), DIALOG_FIELDS_TABLE::saveJobSettings(), JOB_EXPORT_PCB_IDF::SetDefaultOutputPath(), JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath(), JOB_EXPORT_PCB_IPCD356::SetDefaultOutputPath(), JOB_EXPORT_PCB_ODB::SetDefaultOutputPath(), and JOB_EXPORT_PCB_POS::SetDefaultOutputPath().
|
inherited |
Sets the temporary output directory for the job, this is used to prefix with a given output path when GetFullOutputPath is called.
This is intended for use with running jobsets and otherwise has no impact on individual job runs outside jobsets.
Definition at line 86 of file job.cpp.
References m_tempOutputDirectory.
Referenced by BOOST_AUTO_TEST_CASE().
|
inlineinherited |
Definition at line 204 of file job.h.
References m_titleBlock.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), and PCBNEW_JOBS_HANDLER::resolveJobOutputPath().
|
inlineinherited |
Definition at line 199 of file job.h.
References m_varOverrides.
Referenced by CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().
|
inlineinherited |
Sets a transient output path for the job, it takes priority over the configured output path when GetFullOutputPath is called.
Definition at line 241 of file job.h.
References m_workingOutputPath.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIdf(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportSpecctraDsn(), PCBNEW_JOBS_HANDLER::JobExportStep(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCBNEW_JOBS_HANDLER::resolvePlotOutputPath(), JOB_EXPORT_PCB_STACKUP::SetDefaultOutputPath(), and JOB_EXPORT_PCB_STATS::SetDefaultOutputPath().
|
overridevirtual |
|
protectedinherited |
|
protectedinherited |
Definition at line 275 of file job.h.
Referenced by GetConfiguredOutputPath(), GetFullOutputPath(), JOB(), and SetConfiguredOutputPath().
|
protectedinherited |
Definition at line 276 of file job.h.
Referenced by GetFullOutputPath(), GetOutputPathIsDirectory(), and JOB().
|
protectedinherited |
Definition at line 287 of file job.h.
Referenced by AddOutput(), ClearExistingOutputs(), and GetOutputs().
|
protectedinherited |
Definition at line 285 of file job.h.
Referenced by FromJson(), GetParams(), JOB(), JOB_EXPORT_BOM::JOB_EXPORT_BOM(), JOB_EXPORT_PCB_3D::JOB_EXPORT_PCB_3D(), JOB_EXPORT_PCB_DXF::JOB_EXPORT_PCB_DXF(), JOB_EXPORT_PCB_GENCAD::JOB_EXPORT_PCB_GENCAD(), JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_GERBERS::JOB_EXPORT_PCB_GERBERS(), JOB_EXPORT_PCB_IDF::JOB_EXPORT_PCB_IDF(), JOB_EXPORT_PCB_IPC2581::JOB_EXPORT_PCB_IPC2581(), JOB_EXPORT_PCB_STACKUP::JOB_EXPORT_PCB_STACKUP(), JOB_EXPORT_PCB_STATS::JOB_EXPORT_PCB_STATS(), JOB_PCB_DRC::JOB_PCB_DRC(), JOB_PCB_RENDER::JOB_PCB_RENDER(), JOB_RC::JOB_RC(), JOB_SPECIAL_ARCHIVE::JOB_SPECIAL_ARCHIVE(), JOB_SPECIAL_COPYFILES::JOB_SPECIAL_COPYFILES(), JOB_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), ToJson(), and ~JOB().
|
private |
Definition at line 40 of file job_unknown.h.
Referenced by FromJson(), JOB_UNKNOWN(), and ToJson().
|
protectedinherited |
Definition at line 273 of file job.h.
Referenced by JOB(), ResolveOutputPath(), and SetTempOutputDirectory().
|
protectedinherited |
Definition at line 271 of file job.h.
Referenced by ResolveOutputPath(), and SetTitleBlock().
|
protectedinherited |
|
protectedinherited |
Definition at line 270 of file job.h.
Referenced by GetVarOverrides(), JOB(), and SetVarOverrides().
|
protectedinherited |
The working output path is a transient path that takes priority over the configured output path when determining where to write output files.
Definition at line 283 of file job.h.
Referenced by GetFullOutputPath(), GetWorkingOutputPath(), JOB(), SetConfiguredOutputPath(), and SetWorkingOutputPath().