KiCad PCB EDA Suite
|
#include <job_export_pcb_gencad.h>
Public Member Functions | |
JOB_EXPORT_PCB_GENCAD () | |
wxString | GetDefaultDescription () const override |
wxString | GetSettingsDialogTitle () 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 void | FromJson (const nlohmann::json &j) |
virtual void | ToJson (nlohmann::json &j) 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. | |
bool | GetOutputPathIsDirectory () const |
Public Attributes | |
wxString | m_filename |
bool | m_flipBottomPads |
bool | m_useIndividualShapes |
bool | m_storeOriginCoords |
bool | m_useDrillOrigin |
bool | m_useUniquePins |
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 |
std::vector< JOB_PARAM_BASE * > | m_params |
std::vector< JOB_OUTPUT > | m_outputs |
Definition at line 29 of file job_export_pcb_gencad.h.
JOB_EXPORT_PCB_GENCAD::JOB_EXPORT_PCB_GENCAD | ( | ) |
Definition at line 26 of file job_export_pcb_gencad.cpp.
References m_flipBottomPads, JOB::m_params, m_storeOriginCoords, m_useDrillOrigin, m_useIndividualShapes, and m_useUniquePins.
|
inlineinherited |
Definition at line 215 of file job.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().
|
inlineinherited |
Definition at line 213 of file job.h.
Referenced by JOB_DISPATCHER::RunJob().
|
virtualinherited |
|
inlineinherited |
Returns the configured output path for the job.
Definition at line 232 of file job.h.
Referenced by DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCB_PLOTTER::PlotJobToPlotOpts(), JOBS_RUNNER::runSpecialExecute(), DIALOG_RC_JOB::TransferDataToWindow(), DIALOG_PLOT_SCHEMATIC::TransferDataToWindow(), DIALOG_EXECUTECOMMAND_JOB_SETTINGS::TransferDataToWindow(), DIALOG_EXPORT_2581::TransferDataToWindow(), DIALOG_EXPORT_ODBPP::TransferDataToWindow(), DIALOG_EXPORT_STEP::TransferDataToWindow(), DIALOG_GEN_FOOTPRINT_POSITION::TransferDataToWindow(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataToWindow(), DIALOG_GENDRILL::TransferDataToWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().
|
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 100 of file job.cpp.
References ExpandTextVars(), JOB::m_outputPath, JOB::m_outputPathIsDirectory, JOB::m_tempOutputDirectory, JOB::m_titleBlock, JOB::m_workingOutputPath, PrependDirectoryToPath(), PROJECT::TextVarResolver(), and TITLE_BLOCK::TextVarResolver().
Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSchErc(), JOBS_RUNNER::runSpecialCopyFiles(), and JOBS_RUNNER::runSpecialExecute().
|
inlineinherited |
Definition at line 253 of file job.h.
Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().
|
inlineinherited |
|
inlineinherited |
|
overridevirtual |
Reimplemented from JOB.
Definition at line 53 of file job_export_pcb_gencad.cpp.
References _.
Referenced by PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER().
|
inlineinherited |
Definition at line 194 of file job.h.
Referenced by JOB_DISPATCHER::HandleJobConfig(), and JOB_DISPATCHER::RunJob().
|
inlineinherited |
Definition at line 196 of file job.h.
Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and EESCHEMA_JOBS_HANDLER::JobSchErc().
|
inlineinherited |
|
inherited |
Sets the configured output path for the job, this path is always saved to file.
Definition at line 153 of file job.cpp.
References JOB::m_outputPath.
Referenced by BOARD_EDITOR_CONTROL::GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GEN_FOOTPRINT_POSITION::onGenerate(), DIALOG_SYMBOL_FIELDS_TABLE::OnOk(), DIALOG_PLOT_SCHEMATIC::OnPlotAll(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), JOBS_RUNNER::runSpecialExecute(), JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath(), JOB_EXPORT_PCB_IPCD356::SetDefaultOutputPath(), JOB_EXPORT_PCB_ODB::SetDefaultOutputPath(), JOB_EXPORT_PCB_POS::SetDefaultOutputPath(), DIALOG_RC_JOB::TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_EXECUTECOMMAND_JOB_SETTINGS::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), DIALOG_EXPORT_ODBPP::TransferDataFromWindow(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataFromWindow(), DIALOG_GENDRILL::TransferDataFromWindow(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_PLOT::transferPlotParamsToJob().
|
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 JOB::m_tempOutputDirectory.
|
inlineinherited |
Definition at line 203 of file job.h.
Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and EESCHEMA_JOBS_HANDLER::JobSchErc().
|
inlineinherited |
Definition at line 198 of file job.h.
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 238 of file job.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), and PCBNEW_JOBS_HANDLER::JobExportSvg().
|
virtualinherited |
|
protectedinherited |
Definition at line 264 of file job.h.
Referenced by JOB::JOB().
wxString JOB_EXPORT_PCB_GENCAD::m_filename |
Definition at line 36 of file job_export_pcb_gencad.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportGencad().
bool JOB_EXPORT_PCB_GENCAD::m_flipBottomPads |
Definition at line 38 of file job_export_pcb_gencad.h.
Referenced by JOB_EXPORT_PCB_GENCAD(), PCBNEW_JOBS_HANDLER::JobExportGencad(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataFromWindow(), and DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataToWindow().
|
protectedinherited |
Definition at line 262 of file job.h.
Referenced by JOB::GetFullOutputPath(), JOB::JOB(), and JOB::SetConfiguredOutputPath().
|
protectedinherited |
Definition at line 263 of file job.h.
Referenced by JOB::GetFullOutputPath(), and JOB::JOB().
|
protectedinherited |
|
protectedinherited |
Definition at line 267 of file job.h.
Referenced by JOB::FromJson(), JOB::JOB(), JOB_EXPORT_PCB_3D::JOB_EXPORT_PCB_3D(), JOB_EXPORT_PCB_GENCAD(), JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_GERBERS::JOB_EXPORT_PCB_GERBERS(), JOB_EXPORT_SCH_BOM::JOB_EXPORT_SCH_BOM(), JOB_PCB_DRC::JOB_PCB_DRC(), JOB_SPECIAL_COPYFILES::JOB_SPECIAL_COPYFILES(), JOB_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), JOB::ToJson(), and JOB::~JOB().
bool JOB_EXPORT_PCB_GENCAD::m_storeOriginCoords |
Definition at line 40 of file job_export_pcb_gencad.h.
Referenced by JOB_EXPORT_PCB_GENCAD(), PCBNEW_JOBS_HANDLER::JobExportGencad(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataFromWindow(), and DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataToWindow().
|
protectedinherited |
Definition at line 260 of file job.h.
Referenced by JOB::GetFullOutputPath(), and JOB::SetTempOutputDirectory().
|
protectedinherited |
Definition at line 258 of file job.h.
Referenced by JOB::GetFullOutputPath().
bool JOB_EXPORT_PCB_GENCAD::m_useDrillOrigin |
Definition at line 41 of file job_export_pcb_gencad.h.
Referenced by JOB_EXPORT_PCB_GENCAD(), PCBNEW_JOBS_HANDLER::JobExportGencad(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataFromWindow(), and DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataToWindow().
bool JOB_EXPORT_PCB_GENCAD::m_useIndividualShapes |
Definition at line 39 of file job_export_pcb_gencad.h.
Referenced by JOB_EXPORT_PCB_GENCAD(), PCBNEW_JOBS_HANDLER::JobExportGencad(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataFromWindow(), and DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataToWindow().
bool JOB_EXPORT_PCB_GENCAD::m_useUniquePins |
Definition at line 42 of file job_export_pcb_gencad.h.
Referenced by JOB_EXPORT_PCB_GENCAD(), PCBNEW_JOBS_HANDLER::JobExportGencad(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataFromWindow(), and DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataToWindow().
|
protectedinherited |
|
protectedinherited |
Definition at line 265 of file job.h.
Referenced by JOB::GetFullOutputPath().