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

#include <job_export_pcb_drill.h>

Inheritance diagram for JOB_EXPORT_PCB_DRILL:
JOB

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 ,
  PDF
}
 

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
 

Detailed Description

Definition at line 28 of file job_export_pcb_drill.h.

Member Enumeration Documentation

◆ DRILL_FORMAT

enum class JOB_EXPORT_PCB_DRILL::DRILL_FORMAT
strong
Enumerator
EXCELLON 
GERBER 

Definition at line 36 of file job_export_pcb_drill.h.

◆ DRILL_ORIGIN

enum class JOB_EXPORT_PCB_DRILL::DRILL_ORIGIN
strong
Enumerator
ABS 
PLOT 

Definition at line 42 of file job_export_pcb_drill.h.

◆ DRILL_UNITS

enum class JOB_EXPORT_PCB_DRILL::DRILL_UNITS
strong
Enumerator
INCH 
MM 

Definition at line 48 of file job_export_pcb_drill.h.

◆ MAP_FORMAT

enum class JOB_EXPORT_PCB_DRILL::MAP_FORMAT
strong
Enumerator
POSTSCRIPT 
GERBER_X2 
DXF 
SVG 
PDF 

Definition at line 62 of file job_export_pcb_drill.h.

◆ ZEROS_FORMAT

enum class JOB_EXPORT_PCB_DRILL::ZEROS_FORMAT
strong
Enumerator
DECIMAL 
SUPPRESS_LEADING 
SUPPRESS_TRAILING 
KEEP_ZEROS 

Definition at line 54 of file job_export_pcb_drill.h.

Constructor & Destructor Documentation

◆ JOB_EXPORT_PCB_DRILL()

JOB_EXPORT_PCB_DRILL::JOB_EXPORT_PCB_DRILL ( )

Member Function Documentation

◆ AddOutput()

void JOB::AddOutput ( wxString aOutputPath)
inlineinherited

Definition at line 215 of file job.h.

References m_outputs.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

◆ ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )
inlineinherited

Definition at line 213 of file job.h.

References m_outputs.

Referenced by JOB_DISPATCHER::RunJob().

◆ FromJson()

void JOB::FromJson ( const nlohmann::json & j)
virtualinherited

Definition at line 60 of file job.cpp.

References m_params.

Referenced by from_json(), and from_json().

◆ GetConfiguredOutputPath()

wxString JOB::GetConfiguredOutputPath ( ) const
inlineinherited

Returns the configured output path for the job.

Definition at line 232 of file job.h.

References m_outputPath.

Referenced by 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(), and JOBS_RUNNER::runSpecialExecute().

◆ GetDefaultDescription()

wxString JOB_EXPORT_PCB_DRILL::GetDefaultDescription ( ) const
overridevirtual

Reimplemented from JOB.

Definition at line 126 of file job_export_pcb_drill.cpp.

References _.

◆ GetFullOutputPath()

wxString JOB::GetFullOutputPath ( PROJECT * aProject) const
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(), m_outputPath, m_outputPathIsDirectory, m_tempOutputDirectory, m_titleBlock, m_workingOutputPath, PrependDirectoryToPath(), and PROJECT::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().

◆ GetOutputPathIsDirectory()

bool JOB::GetOutputPathIsDirectory ( ) const
inlineinherited

Definition at line 253 of file job.h.

References m_outputPathIsDirectory.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ GetOutputs()

const std::vector< JOB_OUTPUT > & JOB::GetOutputs ( )
inlineinherited

Definition at line 214 of file job.h.

References m_outputs.

◆ GetParams()

const std::vector< JOB_PARAM_BASE * > & JOB::GetParams ( )
inlineinherited

Definition at line 211 of file job.h.

References m_params.

◆ GetSettingsDialogTitle()

wxString JOB_EXPORT_PCB_DRILL::GetSettingsDialogTitle ( ) const
overridevirtual

Reimplemented from JOB.

Definition at line 132 of file job_export_pcb_drill.cpp.

References _.

◆ GetType()

const std::string & JOB::GetType ( ) const
inlineinherited

Definition at line 194 of file job.h.

References m_type.

Referenced by JOB_DISPATCHER::HandleJobConfig(), PANEL_JOBSET::OpenJobOptionsForListItem(), and JOB_DISPATCHER::RunJob().

◆ GetVarOverrides()

const std::map< wxString, wxString > & JOB::GetVarOverrides ( ) const
inlineinherited

Definition at line 196 of file job.h.

References m_varOverrides.

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().

◆ GetWorkingOutputPath()

wxString JOB::GetWorkingOutputPath ( ) const
inlineinherited

Returns the working output path for the job, if one has been set.

Definition at line 243 of file job.h.

References m_workingOutputPath.

◆ SetConfiguredOutputPath()

void JOB::SetConfiguredOutputPath ( const wxString & aPath)
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 m_outputPath.

Referenced by BOARD_EDITOR_CONTROL::GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), JOBS_RUNNER::runSpecialExecute(), JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath(), JOB_EXPORT_PCB_IPCD356::SetDefaultOutputPath(), JOB_EXPORT_PCB_ODB::SetDefaultOutputPath(), and JOB_EXPORT_PCB_POS::SetDefaultOutputPath().

