KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 { INCHES , MILLIMETERS }
 
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 (bool aIsCli)
 
wxString GetDescription () override
 
const std::string & GetType () const
 
bool IsCli () const
 
const std::map< wxString, wxString > & GetVarOverrides () const
 
void SetVarOverrides (const std::map< wxString, wxString > &aVarOverrides)
 
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)
 
void SetOutputPath (const wxString &aPath)
 
wxString GetOutputPath () const
 
wxString GetFullOutputPath () const
 
bool OutputPathFullSpecified () 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
 

Protected Attributes

std::string m_type
 
bool m_isCli
 
std::map< wxString, wxString > m_varOverrides
 
wxString m_tempOutputDirectory
 
wxString m_outputPath
 
bool m_outputPathIsDirectory
 
std::vector< JOB_PARAM_BASE * > m_params
 
std::vector< JOB_OUTPUTm_outputs
 

Detailed Description

Definition at line 29 of file job_export_pcb_drill.h.

Member Enumeration Documentation

◆ DRILL_FORMAT

Enumerator
EXCELLON 
GERBER 

Definition at line 43 of file job_export_pcb_drill.h.

◆ DRILL_ORIGIN

Enumerator
ABS 
PLOT 

Definition at line 51 of file job_export_pcb_drill.h.

◆ DRILL_UNITS

Enumerator
INCHES 
MILLIMETERS 

Definition at line 59 of file job_export_pcb_drill.h.

◆ MAP_FORMAT

Enumerator
POSTSCRIPT 
GERBER_X2 
DXF 
SVG 
PDF 

Definition at line 77 of file job_export_pcb_drill.h.

◆ ZEROS_FORMAT

Enumerator
DECIMAL 
SUPPRESS_LEADING 
SUPPRESS_TRAILING 
KEEP_ZEROS 

Definition at line 67 of file job_export_pcb_drill.h.

Constructor & Destructor Documentation

◆ JOB_EXPORT_PCB_DRILL()

JOB_EXPORT_PCB_DRILL::JOB_EXPORT_PCB_DRILL ( bool  aIsCli)

Member Function Documentation

◆ AddOutput()

void JOB::AddOutput ( wxString  aOutputPath)
inlineinherited

Definition at line 112 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

◆ ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )
inlineinherited

Definition at line 104 of file job.h.

Referenced by JOB_DISPATCHER::RunJob().

◆ FromJson()

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

Definition at line 54 of file job.cpp.

References JOB::m_params.

Referenced by from_json().

◆ GetDescription()

wxString JOB_EXPORT_PCB_DRILL::GetDescription ( )
overridevirtual

Reimplemented from JOB.

Definition at line 121 of file job_export_pcb_drill.cpp.

References _, and m_format.

◆ GetFullOutputPath()

◆ GetOutputPath()

◆ GetOutputs()

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

Definition at line 108 of file job.h.

◆ GetParams()

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

Definition at line 100 of file job.h.

◆ GetType()

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

Definition at line 85 of file job.h.

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

◆ GetVarOverrides()

◆ IsCli()

◆ OutputPathFullSpecified()

bool JOB::OutputPathFullSpecified ( ) const
inherited

◆ SetOutputPath()

◆ SetTempOutputDirectory()

void JOB::SetTempOutputDirectory ( const wxString &  aBase)
inherited

Definition at line 74 of file job.cpp.

References JOB::m_tempOutputDirectory.

◆ SetVarOverrides()

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

Definition at line 90 of file job.h.

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

◆ ToJson()

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

Definition at line 61 of file job.cpp.

References JOB::m_params.

Referenced by to_json().

Member Data Documentation

◆ m_drillOrigin

◆ m_drillUnits

◆ m_excellonCombinePTHNPTH

bool JOB_EXPORT_PCB_DRILL::m_excellonCombinePTHNPTH

◆ m_excellonMinimalHeader

bool JOB_EXPORT_PCB_DRILL::m_excellonMinimalHeader

◆ m_excellonMirrorY

bool JOB_EXPORT_PCB_DRILL::m_excellonMirrorY

◆ m_excellonOvalDrillRoute

bool JOB_EXPORT_PCB_DRILL::m_excellonOvalDrillRoute

◆ m_filename

wxString JOB_EXPORT_PCB_DRILL::m_filename

Definition at line 36 of file job_export_pcb_drill.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ m_format

◆ m_generateMap

bool JOB_EXPORT_PCB_DRILL::m_generateMap

Definition at line 90 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 88 of file job_export_pcb_drill.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ m_isCli

bool JOB::m_isCli
protectedinherited

Definition at line 128 of file job.h.

◆ m_mapFormat

◆ m_outputPath

wxString JOB::m_outputPath
protectedinherited

◆ m_outputPathIsDirectory

bool JOB::m_outputPathIsDirectory
protectedinherited

Definition at line 134 of file job.h.

Referenced by JOB::GetFullOutputPath(), JOB::JOB(), and JOB::OutputPathFullSpecified().

◆ m_outputs

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

Definition at line 138 of file job.h.

◆ m_params

◆ m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory
protectedinherited

Definition at line 131 of file job.h.

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

◆ m_type

std::string JOB::m_type
protectedinherited

Definition at line 127 of file job.h.

◆ m_varOverrides

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

Definition at line 129 of file job.h.

◆ m_zeroFormat


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