JOB_EXPORT_PCB_GERBER Class Reference

#include <job_export_pcb_gerber.h>

Inheritance diagram for JOB_EXPORT_PCB_GERBER:

Public Types
enum class	PLOT_FORMAT {   HPGL , GERBER , POST , DXF ,   PDF , SVG }

Public Member Functions
	JOB_EXPORT_PCB_GERBER (const std::string &aType)
	JOB_EXPORT_PCB_GERBER ()
wxString	GetDescription () override
const std::string &	GetType () 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
bool	m_subtractSolderMaskFromSilk
bool	m_includeNetlistAttributes
bool	m_useX2Format
bool	m_disableApertureMacros
bool	m_useAuxOrigin
bool	m_useProtelFileExtension
int	m_precision
PLOT_FORMAT	m_plotFormat
wxString	m_filename
wxString	m_colorTheme
wxString	m_drawingSheet
bool	m_mirror
	Common Options.
bool	m_blackAndWhite
bool	m_negative
bool	m_sketchPadsOnFabLayers
bool	m_hideDNPFPsOnFabLayers
bool	m_sketchDNPFPsOnFabLayers
bool	m_crossoutDNPFPsOnFabLayers
bool	m_plotFootprintValues
bool	m_plotRefDes
bool	m_plotDrawingSheet
LSEQ	m_printMaskLayer
int	m_drillShapeOption

Protected Attributes
std::string	m_type
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_OUTPUT >	m_outputs

Detailed Description

Definition at line 30 of file job_export_pcb_gerber.h.

Member Enumeration Documentation

PLOT_FORMAT

enum class JOB_EXPORT_PCB_PLOT::PLOT_FORMAT

stronginherited

Enumerator
HPGL
GERBER
POST
DXF
PDF
SVG

Definition at line 33 of file job_export_pcb_plot.h.

Constructor & Destructor Documentation

JOB_EXPORT_PCB_GERBER() [1/2]

JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER

(

const std::string &

aType

)

Definition at line 26 of file job_export_pcb_gerber.cpp.

References m_disableApertureMacros, JOB_EXPORT_PCB_PLOT::m_drawingSheet, m_includeNetlistAttributes, JOB::m_params, JOB_EXPORT_PCB_PLOT::m_plotDrawingSheet, JOB_EXPORT_PCB_PLOT::m_plotFootprintValues, JOB_EXPORT_PCB_PLOT::m_plotRefDes, m_precision, JOB_EXPORT_PCB_PLOT::m_printMaskLayer, m_subtractSolderMaskFromSilk, m_useAuxOrigin, m_useProtelFileExtension, and m_useX2Format.

JOB_EXPORT_PCB_GERBER() [2/2]

JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER

(

)

Definition at line 74 of file job_export_pcb_gerber.cpp.

Member Function Documentation

AddOutput()

void JOB::AddOutput ( wxString  aOutputPath )

inlineinherited

Definition at line 111 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )

inlineinherited

Definition at line 103 of file job.h.

Referenced by JOB_DISPATCHER::RunJob().

FromJson()

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

virtualinherited

Definition at line 53 of file job.cpp.

References JOB::m_params.

Referenced by from_json().

GetDescription()

wxString JOB_EXPORT_PCB_GERBER::GetDescription ( )

overridevirtual

Reimplemented from JOB.

Reimplemented in JOB_EXPORT_PCB_GERBERS.

Definition at line 80 of file job_export_pcb_gerber.cpp.

References _.

GetFullOutputPath()

wxString JOB::GetFullOutputPath ( ) const

inherited

Definition at line 87 of file job.cpp.

References JOB::m_outputPath, JOB::m_outputPathIsDirectory, JOB::m_tempOutputDirectory, and PrependDirectoryToPath().

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and JOBS_RUNNER::runSpecialExecute().

GetOutputPath()

wxString JOB::GetOutputPath ( ) const

inlineinherited

Definition at line 119 of file job.h.

Referenced by DIALOG_EXPORT_2581::DIALOG_EXPORT_2581(), DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_GENDRILL::InitDisplayParams(), DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), and PCBNEW_JOBS_HANDLER::JobExportStep().

GetOutputs()

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

inlineinherited

