KiCad PCB EDA Suite
|
#include <job_export_pcb_drill.h>
Public Types | |
enum class | DRILL_FORMAT { EXCELLON , GERBER } |
enum class | DRILL_ORIGIN { ABS , PLOT } |
enum class | DRILL_UNITS { INCH , MM } |
enum class | ZEROS_FORMAT { DECIMAL , SUPPRESS_LEADING , SUPPRESS_TRAILING , KEEP_ZEROS } |
enum class | MAP_FORMAT { POSTSCRIPT , GERBER_X2 , DXF , SVG , } |
Public Member Functions | |
JOB_EXPORT_PCB_DRILL () | |
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_excellonMirrorY |
bool | m_excellonMinimalHeader |
bool | m_excellonCombinePTHNPTH |
bool | m_excellonOvalDrillRoute |
DRILL_FORMAT | m_format |
DRILL_ORIGIN | m_drillOrigin |
DRILL_UNITS | m_drillUnits |
ZEROS_FORMAT | m_zeroFormat |
MAP_FORMAT | m_mapFormat |
int | m_gerberPrecision |
bool | m_generateMap |
bool | m_generateTenting |
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 28 of file job_export_pcb_drill.h.
|
strong |
Enumerator | |
---|---|
EXCELLON | |
GERBER |
Definition at line 36 of file job_export_pcb_drill.h.
|
strong |
Enumerator | |
---|---|
ABS | |
PLOT |
Definition at line 42 of file job_export_pcb_drill.h.
|
strong |
Enumerator | |
---|---|
INCH | |
MM |
Definition at line 48 of file job_export_pcb_drill.h.
|
strong |
Enumerator | |
---|---|
POSTSCRIPT | |
GERBER_X2 | |
DXF | |
SVG | |
Definition at line 62 of file job_export_pcb_drill.h.
|
strong |
Enumerator | |
---|---|
DECIMAL | |
SUPPRESS_LEADING | |
SUPPRESS_TRAILING | |
KEEP_ZEROS |
Definition at line 54 of file job_export_pcb_drill.h.
JOB_EXPORT_PCB_DRILL::JOB_EXPORT_PCB_DRILL | ( | ) |
|
inlineinherited |
Definition at line 210 of file job.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().
|
inlineinherited |
Definition at line 208 of file job.h.
Referenced by JOB_DISPATCHER::RunJob().
|
virtualinherited |
|
inlineinherited |
Returns the configured output path for the job.
Definition at line 227 of file job.h.
Referenced by DIALOG_EXPORT_2581::DIALOG_EXPORT_2581(), DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_EXPORT_ODBPP::DIALOG_EXPORT_ODBPP(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_EXPORT_ODBPP::Init(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_PLOT_SCHEMATIC::initDlg(), 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_EXECUTECOMMAND_JOB_SETTINGS::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 248 of file job.h.
Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().
|
inlineinherited |
|
inlineinherited |
|
overridevirtual |
Reimplemented from JOB.
Definition at line 132 of file job_export_pcb_drill.cpp.
References _.
Referenced by DIALOG_GENDRILL::initDialog().
|
inlineinherited |
Definition at line 189 of file job.h.
Referenced by JOB_DISPATCHER::HandleJobConfig(), and JOB_DISPATCHER::RunJob().
|
inlineinherited |
Definition at line 191 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_NETLIST::NetlistUpdateOpt(), 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_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 198 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 193 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 233 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 259 of file job.h.
Referenced by JOB::JOB().
DRILL_ORIGIN JOB_EXPORT_PCB_DRILL::m_drillOrigin |
Definition at line 80 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_GENDRILL::TransferDataToWindow().
DRILL_UNITS JOB_EXPORT_PCB_DRILL::m_drillUnits |
Definition at line 81 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_GENDRILL::TransferDataToWindow().
bool JOB_EXPORT_PCB_DRILL::m_excellonCombinePTHNPTH |
Definition at line 76 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_GENDRILL::TransferDataToWindow().
bool JOB_EXPORT_PCB_DRILL::m_excellonMinimalHeader |
Definition at line 75 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_GENDRILL::TransferDataToWindow().
bool JOB_EXPORT_PCB_DRILL::m_excellonMirrorY |
Definition at line 74 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_GENDRILL::TransferDataToWindow().
bool JOB_EXPORT_PCB_DRILL::m_excellonOvalDrillRoute |
Definition at line 77 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_GENDRILL::TransferDataToWindow().
wxString JOB_EXPORT_PCB_DRILL::m_filename |
Definition at line 72 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().
DRILL_FORMAT JOB_EXPORT_PCB_DRILL::m_format |
Definition at line 79 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_GENDRILL::TransferDataToWindow().
bool JOB_EXPORT_PCB_DRILL::m_generateMap |
Definition at line 86 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_GENDRILL::TransferDataToWindow().
bool JOB_EXPORT_PCB_DRILL::m_generateTenting |
Definition at line 88 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_GENDRILL::TransferDataToWindow().
int JOB_EXPORT_PCB_DRILL::m_gerberPrecision |
Definition at line 85 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().
MAP_FORMAT JOB_EXPORT_PCB_DRILL::m_mapFormat |
Definition at line 84 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_GENDRILL::TransferDataToWindow().
|
protectedinherited |
Definition at line 257 of file job.h.
Referenced by JOB::GetFullOutputPath(), JOB::JOB(), and JOB::SetConfiguredOutputPath().
|
protectedinherited |
Definition at line 258 of file job.h.
Referenced by JOB::GetFullOutputPath(), and JOB::JOB().
|
protectedinherited |
|
protectedinherited |
Definition at line 262 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_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().
|
protectedinherited |
Definition at line 255 of file job.h.
Referenced by JOB::GetFullOutputPath(), and JOB::SetTempOutputDirectory().
|
protectedinherited |
Definition at line 253 of file job.h.
Referenced by JOB::GetFullOutputPath().
|
protectedinherited |
|
protectedinherited |
Definition at line 260 of file job.h.
Referenced by JOB::GetFullOutputPath().
ZEROS_FORMAT JOB_EXPORT_PCB_DRILL::m_zeroFormat |
Definition at line 82 of file job_export_pcb_drill.h.
Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_GENDRILL::TransferDataToWindow().