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

#include <job_export_pcb_plot.h>

Inheritance diagram for JOB_EXPORT_PCB_PLOT:
JOB JOB_EXPORT_PCB_DXF JOB_EXPORT_PCB_GERBER JOB_EXPORT_PCB_PDF JOB_EXPORT_PCB_SVG JOB_EXPORT_PCB_GERBERS

Public Types

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

Public Member Functions

 JOB_EXPORT_PCB_PLOT (PLOT_FORMAT aFormat, const std::string &aType, bool aOutputIsDirectory)
 
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
 
virtual wxString GetDescription ()
 
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

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
 
bool m_plotPadNumbers
 
LSEQ m_printMaskLayer
 Layers to include on all individual layer prints.
 
LSEQ m_printMaskLayersToIncludeOnAllLayers
 
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_plot.h.

Member Enumeration Documentation

◆ PLOT_FORMAT

enum class JOB_EXPORT_PCB_PLOT::PLOT_FORMAT
strong
Enumerator
HPGL 
GERBER 
POST 
DXF 
PDF 
SVG 

Definition at line 33 of file job_export_pcb_plot.h.

Constructor & Destructor Documentation

◆ JOB_EXPORT_PCB_PLOT()

JOB_EXPORT_PCB_PLOT::JOB_EXPORT_PCB_PLOT ( PLOT_FORMAT  aFormat,
const std::string &  aType,
bool  aOutputIsDirectory 
)

Definition at line 5 of file job_export_pcb_plot.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::GetDescription ( )
virtualinherited

Reimplemented in JOB_EXPORT_PCB_3D, JOB_EXPORT_PCB_DRILL, JOB_EXPORT_PCB_DXF, JOB_EXPORT_PCB_GERBER, JOB_EXPORT_PCB_GERBERS, JOB_EXPORT_PCB_IPC2581, JOB_EXPORT_PCB_ODB, JOB_EXPORT_PCB_PDF, JOB_EXPORT_PCB_POS, JOB_EXPORT_PCB_SVG, JOB_EXPORT_SCH_BOM, JOB_EXPORT_SCH_NETLIST, JOB_EXPORT_SCH_PLOT_PDF, JOB_EXPORT_SCH_PLOT_DXF, JOB_EXPORT_SCH_PLOT_SVG, JOB_EXPORT_SCH_PLOT_PS, JOB_EXPORT_SCH_PLOT_HPGL, JOB_EXPORT_SCH_PYTHONBOM, JOB_PCB_DRC, JOB_SCH_ERC, and JOB_SPECIAL_EXECUTE.

Definition at line 67 of file job.cpp.

◆ 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_EXPORT_ODBPP::DIALOG_EXPORT_ODBPP(), DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), 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 134 of file job.cpp.

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

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581(), and PCBNEW_JOBS_HANDLER::JobExportOdb().

◆ SetOutputPath()

void JOB::SetOutputPath ( const wxString &  aPath)
inherited

Definition at line 128 of file job.cpp.

References JOB::m_outputPath.

Referenced by PCB_EDIT_FRAME::GenODBPPFiles(), 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::JobExportOdb(), 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_ODB::SetDefaultOutputPath(), JOB_EXPORT_PCB_POS::SetDefaultOutputPath(), DIALOG_SPECIAL_EXECUTE::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and DIALOG_EXPORT_ODBPP::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

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(), PCBNEW_JOBS_HANDLER::JobExportSvg(), DIALOG_PLOT::loadPlotParamsFromJob(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ m_colorTheme

wxString JOB_EXPORT_PCB_PLOT::m_colorTheme

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

Definition at line 61 of file job_export_pcb_plot.h.

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

◆ m_drawingSheet

wxString JOB_EXPORT_PCB_PLOT::m_drawingSheet

Definition at line 49 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_GERBER::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

Definition at line 74 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_filename

wxString JOB_EXPORT_PCB_PLOT::m_filename

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

Definition at line 59 of file job_export_pcb_plot.h.

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

◆ m_mirror

bool JOB_EXPORT_PCB_PLOT::m_mirror

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(), DIALOG_PLOT::loadPlotParamsFromJob(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ m_negative

bool JOB_EXPORT_PCB_PLOT::m_negative

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(), PCBNEW_JOBS_HANDLER::JobExportSvg(), DIALOG_PLOT::loadPlotParamsFromJob(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ 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_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

Definition at line 65 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_GERBER::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(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

◆ m_plotFootprintValues

bool JOB_EXPORT_PCB_PLOT::m_plotFootprintValues

Definition at line 63 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_GERBER::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

Definition at line 45 of file job_export_pcb_plot.h.

Referenced by DIALOG_PLOT::loadPlotParamsFromJob(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ m_plotPadNumbers

bool JOB_EXPORT_PCB_PLOT::m_plotPadNumbers

Definition at line 66 of file job_export_pcb_plot.h.

Referenced by DIALOG_PLOT::loadPlotParamsFromJob(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ m_plotRefDes

bool JOB_EXPORT_PCB_PLOT::m_plotRefDes

Definition at line 64 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_GERBER::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_printMaskLayer

LSEQ JOB_EXPORT_PCB_PLOT::m_printMaskLayer

Layers to include on all individual layer prints.

Definition at line 68 of file job_export_pcb_plot.h.

Referenced by JOB_EXPORT_PCB_GERBER::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(), DIALOG_PLOT::loadPlotParamsFromJob(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ m_printMaskLayersToIncludeOnAllLayers

LSEQ JOB_EXPORT_PCB_PLOT::m_printMaskLayersToIncludeOnAllLayers

Definition at line 70 of file job_export_pcb_plot.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportPdf(), DIALOG_PLOT::loadPlotParamsFromJob(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ m_sketchDNPFPsOnFabLayers

bool JOB_EXPORT_PCB_PLOT::m_sketchDNPFPsOnFabLayers

Definition at line 60 of file job_export_pcb_plot.h.

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

◆ m_sketchPadsOnFabLayers

bool JOB_EXPORT_PCB_PLOT::m_sketchPadsOnFabLayers

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(), PCBNEW_JOBS_HANDLER::JobExportSvg(), DIALOG_PLOT::loadPlotParamsFromJob(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ 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_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: