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

#include <job_export_sch_bom.h>

Inheritance diagram for JOB_EXPORT_SCH_BOM:
JOB

Public Member Functions

 JOB_EXPORT_SCH_BOM ()
 
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

wxString m_filename
 
wxString m_bomPresetName
 
wxString m_bomFmtPresetName
 
wxString m_fieldDelimiter
 
wxString m_stringDelimiter
 
wxString m_refDelimiter
 
wxString m_refRangeDelimiter
 
bool m_keepTabs
 
bool m_keepLineBreaks
 
std::vector< wxString > m_fieldsOrdered
 
std::vector< wxString > m_fieldsLabels
 
std::vector< wxString > m_fieldsGroupBy
 
wxString m_sortField
 
bool m_sortAsc
 
wxString m_filterString
 
bool m_excludeDNP
 
bool m_includeExcludedFromBOM
 

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 29 of file job_export_sch_bom.h.

Constructor & Destructor Documentation

◆ JOB_EXPORT_SCH_BOM()

JOB_EXPORT_SCH_BOM::JOB_EXPORT_SCH_BOM ( )

Definition at line 26 of file job_export_sch_bom.cpp.

References m_excludeDNP, m_fieldDelimiter, m_fieldsGroupBy, m_fieldsLabels, m_fieldsOrdered, m_filterString, m_includeExcludedFromBOM, m_keepLineBreaks, m_keepTabs, JOB::m_params, m_refDelimiter, m_refRangeDelimiter, m_sortAsc, m_sortField, and m_stringDelimiter.

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_SCH_BOM::GetDescription ( )
overridevirtual

Reimplemented from JOB.

Definition at line 84 of file job_export_sch_bom.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_bomFmtPresetName

wxString JOB_EXPORT_SCH_BOM::m_bomFmtPresetName

Definition at line 40 of file job_export_sch_bom.h.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_bomPresetName

wxString JOB_EXPORT_SCH_BOM::m_bomPresetName

Definition at line 39 of file job_export_sch_bom.h.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_excludeDNP

bool JOB_EXPORT_SCH_BOM::m_excludeDNP

Definition at line 57 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_fieldDelimiter

wxString JOB_EXPORT_SCH_BOM::m_fieldDelimiter

Definition at line 43 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_fieldsGroupBy

std::vector<wxString> JOB_EXPORT_SCH_BOM::m_fieldsGroupBy

Definition at line 53 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_fieldsLabels

std::vector<wxString> JOB_EXPORT_SCH_BOM::m_fieldsLabels

Definition at line 52 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_fieldsOrdered

std::vector<wxString> JOB_EXPORT_SCH_BOM::m_fieldsOrdered

Definition at line 51 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_filename

wxString JOB_EXPORT_SCH_BOM::m_filename

Definition at line 36 of file job_export_sch_bom.h.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_filterString

wxString JOB_EXPORT_SCH_BOM::m_filterString

Definition at line 56 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_includeExcludedFromBOM

bool JOB_EXPORT_SCH_BOM::m_includeExcludedFromBOM

Definition at line 58 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_keepLineBreaks

bool JOB_EXPORT_SCH_BOM::m_keepLineBreaks

Definition at line 48 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_keepTabs

bool JOB_EXPORT_SCH_BOM::m_keepTabs

Definition at line 47 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ 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_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), JOB::ToJson(), and JOB::~JOB().

◆ m_refDelimiter

wxString JOB_EXPORT_SCH_BOM::m_refDelimiter

Definition at line 45 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_refRangeDelimiter

wxString JOB_EXPORT_SCH_BOM::m_refRangeDelimiter

Definition at line 46 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_sortAsc

bool JOB_EXPORT_SCH_BOM::m_sortAsc

Definition at line 55 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_sortField

wxString JOB_EXPORT_SCH_BOM::m_sortField

Definition at line 54 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ m_stringDelimiter

wxString JOB_EXPORT_SCH_BOM::m_stringDelimiter

Definition at line 44 of file job_export_sch_bom.h.

Referenced by JOB_EXPORT_SCH_BOM(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

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