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

#include <job_dispatcher.h>

Inheritance diagram for JOB_DISPATCHER:
EESCHEMA_JOBS_HANDLER PCBNEW_JOBS_HANDLER

Public Member Functions

 JOB_DISPATCHER (KIWAY *aKiway)
 
void Register (const std::string &aJobTypeName, std::function< int(JOB *job)> aHandler, std::function< bool(JOB *job, wxWindow *aParent)> aConfigHandler)
 
int RunJob (JOB *aJob, REPORTER *aReporter)
 
bool HandleJobConfig (JOB *aJob, wxWindow *aParent)
 
void SetReporter (REPORTER *aReporter)
 
void SetProgressReporter (PROGRESS_REPORTER *aReporter)
 

Protected Attributes

KIWAY * m_kiway
 
REPORTER * m_reporter
 
PROGRESS_REPORTER * m_progressReporter
 

Private Attributes

std::map< std::string, std::function< int(JOB *job)> > m_jobHandlers
 
std::map< std::string, std::function< bool(JOB *job, wxWindow *aParent)> > m_jobConfigHandlers
 

Detailed Description

Definition at line 36 of file job_dispatcher.h.

Constructor & Destructor Documentation

◆ JOB_DISPATCHER()

JOB_DISPATCHER::JOB_DISPATCHER ( KIWAY *  aKiway)

Definition at line 28 of file job_dispatcher.cpp.

References NULL_REPORTER::GetInstance(), m_progressReporter, and m_reporter.

Member Function Documentation

◆ HandleJobConfig()

bool JOB_DISPATCHER::HandleJobConfig ( JOB *  aJob,
wxWindow *  aParent 
)

Definition at line 68 of file job_dispatcher.cpp.

References JOB::GetType(), and m_jobConfigHandlers.

◆ Register()

void JOB_DISPATCHER::Register ( const std::string &  aJobTypeName,
std::function< int(JOB *job)>  aHandler,
std::function< bool(JOB *job, wxWindow *aParent)>  aConfigHandler 
)

Definition at line 36 of file job_dispatcher.cpp.

References m_jobConfigHandlers, and m_jobHandlers.

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

◆ RunJob()

int JOB_DISPATCHER::RunJob ( JOB *  aJob,
REPORTER *  aReporter 
)

Definition at line 45 of file job_dispatcher.cpp.

References JOB::ClearExistingOutputs(), CLI::EXIT_CODES::ERR_UNKNOWN, JOB::GetType(), m_jobHandlers, and m_reporter.

◆ SetProgressReporter()

void JOB_DISPATCHER::SetProgressReporter ( PROGRESS_REPORTER *  aReporter)

Definition at line 86 of file job_dispatcher.cpp.

References m_progressReporter.

◆ SetReporter()

void JOB_DISPATCHER::SetReporter ( REPORTER *  aReporter)

Definition at line 79 of file job_dispatcher.cpp.

References m_reporter.

Member Data Documentation

◆ m_jobConfigHandlers

std::map<std::string, std::function<bool( JOB* job, wxWindow* aParent )> > JOB_DISPATCHER::m_jobConfigHandlers
private

Definition at line 55 of file job_dispatcher.h.

Referenced by HandleJobConfig(), and Register().

◆ m_jobHandlers

std::map<std::string, std::function<int( JOB* job )> > JOB_DISPATCHER::m_jobHandlers
private

Definition at line 53 of file job_dispatcher.h.

Referenced by Register(), and RunJob().

◆ m_kiway

KIWAY* JOB_DISPATCHER::m_kiway
protected

Definition at line 48 of file job_dispatcher.h.

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

◆ m_progressReporter

PROGRESS_REPORTER* JOB_DISPATCHER::m_progressReporter
protected

Definition at line 50 of file job_dispatcher.h.

Referenced by JOB_DISPATCHER(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportOdb(), EESCHEMA_JOBS_HANDLER::JobSchErc(), and SetProgressReporter().

◆ m_reporter

REPORTER* JOB_DISPATCHER::m_reporter
protected

Definition at line 49 of file job_dispatcher.h.

Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), PCBNEW_JOBS_HANDLER::getBoard(), EESCHEMA_JOBS_HANDLER::getSchematic(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), JOB_DISPATCHER(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), 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(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), RunJob(), and SetReporter().

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