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

#include <job_export_pcb_fab.h>

Inheritance diagram for JOB_EXPORT_PCB_FAB:
JOB JOB_EXPORT_PCB_IPC2581 JOB_EXPORT_PCB_ODB

Public Types

enum class  UNITS { MM , INCH }
 
enum class  DATA_SET {
  USERDEF , BOM , STACKUP , FABRICATION ,
  ASSEMBLY , TEST , STENCIL , DFX ,
  COUNT
}
 Columns of the IPC-2581C function mode table, Table 4 p 80. More...
 
enum class  NET_NAMES { INCLUDE , ANONYMIZE }
 An anonymous name keeps the connections. More...
 

Public Member Functions

virtual bool SupportsDataSet (DATA_SET aDataSet) const =0
 
void FromJson (const nlohmann::json &aJson) override
 
void ToJson (nlohmann::json &aJson) 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 wxString GetDefaultDescription () const
 
virtual wxString GetSettingsDialogTitle () 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.
 
wxString ResolveOutputPath (const wxString &aPath, bool aPathIsDirectory, PROJECT *aProject) const
 
bool GetOutputPathIsDirectory () const
 

Static Public Member Functions

static DATA_SET DataSetFromToken (const wxString &aToken)
 Read a data set token in upper case or in lower case An empty token is USERDEF.
 
static std::string DataSetToken (DATA_SET aDataSet)
 Lower case token that the job file and the CLI use for aDataSet Empty when it has none.
 

Public Attributes

wxString m_filename
 
wxString m_drawingSheet
 
std::vector< wxString > m_variantNames
 
UNITS m_units = UNITS::MM
 
int m_precision = 6
 
bool m_checkZonesBeforeExport = false
 
wxString m_colMfgPn
 
DATA_SET m_dataSet = DATA_SET::USERDEF
 
std::optional< wxString > m_sections
 Section key that replaces the optional sections of the data set Unset lets the data set select them and an empty key selects none.
 
NET_NAMES m_netNames = NET_NAMES::INCLUDE
 

Protected Member Functions

 JOB_EXPORT_PCB_FAB (const std::string &aType)
 

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
 The working output path is a transient path that takes priority over the configured output path when determining where to write output files.
 
std::vector< JOB_PARAM_BASE * > m_params
 
std::vector< JOB_OUTPUT > m_outputs
 

Detailed Description

Definition at line 30 of file job_export_pcb_fab.h.

Member Enumeration Documentation

◆ DATA_SET

enum class JOB_EXPORT_PCB_FAB::DATA_SET
strong

Columns of the IPC-2581C function mode table, Table 4 p 80.

The order indexes that table. COUNT also marks a token that no data set matches

Enumerator
USERDEF 
BOM 
STACKUP 
FABRICATION 
ASSEMBLY 
TEST 
STENCIL 
DFX 
COUNT 

Definition at line 44 of file job_export_pcb_fab.h.

◆ NET_NAMES

enum class JOB_EXPORT_PCB_FAB::NET_NAMES
strong

An anonymous name keeps the connections.

Enumerator
INCLUDE 
ANONYMIZE 

Definition at line 59 of file job_export_pcb_fab.h.

◆ UNITS

enum class JOB_EXPORT_PCB_FAB::UNITS
strong
Enumerator
MM 
INCH 

Definition at line 33 of file job_export_pcb_fab.h.

Constructor & Destructor Documentation

◆ JOB_EXPORT_PCB_FAB()

JOB_EXPORT_PCB_FAB::JOB_EXPORT_PCB_FAB ( const std::string & aType)
explicitprotected

Referenced by JOB_EXPORT_PCB_IPC2581::JOB_EXPORT_PCB_IPC2581().

Member Function Documentation

◆ AddOutput()

void JOB::AddOutput ( wxString aOutputPath)
inlineinherited

Definition at line 216 of file job.h.

References m_outputs.

Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), GenerateIpc2581File(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportStackup(), PCBNEW_JOBS_HANDLER::JobExportStats(), and plotJob().

◆ ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )
inlineinherited

Definition at line 214 of file job.h.

References m_outputs.

Referenced by JOB_DISPATCHER::RunJob().

◆ DataSetFromToken()

JOB_EXPORT_PCB_FAB::DATA_SET JOB_EXPORT_PCB_FAB::DataSetFromToken ( const wxString & aToken)
static

Read a data set token in upper case or in lower case An empty token is USERDEF.

Definition at line 68 of file job_export_pcb_fab.cpp.

