KiCad PCB EDA Suite
Loading...
Searching...
No Matches
JOB_PCB_DRC Class Reference

#include <job_pcb_drc.h>

Inheritance diagram for JOB_PCB_DRC:
JOB

Public Types

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

Public Member Functions

 JOB_PCB_DRC (bool aIsCli)
 
wxString GetDescription () override
 
const std::string & GetType () const
 
bool IsCli () 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
 
bool m_isCli
 
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_OUTPUTm_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 ( bool  aIsCli)

Definition at line 38 of file job_pcb_drc.cpp.

Member Function Documentation

◆ AddOutput()

void JOB::AddOutput ( wxString  aOutputPath)
inlineinherited

Definition at line 112 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

◆ ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )
inlineinherited

Definition at line 104 of file job.h.

Referenced by JOB_DISPATCHER::RunJob().

◆ FromJson()

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

Definition at line 54 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()

◆ GetOutputPath()

◆ GetOutputs()

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

Definition at line 108 of file job.h.

◆ GetParams()

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

Definition at line 100 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()

◆ IsCli()

◆ OutputPathFullSpecified()

bool JOB::OutputPathFullSpecified ( ) const
inherited

◆ SetOutputPath()

◆ SetTempOutputDirectory()

void JOB::SetTempOutputDirectory ( const wxString &  aBase)
inherited

Definition at line 74 of file job.cpp.

References JOB::m_tempOutputDirectory.

◆ SetVarOverrides()

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

Definition at line 90 of file job.h.

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

◆ ToJson()

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

Definition at line 61 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_isCli

bool JOB::m_isCli
protectedinherited

Definition at line 128 of file job.h.

◆ 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

◆ m_outputPathIsDirectory

bool JOB::m_outputPathIsDirectory
protectedinherited

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

◆ m_params

◆ 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 131 of file job.h.

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

◆ m_type

std::string JOB::m_type
protectedinherited

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


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