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

#include <job_export_pcb_ipc2581.h>

Inheritance diagram for JOB_EXPORT_PCB_IPC2581:
JOB

Public Types

enum class  IPC2581_UNITS { INCH , MM }
 
enum class  IPC2581_VERSION { B , C }
 

Public Member Functions

 JOB_EXPORT_PCB_IPC2581 ()
 
wxString GetDefaultDescription () const override
 
wxString GetSettingsDialogTitle () const override
 
void SetDefaultOutputPath (const wxString &aReferenceName)
 
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
 
wxString m_drawingSheet
 
IPC2581_UNITS m_units
 
IPC2581_VERSION m_version
 
int m_precision
 
bool m_compress
 
wxString m_colInternalId
 
wxString m_colMfgPn
 
wxString m_colMfg
 
wxString m_colDistPn
 
wxString m_colDist
 

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 27 of file job_export_pcb_ipc2581.h.

Member Enumeration Documentation

◆ IPC2581_UNITS

enum class JOB_EXPORT_PCB_IPC2581::IPC2581_UNITS
strong
Enumerator
INCH 
MM 

Definition at line 36 of file job_export_pcb_ipc2581.h.

◆ IPC2581_VERSION

enum class JOB_EXPORT_PCB_IPC2581::IPC2581_VERSION
strong
Enumerator
B 
C 

Definition at line 42 of file job_export_pcb_ipc2581.h.

Constructor & Destructor Documentation

◆ JOB_EXPORT_PCB_IPC2581()

JOB_EXPORT_PCB_IPC2581::JOB_EXPORT_PCB_IPC2581 ( )

Definition at line 38 of file job_export_pcb_ipc2581.cpp.

Member Function Documentation

◆ AddOutput()

void JOB::AddOutput ( wxString  aOutputPath)
inlineinherited

Definition at line 215 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

◆ ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )
inlineinherited

Definition at line 213 of file job.h.

Referenced by JOB_DISPATCHER::RunJob().

◆ FromJson()

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

Definition at line 60 of file job.cpp.

References JOB::m_params.

Referenced by from_json().

◆ GetConfiguredOutputPath()

wxString JOB::GetConfiguredOutputPath ( ) const
inlineinherited

Returns the configured output path for the job.

Definition at line 232 of file job.h.