Definition at line 107 of file job.h.

GetParams()

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

inlineinherited

Definition at line 99 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()

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

inlineinherited

Definition at line 87 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(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and EESCHEMA_JOBS_HANDLER::JobSchErc().

OutputPathFullSpecified()

bool JOB::OutputPathFullSpecified ( ) const

inherited

Definition at line 135 of file job.cpp.

References JOB::m_outputPath, and JOB::m_outputPathIsDirectory.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581().

SetOutputPath()

void JOB::SetOutputPath ( const wxString &  aPath )

inherited

Definition at line 129 of file job.cpp.

References JOB::m_outputPath.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportStep(), DIALOG_EXPORT_NETLIST::NetlistUpdateOpt(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GENDRILL::OnGenDrillFile(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath(), JOB_EXPORT_PCB_POS::SetDefaultOutputPath(), DIALOG_SPECIAL_EXECUTE::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataFromWindow().

SetTempOutputDirectory()

void JOB::SetTempOutputDirectory ( const wxString &  aBase )

inherited

Definition at line 73 of file job.cpp.

References JOB::m_tempOutputDirectory.

SetVarOverrides()

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

inlineinherited

Definition at line 89 of file job.h.

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

ToJson()

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

virtualinherited

Definition at line 60 of file job.cpp.

References JOB::m_params.

Referenced by to_json().

Member Data Documentation

m_blackAndWhite

bool JOB_EXPORT_PCB_PLOT::m_blackAndWhite

inherited

Definition at line 55 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), JOB_EXPORT_PCB_SVG::JOB_EXPORT_PCB_SVG(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and PCBNEW_JOBS_HANDLER::JobExportSvg().

m_colorTheme

wxString JOB_EXPORT_PCB_PLOT::m_colorTheme

inherited

Definition at line 48 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), JOB_EXPORT_PCB_SVG::JOB_EXPORT_PCB_SVG(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and PCBNEW_JOBS_HANDLER::JobExportSvg().

m_crossoutDNPFPsOnFabLayers

bool JOB_EXPORT_PCB_PLOT::m_crossoutDNPFPsOnFabLayers

inherited

Definition at line 61 of file job_export_pcb_plot.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and DIALOG_PLOT::updateJobFromDialog().

m_disableApertureMacros

bool JOB_EXPORT_PCB_GERBER::m_disableApertureMacros

Definition at line 40 of file job_export_pcb_gerber.h.

Referenced by JOB_EXPORT_PCB_GERBER(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_drawingSheet

wxString JOB_EXPORT_PCB_PLOT::m_drawingSheet

inherited

Definition at line 49 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), JOB_EXPORT_PCB_SVG::JOB_EXPORT_PCB_SVG(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_drillShapeOption

int JOB_EXPORT_PCB_PLOT::m_drillShapeOption

inherited

Definition at line 71 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), JOB_EXPORT_PCB_SVG::JOB_EXPORT_PCB_SVG(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and DIALOG_PLOT::updateJobFromDialog().

m_filename

wxString JOB_EXPORT_PCB_PLOT::m_filename

inherited

Definition at line 47 of file job_export_pcb_plot.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_hideDNPFPsOnFabLayers

bool JOB_EXPORT_PCB_PLOT::m_hideDNPFPsOnFabLayers

inherited

Definition at line 59 of file job_export_pcb_plot.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and DIALOG_PLOT::updateJobFromDialog().

m_includeNetlistAttributes

bool JOB_EXPORT_PCB_GERBER::m_includeNetlistAttributes

Definition at line 38 of file job_export_pcb_gerber.h.

Referenced by JOB_EXPORT_PCB_GERBER(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_mirror

bool JOB_EXPORT_PCB_PLOT::m_mirror

inherited

Common Options.

Definition at line 54 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), JOB_EXPORT_PCB_SVG::JOB_EXPORT_PCB_SVG(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and DIALOG_PLOT::updateJobFromDialog().

m_negative

bool JOB_EXPORT_PCB_PLOT::m_negative

inherited

Definition at line 56 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), JOB_EXPORT_PCB_SVG::JOB_EXPORT_PCB_SVG(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and PCBNEW_JOBS_HANDLER::JobExportSvg().

m_outputPath

wxString JOB::m_outputPath

protectedinherited

Definition at line 131 of file job.h.

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

m_outputPathIsDirectory

bool JOB::m_outputPathIsDirectory

protectedinherited

Definition at line 132 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 136 of file job.h.

m_params

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

protectedinherited

Definition at line 134 of file job.h.

Referenced by JOB::FromJson(), JOB::JOB(), JOB_EXPORT_PCB_3D::JOB_EXPORT_PCB_3D(), JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_GERBERS::JOB_EXPORT_PCB_GERBERS(), JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), JOB_EXPORT_PCB_SVG::JOB_EXPORT_PCB_SVG(), JOB_EXPORT_SCH_BOM::JOB_EXPORT_SCH_BOM(), JOB_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), JOB::ToJson(), and JOB::~JOB().

m_plotDrawingSheet

bool JOB_EXPORT_PCB_PLOT::m_plotDrawingSheet

inherited

Definition at line 65 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), JOB_EXPORT_PCB_SVG::JOB_EXPORT_PCB_SVG(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), and DIALOG_PLOT::updateJobFromDialog().

m_plotFootprintValues

bool JOB_EXPORT_PCB_PLOT::m_plotFootprintValues

inherited

Definition at line 63 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_plotFormat

PLOT_FORMAT JOB_EXPORT_PCB_PLOT::m_plotFormat

inherited

Definition at line 45 of file job_export_pcb_plot.h.

Referenced by DIALOG_PLOT::init_Dialog().

m_plotRefDes

bool JOB_EXPORT_PCB_PLOT::m_plotRefDes

inherited

Definition at line 64 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_precision

int JOB_EXPORT_PCB_GERBER::m_precision

Definition at line 44 of file job_export_pcb_gerber.h.

Referenced by JOB_EXPORT_PCB_GERBER(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_printMaskLayer

LSEQ JOB_EXPORT_PCB_PLOT::m_printMaskLayer

inherited

Definition at line 67 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), JOB_EXPORT_PCB_SVG::JOB_EXPORT_PCB_SVG(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_sketchDNPFPsOnFabLayers

bool JOB_EXPORT_PCB_PLOT::m_sketchDNPFPsOnFabLayers

inherited

Definition at line 60 of file job_export_pcb_plot.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and DIALOG_PLOT::updateJobFromDialog().

m_sketchPadsOnFabLayers

bool JOB_EXPORT_PCB_PLOT::m_sketchPadsOnFabLayers

inherited

Definition at line 58 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_PDF::JOB_EXPORT_PCB_PDF(), JOB_EXPORT_PCB_SVG::JOB_EXPORT_PCB_SVG(), PCBNEW_JOBS_HANDLER::JobExportPdf(), and PCBNEW_JOBS_HANDLER::JobExportSvg().

m_subtractSolderMaskFromSilk

bool JOB_EXPORT_PCB_GERBER::m_subtractSolderMaskFromSilk

Definition at line 37 of file job_export_pcb_gerber.h.

Referenced by JOB_EXPORT_PCB_GERBER(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory

protectedinherited

Definition at line 129 of file job.h.

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

m_type

std::string JOB::m_type

protectedinherited

Definition at line 126 of file job.h.

m_useAuxOrigin

bool JOB_EXPORT_PCB_GERBER::m_useAuxOrigin

Definition at line 41 of file job_export_pcb_gerber.h.

Referenced by JOB_EXPORT_PCB_GERBER(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_useProtelFileExtension

bool JOB_EXPORT_PCB_GERBER::m_useProtelFileExtension

Definition at line 42 of file job_export_pcb_gerber.h.

Referenced by JOB_EXPORT_PCB_GERBER(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_useX2Format

bool JOB_EXPORT_PCB_GERBER::m_useX2Format

Definition at line 39 of file job_export_pcb_gerber.h.

Referenced by JOB_EXPORT_PCB_GERBER(), PCBNEW_JOBS_HANDLER::populateGerberPlotOptionsFromJob(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

m_varOverrides

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

protectedinherited

Definition at line 127 of file job.h.

---

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

• job_export_pcb_gerber.h
• job_export_pcb_gerber.cpp