#include <job_pcb_drc.h>

Inheritance diagram for JOB_PCB_DRC:

Public Types
enum class	UNITS { INCHES , MILLIMETERS , MILS }

enum class	OUTPUT_FORMAT { REPORT , JSON }

Public Member Functions
	JOB_PCB_DRC ()

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_outputFile

bool	m_reportAllTrackErrors

UNITS	m_units

int	m_severity

OUTPUT_FORMAT	m_format

bool	m_exitCodeViolations

bool	m_parity

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_pcb_drc.h.

Member Enumeration Documentation

◆ OUTPUT_FORMAT

enum class JOB_PCB_DRC::OUTPUT_FORMAT

strong

Enumerator
REPORT
JSON

Definition at line 52 of file job_pcb_drc.h.

◆ UNITS

enum class JOB_PCB_DRC::UNITS

strong

Enumerator
INCHES
MILLIMETERS
MILS

Definition at line 41 of file job_pcb_drc.h.

Constructor & Destructor Documentation

◆ JOB_PCB_DRC()

JOB_PCB_DRC::JOB_PCB_DRC ( )

Definition at line 38 of file job_pcb_drc.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_PCB_DRC::GetDescription ( )

overridevirtual

Reimplemented from JOB.

Definition at line 56 of file job_pcb_drc.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.

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

bool JOB_PCB_DRC::m_exitCodeViolations

Definition at line 60 of file job_pcb_drc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc().

◆ m_filename

wxString JOB_PCB_DRC::m_filename

Definition at line 36 of file job_pcb_drc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc().

◆ m_format

OUTPUT_FORMAT JOB_PCB_DRC::m_format

Definition at line 58 of file job_pcb_drc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc().

◆ m_outputFile

wxString JOB_PCB_DRC::m_outputFile

Definition at line 37 of file job_pcb_drc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc().

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

bool JOB_PCB_DRC::m_parity

Definition at line 61 of file job_pcb_drc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc().

◆ m_reportAllTrackErrors

bool JOB_PCB_DRC::m_reportAllTrackErrors

Definition at line 39 of file job_pcb_drc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc().

◆ m_severity

int JOB_PCB_DRC::m_severity

Definition at line 50 of file job_pcb_drc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc().

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

UNITS JOB_PCB_DRC::m_units

Definition at line 48 of file job_pcb_drc.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc().

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

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ OUTPUT_FORMAT

◆ UNITS

Constructor & Destructor Documentation

◆ JOB_PCB_DRC()

Member Function Documentation

◆ AddOutput()

◆ ClearExistingOutputs()

◆ FromJson()

◆ GetDescription()

◆ GetFullOutputPath()

◆ GetOutputPath()

◆ GetOutputs()

◆ GetParams()

◆ GetType()

◆ GetVarOverrides()

◆ OutputPathFullSpecified()

◆ SetOutputPath()

◆ SetTempOutputDirectory()

◆ SetVarOverrides()

◆ ToJson()

Member Data Documentation

◆ m_exitCodeViolations

◆ m_filename

◆ m_format

◆ m_outputFile

◆ m_outputPath

◆ m_outputPathIsDirectory

◆ m_outputs

◆ m_params

◆ m_parity

◆ m_reportAllTrackErrors

◆ m_severity

◆ m_tempOutputDirectory

◆ m_type

◆ m_units

◆ m_varOverrides