Referenced by DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), 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(), JOBS_RUNNER::runSpecialExecute(), DIALOG_RC_JOB::TransferDataToWindow(), DIALOG_PLOT_SCHEMATIC::TransferDataToWindow(), DIALOG_EXECUTECOMMAND_JOB_SETTINGS::TransferDataToWindow(), DIALOG_EXPORT_2581::TransferDataToWindow(), DIALOG_EXPORT_ODBPP::TransferDataToWindow(), DIALOG_EXPORT_STEP::TransferDataToWindow(), DIALOG_GEN_FOOTPRINT_POSITION::TransferDataToWindow(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataToWindow(), DIALOG_GENDRILL::TransferDataToWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().

◆ GetDefaultDescription()

wxString JOB_EXPORT_PCB_IPC2581::GetDefaultDescription ( ) const
overridevirtual

Reimplemented from JOB.

Definition at line 70 of file job_export_pcb_ipc2581.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(), JOB::m_outputPath, JOB::m_outputPathIsDirectory, JOB::m_tempOutputDirectory, JOB::m_titleBlock, JOB::m_workingOutputPath, PrependDirectoryToPath(), PROJECT::TextVarResolver(), and TITLE_BLOCK::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.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ GetOutputs()

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

Definition at line 214 of file job.h.

◆ GetParams()

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

Definition at line 211 of file job.h.

◆ GetSettingsDialogTitle()

wxString JOB_EXPORT_PCB_IPC2581::GetSettingsDialogTitle ( ) const
overridevirtual

Reimplemented from JOB.

Definition at line 76 of file job_export_pcb_ipc2581.cpp.

References _.

Referenced by DIALOG_EXPORT_2581::DIALOG_EXPORT_2581().

◆ GetType()

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

Definition at line 194 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 196 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(), 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.

◆ 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 JOB::m_outputPath.

Referenced by BOARD_EDITOR_CONTROL::GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GEN_FOOTPRINT_POSITION::onGenerate(), DIALOG_SYMBOL_FIELDS_TABLE::OnOk(), DIALOG_PLOT_SCHEMATIC::OnPlotAll(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), JOBS_RUNNER::runSpecialExecute(), SetDefaultOutputPath(), JOB_EXPORT_PCB_IPCD356::SetDefaultOutputPath(), JOB_EXPORT_PCB_ODB::SetDefaultOutputPath(), JOB_EXPORT_PCB_POS::SetDefaultOutputPath(), DIALOG_RC_JOB::TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_EXECUTECOMMAND_JOB_SETTINGS::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), DIALOG_EXPORT_ODBPP::TransferDataFromWindow(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataFromWindow(), DIALOG_GENDRILL::TransferDataFromWindow(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ SetDefaultOutputPath()

void JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath ( const wxString &  aReferenceName)

Definition at line 82 of file job_export_pcb_ipc2581.cpp.

References FILEEXT::Ipc2581FileExtension, and JOB::SetConfiguredOutputPath().

◆ 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 JOB::m_tempOutputDirectory.

◆ SetTitleBlock()

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

Definition at line 203 of file job.h.

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.

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.

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 JOB::m_params.

Referenced by to_json().

Member Data Documentation

◆ m_colDist

wxString JOB_EXPORT_PCB_IPC2581::m_colDist

Definition at line 62 of file job_export_pcb_ipc2581.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataToWindow().

◆ m_colDistPn

wxString JOB_EXPORT_PCB_IPC2581::m_colDistPn

Definition at line 61 of file job_export_pcb_ipc2581.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataToWindow().

◆ m_colInternalId

wxString JOB_EXPORT_PCB_IPC2581::m_colInternalId

Definition at line 58 of file job_export_pcb_ipc2581.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataToWindow().

◆ m_colMfg

wxString JOB_EXPORT_PCB_IPC2581::m_colMfg

Definition at line 60 of file job_export_pcb_ipc2581.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataToWindow().

◆ m_colMfgPn

wxString JOB_EXPORT_PCB_IPC2581::m_colMfgPn

Definition at line 59 of file job_export_pcb_ipc2581.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataToWindow().

◆ m_compress

bool JOB_EXPORT_PCB_IPC2581::m_compress

Definition at line 56 of file job_export_pcb_ipc2581.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataToWindow().

◆ m_description

wxString JOB::m_description
protectedinherited

Definition at line 264 of file job.h.

Referenced by JOB::JOB().

◆ m_drawingSheet

wxString JOB_EXPORT_PCB_IPC2581::m_drawingSheet

Definition at line 50 of file job_export_pcb_ipc2581.h.

◆ m_filename

wxString JOB_EXPORT_PCB_IPC2581::m_filename

Definition at line 49 of file job_export_pcb_ipc2581.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581().

◆ m_outputPath

wxString JOB::m_outputPath
protectedinherited

Definition at line 262 of file job.h.

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

◆ m_outputPathIsDirectory

bool JOB::m_outputPathIsDirectory
protectedinherited

Definition at line 263 of file job.h.

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

◆ m_outputs

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

Definition at line 269 of file job.h.

◆ m_params

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

Definition at line 267 of file job.h.

Referenced by JOB::FromJson(), JOB::JOB(), JOB_EXPORT_PCB_3D::JOB_EXPORT_PCB_3D(), 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_SCH_BOM::JOB_EXPORT_SCH_BOM(), JOB_PCB_DRC::JOB_PCB_DRC(), JOB_SPECIAL_COPYFILES::JOB_SPECIAL_COPYFILES(), JOB_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), JOB::ToJson(), and JOB::~JOB().

◆ m_precision

int JOB_EXPORT_PCB_IPC2581::m_precision

Definition at line 54 of file job_export_pcb_ipc2581.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataToWindow().

◆ m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory
protectedinherited

Definition at line 260 of file job.h.

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

◆ m_titleBlock

TITLE_BLOCK JOB::m_titleBlock
protectedinherited

Definition at line 258 of file job.h.

Referenced by JOB::GetFullOutputPath().

◆ m_type

std::string JOB::m_type
protectedinherited

Definition at line 256 of file job.h.

◆ m_units

IPC2581_UNITS JOB_EXPORT_PCB_IPC2581::m_units

Definition at line 52 of file job_export_pcb_ipc2581.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataToWindow().

◆ m_varOverrides

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

Definition at line 257 of file job.h.

◆ m_version

IPC2581_VERSION JOB_EXPORT_PCB_IPC2581::m_version

Definition at line 53 of file job_export_pcb_ipc2581.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportIpc2581(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataToWindow().

◆ m_workingOutputPath

wxString JOB::m_workingOutputPath
protectedinherited

Definition at line 265 of file job.h.

Referenced by JOB::GetFullOutputPath().

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