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

An simple container class that lets us dispatch output jobs to kifaces. More...

#include <job.h>

Inheritance diagram for JOB:
JOB_EXPORT_PCB_3D JOB_EXPORT_PCB_DRILL JOB_EXPORT_PCB_DXF JOB_EXPORT_PCB_GERBER JOB_EXPORT_PCB_IPC2581 JOB_EXPORT_PCB_PDF JOB_EXPORT_PCB_POS JOB_EXPORT_PCB_SVG JOB_EXPORT_SCH_BOM JOB_EXPORT_SCH_NETLIST JOB_EXPORT_SCH_PLOT JOB_EXPORT_SCH_PYTHONBOM JOB_FP_EXPORT_SVG JOB_FP_UPGRADE JOB_PCB_DRC JOB_PCB_RENDER JOB_SCH_ERC JOB_SYM_EXPORT_SVG JOB_SYM_UPGRADE

Public Member Functions

 JOB (const std::string &aType, bool aIsCli)
 
virtual ~JOB ()
 
const std::string & GetType () const
 
bool IsCli () const
 
const std::map< wxString, wxString > & GetVarOverrides () const
 
void SetVarOverrides (const std::map< wxString, wxString > &aVarOverrides)
 

Protected Attributes

std::string m_type
 
bool m_isCli
 
std::map< wxString, wxString > m_varOverrides
 

Detailed Description

An simple container class that lets us dispatch output jobs to kifaces.

Definition at line 31 of file job.h.

Constructor & Destructor Documentation

◆ JOB()

JOB::JOB ( const std::string &  aType,
bool  aIsCli 
)

Definition at line 23 of file job.cpp.

◆ ~JOB()

virtual JOB::~JOB ( )
inlinevirtual

Definition at line 36 of file job.h.

Member Function Documentation

◆ GetType()

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

Definition at line 38 of file job.h.

Referenced by JOB_DISPATCHER::RunJob().

◆ GetVarOverrides()

const std::map< wxString, wxString > & JOB::GetVarOverrides ( ) const
inline

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

◆ IsCli()

bool JOB::IsCli ( ) const
inline

Definition at line 39 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), and PCBNEW_JOBS_HANDLER::JobExportSvg().

◆ SetVarOverrides()

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

Definition at line 43 of file job.h.

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

Member Data Documentation

◆ m_isCli

bool JOB::m_isCli
protected

Definition at line 50 of file job.h.

◆ m_type

std::string JOB::m_type
protected

Definition at line 49 of file job.h.

◆ m_varOverrides

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

Definition at line 51 of file job.h.

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