References COUNT, and USERDEF.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::applyFabExportArgs(), JOB_EXPORT_PCB_IPC2581::FromJson(), and FAB::ModeFromToken().

◆ DataSetToken()

std::string JOB_EXPORT_PCB_FAB::DataSetToken ( DATA_SET aDataSet)
static

Lower case token that the job file and the CLI use for aDataSet Empty when it has none.

Definition at line 79 of file job_export_pcb_fab.cpp.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::addFabExportArgs(), and BOOST_AUTO_TEST_CASE().

◆ FromJson()

void JOB_EXPORT_PCB_FAB::FromJson ( const nlohmann::json & aJson)
overridevirtual

Reimplemented from JOB.

Reimplemented in JOB_EXPORT_PCB_IPC2581.

Definition at line 88 of file job_export_pcb_fab.cpp.

References JOB::FromJson(), m_sections, and m_variantNames.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and JOB_EXPORT_PCB_IPC2581::FromJson().

◆ GetConfiguredOutputPath()

wxString JOB::GetConfiguredOutputPath ( ) const
inlineinherited

Returns the configured output path for the job.

Definition at line 235 of file job.h.

References m_outputPath.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIdf(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStackup(), PCBNEW_JOBS_HANDLER::JobExportStats(), PCBNEW_JOBS_HANDLER::JobExportStep(), GERBVIEW_JOBS_HANDLER::JobGerberDiff(), GERBVIEW_JOBS_HANDLER::JobGerberExportPng(), EESCHEMA_JOBS_HANDLER::JobImport(), PCBNEW_JOBS_HANDLER::JobImport(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCB_PLOTTER::PlotJobToPlotOpts(), PCBNEW_JOBS_HANDLER::resolvePlotOutputPath(), JOBS_RUNNER::runSpecialArchive(), and JOBS_RUNNER::runSpecialExecute().

◆ GetDefaultDescription()

wxString JOB::GetDefaultDescription ( ) const
virtualinherited

Reimplemented in JOB_EXPORT_BOM, JOB_EXPORT_PCB_3D, JOB_EXPORT_PCB_DRILL, JOB_EXPORT_PCB_DXF, JOB_EXPORT_PCB_GENCAD, JOB_EXPORT_PCB_GERBER, JOB_EXPORT_PCB_GERBERS, JOB_EXPORT_PCB_HPGL, JOB_EXPORT_PCB_IDF, JOB_EXPORT_PCB_IPC2581, JOB_EXPORT_PCB_IPCD356, JOB_EXPORT_PCB_ODB, JOB_EXPORT_PCB_PDF, JOB_EXPORT_PCB_PNG, JOB_EXPORT_PCB_POS, JOB_EXPORT_PCB_PS, JOB_EXPORT_PCB_STACKUP, JOB_EXPORT_PCB_STATS, JOB_EXPORT_PCB_SVG, JOB_EXPORT_SCH_NETLIST, JOB_EXPORT_SCH_PLOT_DXF, JOB_EXPORT_SCH_PLOT_HPGL, JOB_EXPORT_SCH_PLOT_PDF, JOB_EXPORT_SCH_PLOT_PNG, JOB_EXPORT_SCH_PLOT_PS, JOB_EXPORT_SCH_PLOT_SVG, JOB_EXPORT_SCH_PYTHONBOM, JOB_FP_DIFF, JOB_GERBER_DIFF, JOB_GERBER_EXPORT_PNG, JOB_GERBER_INFO, JOB_PCB_DIFF, JOB_PCB_DRC, JOB_PCB_IMPORT, JOB_PCB_RENDER, JOB_SCH_DIFF, JOB_SCH_ERC, JOB_SCH_IMPORT, JOB_SPECIAL_ARCHIVE, JOB_SPECIAL_COPYFILES, JOB_SPECIAL_EXECUTE, JOB_SYM_DIFF, and JOB_UNKNOWN.

Definition at line 74 of file job.cpp.

Referenced by JOB_DIFF_BASE::GetSettingsDialogTitle().

◆ 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 150 of file job.cpp.

References m_outputPath, m_outputPathIsDirectory, m_workingOutputPath, and ResolveOutputPath().

Referenced by BOOST_AUTO_TEST_CASE(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), GenerateIpc2581File(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportStep(), EESCHEMA_JOBS_HANDLER::JobSchErc(), KICAD_DIFF::MakeEmitOptions(), PCBNEW_JOBS_HANDLER::resolveJobOutputPath(), JOBS_RUNNER::runSpecialArchive(), JOBS_RUNNER::runSpecialCopyFiles(), and JOBS_RUNNER::runSpecialExecute().

◆ GetOutputPathIsDirectory()

bool JOB::GetOutputPathIsDirectory ( ) const
inlineinherited

Definition at line 258 of file job.h.

References m_outputPathIsDirectory.

Referenced by GenerateODBPPFiles(), and EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ GetOutputs()

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

Definition at line 215 of file job.h.

References m_outputs.

Referenced by ExecuteBoardJob(), and ExecuteSchematicJob().

◆ GetParams()

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

Definition at line 212 of file job.h.

References m_params.

◆ GetSettingsDialogTitle()

wxString JOB::GetSettingsDialogTitle ( ) const
virtualinherited

Reimplemented in JOB_DIFF_BASE, JOB_EXPORT_BOM, JOB_EXPORT_PCB_3D, JOB_EXPORT_PCB_DRILL, JOB_EXPORT_PCB_DXF, JOB_EXPORT_PCB_GENCAD, JOB_EXPORT_PCB_GERBER, JOB_EXPORT_PCB_GERBERS, JOB_EXPORT_PCB_IDF, JOB_EXPORT_PCB_IPC2581, JOB_EXPORT_PCB_IPCD356, JOB_EXPORT_PCB_ODB, JOB_EXPORT_PCB_PDF, JOB_EXPORT_PCB_PNG, JOB_EXPORT_PCB_POS, JOB_EXPORT_PCB_PS, JOB_EXPORT_PCB_STACKUP, JOB_EXPORT_PCB_STATS, JOB_EXPORT_PCB_SVG, JOB_EXPORT_SCH_NETLIST, JOB_EXPORT_SCH_PLOT_DXF, JOB_EXPORT_SCH_PLOT_PDF, JOB_EXPORT_SCH_PLOT_PNG, JOB_EXPORT_SCH_PLOT_PS, JOB_EXPORT_SCH_PLOT_SVG, JOB_GERBER_DIFF, JOB_GERBER_EXPORT_PNG, JOB_GERBER_INFO, JOB_PCB_DRC, JOB_PCB_IMPORT, JOB_PCB_RENDER, JOB_SCH_ERC, and JOB_SCH_IMPORT.

Definition at line 80 of file job.cpp.

References _.

Referenced by DIALOG_PLOT::DIALOG_PLOT().

◆ GetType()

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

Definition at line 195 of file job.h.

References m_type.

Referenced by ExecuteBoardJob(), ExecuteSchematicJob(), JOB_UNKNOWN::GetDefaultDescription(), JOB_DISPATCHER::HandleJobConfig(), PANEL_JOBSET::OpenJobOptionsForListItem(), and JOB_DISPATCHER::RunJob().

◆ GetVarOverrides()

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

Definition at line 197 of file job.h.

References m_varOverrides.

Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), plotJob(), and PCBNEW_JOBS_HANDLER::resolveJobOutputPath().

◆ GetWorkingOutputPath()

wxString JOB::GetWorkingOutputPath ( ) const
inlineinherited

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

Definition at line 246 of file job.h.

References m_workingOutputPath.

Referenced by BOOST_AUTO_TEST_CASE(), GenerateODBPPFiles(), PCBNEW_JOBS_HANDLER::JobExportStackup(), and PCBNEW_JOBS_HANDLER::JobExportStats().

◆ ResolveOutputPath()

wxString JOB::ResolveOutputPath ( const wxString & aPath,
bool aPathIsDirectory,
PROJECT * aProject ) const
inherited

Definition at line 100 of file job.cpp.

References ExpandEnvVarSubstitutions(), ExpandTextVars(), INTERNAL, m_tempOutputDirectory, m_titleBlock, NormalizeFilePathForTextVars(), PrependDirectoryToPath(), and PROJECT::TextVarResolver().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GenerateODBPPFiles(), GetFullOutputPath(), and PCBNEW_JOBS_HANDLER::JobExportDrill().

◆ SetConfiguredOutputPath()

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

Sets the configured output path for the job, this path is always saved to file.

Any transient working output path is cleared so the new configured path takes precedence on the next call to GetFullOutputPath().

Definition at line 157 of file job.cpp.

References m_outputPath, and m_workingOutputPath.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CLI::IMPORT_COMMAND::doPerform(), API_HANDLER_PCB::handleRunBoardJobExport3D(), API_HANDLER_PCB::handleRunBoardJobExportDrill(), API_HANDLER_PCB::handleRunBoardJobExportDxf(), API_HANDLER_PCB::handleRunBoardJobExportGencad(), API_HANDLER_PCB::handleRunBoardJobExportGerbers(), API_HANDLER_PCB::handleRunBoardJobExportIdf(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), API_HANDLER_PCB::handleRunBoardJobExportIpcD356(), API_HANDLER_PCB::handleRunBoardJobExportODB(), API_HANDLER_PCB::handleRunBoardJobExportPdf(), API_HANDLER_PCB::handleRunBoardJobExportPng(), API_HANDLER_PCB::handleRunBoardJobExportPosition(), API_HANDLER_PCB::handleRunBoardJobExportPs(), API_HANDLER_PCB::handleRunBoardJobExportRender(), API_HANDLER_PCB::handleRunBoardJobExportStats(), API_HANDLER_PCB::handleRunBoardJobExportSvg(), API_HANDLER_SCH::handleRunSchematicJobExportBOM(), API_HANDLER_SCH::handleRunSchematicJobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), DIALOG_EXPORT_ODBPP::populateJob(), JOBS_RUNNER::runSpecialArchive(), JOBS_RUNNER::runSpecialExecute(), DIALOG_FIELDS_TABLE::saveJobSettings(), JOB_EXPORT_PCB_IDF::SetDefaultOutputPath(), 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 204 of file job.h.

References m_titleBlock.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), and PCBNEW_JOBS_HANDLER::resolveJobOutputPath().

