JOB_RC Class Reference

#include <job_rc.h>

Inheritance diagram for JOB_RC:

Public Types
enum class	UNITS { INCHES , MILLIMETERS , MILS }
enum class	OUTPUT_FORMAT { REPORT , JSON }

Public Member Functions
	JOB_RC (const std::string &aType)
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	GetDefaultDescription () const
virtual wxString	GetOptionsDialogTitle () 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_outputFile
UNITS	m_units
int	m_severity
OUTPUT_FORMAT	m_format
bool	m_exitCodeViolations

Protected Attributes
std::string	m_type
std::map< wxString, wxString >	m_varOverrides
wxString	m_tempOutputDirectory
wxString	m_outputPath
bool	m_outputPathIsDirectory
wxString	m_description
std::vector< JOB_PARAM_BASE * >	m_params
std::vector< JOB_OUTPUT >	m_outputs

Detailed Description

Definition at line 28 of file job_rc.h.

Member Enumeration Documentation

OUTPUT_FORMAT

enum class JOB_RC::OUTPUT_FORMAT

strong

Enumerator
REPORT
JSON

Definition at line 47 of file job_rc.h.

UNITS

enum class JOB_RC::UNITS

strong

Enumerator
INCHES
MILLIMETERS
MILS

Definition at line 36 of file job_rc.h.

Constructor & Destructor Documentation

JOB_RC()

JOB_RC::JOB_RC

(

const std::string &

aType

)

Definition at line 36 of file job_rc.cpp.

Member Function Documentation

AddOutput()

void JOB::AddOutput ( wxString  aOutputPath )

inlineinherited

Definition at line 150 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )

inlineinherited

Definition at line 148 of file job.h.

Referenced by JOB_DISPATCHER::RunJob().

FromJson()

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

virtualinherited

Definition at line 57 of file job.cpp.

References JOB::m_params.

Referenced by from_json().

GetDefaultDescription()

wxString JOB::GetDefaultDescription ( ) const

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_PCB_RENDER, JOB_SCH_ERC, JOB_SPECIAL_COPYFILES, and JOB_SPECIAL_EXECUTE.

Definition at line 71 of file job.cpp.

GetFullOutputPath()

wxString JOB::GetFullOutputPath ( ) const

inherited

Definition at line 97 of file job.cpp.

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

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), 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().

GetOptionsDialogTitle()

wxString JOB::GetOptionsDialogTitle ( ) const

virtualinherited

Reimplemented in 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_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_PCB_DRC, JOB_PCB_RENDER, and JOB_SCH_ERC.

Definition at line 77 of file job.cpp.

References _.

Referenced by DIALOG_PLOT::DIALOG_PLOT(), and DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC().

GetOutputPath()

wxString JOB::GetOutputPath ( ) const

inlineinherited

Definition at line 155 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_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), 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::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), JOBS_RUNNER::runSpecialExecute(), DIALOG_RC_JOB::TransferDataToWindow(), and DIALOG_RENDER_JOB::TransferDataToWindow().

GetOutputs()

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

inlineinherited

Definition at line 149 of file job.h.

GetParams()

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

inlineinherited

Definition at line 146 of file job.h.

GetType()

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

inlineinherited

Definition at line 131 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 133 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 144 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 138 of file job.cpp.

References JOB::m_outputPath.

Referenced by PCB_EDIT_FRAME::GenODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), 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::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), EESCHEMA_JOBS_HANDLER::JobSchErc(), DIALOG_EXPORT_NETLIST::NetlistUpdateOpt(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), DIALOG_SYMBOL_FIELDS_TABLE::OnOk(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), JOBS_RUNNER::runSpecialExecute(), JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath(), JOB_EXPORT_PCB_ODB::SetDefaultOutputPath(), JOB_EXPORT_PCB_POS::SetDefaultOutputPath(), DIALOG_RC_JOB::TransferDataFromWindow(), DIALOG_SPECIAL_EXECUTE::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), DIALOG_EXPORT_ODBPP::TransferDataFromWindow(), DIALOG_GENDRILL::TransferDataFromWindow(), and DIALOG_RENDER_JOB::TransferDataFromWindow().

SetTempOutputDirectory()

void JOB::SetTempOutputDirectory ( const wxString &  aBase )

inherited

Definition at line 83 of file job.cpp.

References JOB::m_tempOutputDirectory.

SetVarOverrides()

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

inlineinherited

Definition at line 135 of file job.h.

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

ToJson()

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

virtualinherited

Definition at line 64 of file job.cpp.

References JOB::m_params.

Referenced by to_json().

Member Data Documentation

m_description

wxString JOB::m_description

protectedinherited

Definition at line 169 of file job.h.

Referenced by JOB::JOB().

m_exitCodeViolations

bool JOB_RC::m_exitCodeViolations

Definition at line 55 of file job_rc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), EESCHEMA_JOBS_HANDLER::JobSchErc(), DIALOG_RC_JOB::TransferDataFromWindow(), and DIALOG_RC_JOB::TransferDataToWindow().

m_filename

wxString JOB_RC::m_filename

Definition at line 33 of file job_rc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), and EESCHEMA_JOBS_HANDLER::JobSchErc().

m_format

OUTPUT_FORMAT JOB_RC::m_format

Definition at line 53 of file job_rc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), EESCHEMA_JOBS_HANDLER::JobSchErc(), DIALOG_RC_JOB::TransferDataFromWindow(), and DIALOG_RC_JOB::TransferDataToWindow().

m_outputFile

wxString JOB_RC::m_outputFile

Definition at line 34 of file job_rc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), and EESCHEMA_JOBS_HANDLER::JobSchErc().

m_outputPath

wxString JOB::m_outputPath

protectedinherited

Definition at line 167 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 168 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 173 of file job.h.

m_params

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

protectedinherited

Definition at line 171 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_PLOT::JOB_EXPORT_PCB_PLOT(), 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_severity

int JOB_RC::m_severity

Definition at line 45 of file job_rc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), EESCHEMA_JOBS_HANDLER::JobSchErc(), DIALOG_RC_JOB::TransferDataFromWindow(), and DIALOG_RC_JOB::TransferDataToWindow().

m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory

protectedinherited

Definition at line 165 of file job.h.

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

m_type

std::string JOB::m_type

protectedinherited

Definition at line 162 of file job.h.

m_units

UNITS JOB_RC::m_units

Definition at line 43 of file job_rc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), and EESCHEMA_JOBS_HANDLER::JobSchErc().

m_varOverrides

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

protectedinherited

Definition at line 163 of file job.h.

---

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

• job_rc.h
• job_rc.cpp