◆ SetTempOutputDirectory()

void JOB::SetTempOutputDirectory ( const wxString & aBase)
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.

◆ SetTitleBlock()

void JOB::SetTitleBlock ( const TITLE_BLOCK & aTitleBlock)
inlineinherited

Definition at line 203 of file job.h.

References m_titleBlock.

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().

◆ SetVarOverrides()

void JOB::SetVarOverrides ( const std::map< wxString, wxString > & aVarOverrides)
inlineinherited

Definition at line 198 of file job.h.

References m_varOverrides.

Referenced by CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

◆ SetWorkingOutputPath()

void JOB::SetWorkingOutputPath ( const wxString & aPath)
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.

References m_workingOutputPath.

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().

◆ ToJson()

void JOB::ToJson ( nlohmann::json & j) const
virtualinherited

Definition at line 67 of file job.cpp.

References m_params.

Referenced by to_json().

Member Data Documentation

◆ m_description

wxString JOB::m_description
protectedinherited

Definition at line 264 of file job.h.

Referenced by JOB().

◆ m_drillOrigin

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().

◆ m_drillUnits

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().

◆ m_excellonCombinePTHNPTH

bool JOB_EXPORT_PCB_DRILL::m_excellonCombinePTHNPTH

Definition at line 76 of file job_export_pcb_drill.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ m_excellonMinimalHeader

bool JOB_EXPORT_PCB_DRILL::m_excellonMinimalHeader

Definition at line 75 of file job_export_pcb_drill.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ m_excellonMirrorY

bool JOB_EXPORT_PCB_DRILL::m_excellonMirrorY

Definition at line 74 of file job_export_pcb_drill.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ m_excellonOvalDrillRoute

bool JOB_EXPORT_PCB_DRILL::m_excellonOvalDrillRoute

Definition at line 77 of file job_export_pcb_drill.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ m_filename

wxString JOB_EXPORT_PCB_DRILL::m_filename

Definition at line 72 of file job_export_pcb_drill.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ m_format

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().

◆ m_generateMap

bool JOB_EXPORT_PCB_DRILL::m_generateMap

Definition at line 86 of file job_export_pcb_drill.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ m_generateTenting

bool JOB_EXPORT_PCB_DRILL::m_generateTenting

Definition at line 88 of file job_export_pcb_drill.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ m_gerberPrecision

int JOB_EXPORT_PCB_DRILL::m_gerberPrecision

Definition at line 85 of file job_export_pcb_drill.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ m_mapFormat

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().

◆ m_outputPath

wxString JOB::m_outputPath
protectedinherited

Definition at line 262 of file job.h.

Referenced by GetConfiguredOutputPath(), GetFullOutputPath(), JOB(), and SetConfiguredOutputPath().

◆ m_outputPathIsDirectory

bool JOB::m_outputPathIsDirectory
protectedinherited

Definition at line 263 of file job.h.

Referenced by GetFullOutputPath(), GetOutputPathIsDirectory(), and JOB().

◆ m_outputs

std::vector<JOB_OUTPUT> JOB::m_outputs
protectedinherited

Definition at line 269 of file job.h.

Referenced by AddOutput(), ClearExistingOutputs(), and GetOutputs().

◆ m_params

std::vector<JOB_PARAM_BASE*> JOB::m_params
protectedinherited

Definition at line 267 of file job.h.

Referenced by FromJson(), GetParams(), JOB(), 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_IPC2581::JOB_EXPORT_PCB_IPC2581(), JOB_EXPORT_PCB_ODB::JOB_EXPORT_PCB_ODB(), JOB_EXPORT_SCH_BOM::JOB_EXPORT_SCH_BOM(), JOB_PCB_DRC::JOB_PCB_DRC(), JOB_PCB_RENDER::JOB_PCB_RENDER(), JOB_RC::JOB_RC(), JOB_SPECIAL_COPYFILES::JOB_SPECIAL_COPYFILES(), JOB_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), ToJson(), and ~JOB().

◆ m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory
protectedinherited

Definition at line 260 of file job.h.

Referenced by GetFullOutputPath(), JOB(), and SetTempOutputDirectory().

◆ m_titleBlock

TITLE_BLOCK JOB::m_titleBlock
protectedinherited

Definition at line 258 of file job.h.

Referenced by GetFullOutputPath(), and SetTitleBlock().

◆ m_type

std::string JOB::m_type
protectedinherited

Definition at line 256 of file job.h.

Referenced by GetType(), and JOB().

◆ m_varOverrides

std::map<wxString, wxString> JOB::m_varOverrides
protectedinherited

Definition at line 257 of file job.h.

Referenced by GetVarOverrides(), JOB(), and SetVarOverrides().

◆ m_workingOutputPath

wxString JOB::m_workingOutputPath
protectedinherited

Definition at line 265 of file job.h.

Referenced by GetFullOutputPath(), GetWorkingOutputPath(), JOB(), and SetWorkingOutputPath().

◆ m_zeroFormat

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().

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