◆ SetVarOverrides()

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

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

References m_workingOutputPath.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIdf(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCBNEW_JOBS_HANDLER::resolvePlotOutputPath(), JOB_EXPORT_PCB_STACKUP::SetDefaultOutputPath(), and JOB_EXPORT_PCB_STATS::SetDefaultOutputPath().

◆ SupportsDataSet()

virtual bool JOB_EXPORT_PCB_FAB::SupportsDataSet ( DATA_SET aDataSet) const
pure virtual

Implemented in JOB_EXPORT_PCB_IPC2581, and JOB_EXPORT_PCB_ODB.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::addFabExportArgs().

◆ ToJson()

void JOB_EXPORT_PCB_FAB::ToJson ( nlohmann::json & aJson) const
overridevirtual

Reimplemented from JOB.

Definition at line 112 of file job_export_pcb_fab.cpp.

References m_sections, m_variantNames, and JOB::ToJson().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

Member Data Documentation

◆ m_checkZonesBeforeExport

bool JOB_EXPORT_PCB_FAB::m_checkZonesBeforeExport = false

Definition at line 81 of file job_export_pcb_fab.h.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::applyFabExportArgs(), ApplyOdbJobRequest(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), DIALOG_EXPORT_ODBPP::onOKClick(), DIALOG_EXPORT_ODBPP::populateJob(), PCBNEW_JOBS_HANDLER::refillFabZones(), and DIALOG_EXPORT_ODBPP::TransferDataToWindow().

◆ m_colMfgPn

wxString JOB_EXPORT_PCB_FAB::m_colMfgPn

Definition at line 82 of file job_export_pcb_fab.h.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::applyFabExportArgs(), ApplyOdbJobRequest(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GenerateIpc2581File(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), DIALOG_EXPORT_ODBPP::populateJob(), and DIALOG_EXPORT_ODBPP::TransferDataToWindow().

◆ m_dataSet

DATA_SET JOB_EXPORT_PCB_FAB::m_dataSet = DATA_SET::USERDEF

Definition at line 83 of file job_export_pcb_fab.h.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::applyFabExportArgs(), ApplyFabExportContent(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), JOB_EXPORT_PCB_IPC2581::FromJson(), GenerateIpc2581File(), GenerateODBPPFiles(), DIALOG_EXPORT_ODBPP::populateJob(), and DIALOG_EXPORT_ODBPP::TransferDataToWindow().

◆ m_description

wxString JOB::m_description
protectedinherited

Definition at line 269 of file job.h.

Referenced by JOB().

◆ m_drawingSheet

wxString JOB_EXPORT_PCB_FAB::m_drawingSheet

Definition at line 77 of file job_export_pcb_fab.h.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::applyFabExportArgs(), ApplyOdbJobRequest(), and API_HANDLER_PCB::handleRunBoardJobExportIpc2581().

◆ m_filename

wxString JOB_EXPORT_PCB_FAB::m_filename

Definition at line 76 of file job_export_pcb_fab.h.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::applyFabExportArgs(), generateOneODBPackage(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), API_HANDLER_PCB::handleRunBoardJobExportODB(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportOdb(), and DIALOG_EXPORT_ODBPP::populateJob().

◆ m_netNames

NET_NAMES JOB_EXPORT_PCB_FAB::m_netNames = NET_NAMES::INCLUDE

Definition at line 88 of file job_export_pcb_fab.h.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::applyFabExportArgs(), ApplyFabExportContent(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GenerateIpc2581File(), DIALOG_EXPORT_ODBPP::populateJob(), and DIALOG_EXPORT_ODBPP::TransferDataToWindow().

◆ m_outputPath

wxString JOB::m_outputPath
protectedinherited

Definition at line 267 of file job.h.

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

◆ m_outputPathIsDirectory

bool JOB::m_outputPathIsDirectory
protectedinherited

Definition at line 268 of file job.h.

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

◆ m_outputs

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

Definition at line 279 of file job.h.

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

◆ m_params

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

Definition at line 277 of file job.h.

Referenced by FromJson(), GetParams(), JOB(), JOB_EXPORT_BOM::JOB_EXPORT_BOM(), 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_IDF::JOB_EXPORT_PCB_IDF(), JOB_EXPORT_PCB_IPC2581::JOB_EXPORT_PCB_IPC2581(), JOB_EXPORT_PCB_STACKUP::JOB_EXPORT_PCB_STACKUP(), JOB_EXPORT_PCB_STATS::JOB_EXPORT_PCB_STATS(), JOB_PCB_DRC::JOB_PCB_DRC(), JOB_PCB_RENDER::JOB_PCB_RENDER(), JOB_RC::JOB_RC(), JOB_SPECIAL_ARCHIVE::JOB_SPECIAL_ARCHIVE(), JOB_SPECIAL_COPYFILES::JOB_SPECIAL_COPYFILES(), JOB_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), ToJson(), and ~JOB().

◆ m_precision

int JOB_EXPORT_PCB_FAB::m_precision = 6

Definition at line 80 of file job_export_pcb_fab.h.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::applyFabExportArgs(), ApplyOdbJobRequest(), GenerateIpc2581File(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), DIALOG_EXPORT_ODBPP::populateJob(), and DIALOG_EXPORT_ODBPP::TransferDataToWindow().

◆ m_sections

std::optional<wxString> JOB_EXPORT_PCB_FAB::m_sections

Section key that replaces the optional sections of the data set Unset lets the data set select them and an empty key selects none.

Definition at line 87 of file job_export_pcb_fab.h.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::applyFabExportArgs(), ApplyFabExportContent(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FromJson(), GenerateIpc2581File(), GenerateODBPPFiles(), DIALOG_EXPORT_ODBPP::populateJob(), ToJson(), and DIALOG_EXPORT_ODBPP::TransferDataToWindow().

◆ m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory
protectedinherited

Definition at line 265 of file job.h.

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

◆ m_titleBlock

TITLE_BLOCK JOB::m_titleBlock
protectedinherited

Definition at line 263 of file job.h.

Referenced by ResolveOutputPath(), and SetTitleBlock().

◆ m_type

std::string JOB::m_type
protectedinherited

Definition at line 261 of file job.h.

Referenced by GetType(), and JOB().

◆ m_units

UNITS JOB_EXPORT_PCB_FAB::m_units = UNITS::MM

Definition at line 79 of file job_export_pcb_fab.h.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::applyFabExportArgs(), ApplyOdbJobRequest(), GenerateIpc2581File(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), DIALOG_EXPORT_ODBPP::populateJob(), and DIALOG_EXPORT_ODBPP::TransferDataToWindow().

◆ m_variantNames

std::vector<wxString> JOB_EXPORT_PCB_FAB::m_variantNames

Definition at line 78 of file job_export_pcb_fab.h.

Referenced by CLI::PCB_EXPORT_BASE_COMMAND::applyFabExportArgs(), ApplyOdbJobRequest(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FromJson(), GenerateIpc2581File(), GenerateODBPPFiles(), API_HANDLER_PCB::handleRunBoardJobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), DIALOG_EXPORT_ODBPP::populateJob(), ToJson(), and DIALOG_EXPORT_ODBPP::TransferDataToWindow().

◆ m_varOverrides

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

Definition at line 262 of file job.h.

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

◆ m_workingOutputPath

wxString JOB::m_workingOutputPath
protectedinherited

The working output path is a transient path that takes priority over the configured output path when determining where to write output files.

Definition at line 275 of file job.h.

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

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