KiCad PCB EDA Suite
Loading...
Searching...
No Matches
JOBS_OUTPUT_HANDLER Class Referenceabstract

#include <jobs_output.h>

Inheritance diagram for JOBS_OUTPUT_HANDLER:
JOBS_OUTPUT_ARCHIVE JOBS_OUTPUT_FOLDER

Public Member Functions

 JOBS_OUTPUT_HANDLER ()
 
virtual ~JOBS_OUTPUT_HANDLER ()
 
virtual bool OutputPrecheck ()
 Checks if the output process can proceed before doing anything else This can include user prompts.
 
virtual bool HandleOutputs (const wxString &baseTempPath, const std::vector< JOB_OUTPUT > &aOutputsToHandle)=0
 
virtual void FromJson (const nlohmann::json &j)=0
 
virtual void ToJson (nlohmann::json &j) const =0
 
void SetOutputPath (const wxString &aPath)
 
wxString GetOutputPath () const
 

Protected Attributes

wxString m_outputPath
 

Detailed Description

Definition at line 27 of file jobs_output.h.

Constructor & Destructor Documentation

◆ JOBS_OUTPUT_HANDLER()

JOBS_OUTPUT_HANDLER::JOBS_OUTPUT_HANDLER ( )
inline

Definition at line 30 of file jobs_output.h.

◆ ~JOBS_OUTPUT_HANDLER()

virtual JOBS_OUTPUT_HANDLER::~JOBS_OUTPUT_HANDLER ( )
inlinevirtual

Definition at line 34 of file jobs_output.h.

Member Function Documentation

◆ FromJson()

virtual void JOBS_OUTPUT_HANDLER::FromJson ( const nlohmann::json &  j)
pure virtual

Implemented in JOBS_OUTPUT_ARCHIVE, and JOBS_OUTPUT_FOLDER.

Referenced by from_json().

◆ GetOutputPath()

wxString JOBS_OUTPUT_HANDLER::GetOutputPath ( ) const
inline

◆ HandleOutputs()

virtual bool JOBS_OUTPUT_HANDLER::HandleOutputs ( const wxString &  baseTempPath,
const std::vector< JOB_OUTPUT > &  aOutputsToHandle 
)
pure virtual

◆ OutputPrecheck()

virtual bool JOBS_OUTPUT_HANDLER::OutputPrecheck ( )
inlinevirtual

Checks if the output process can proceed before doing anything else This can include user prompts.

Returns
true if the output process can proceed

Reimplemented in JOBS_OUTPUT_ARCHIVE, and JOBS_OUTPUT_FOLDER.

Definition at line 42 of file jobs_output.h.

Referenced by JOBS_RUNNER::RunJobsForOutput().

◆ SetOutputPath()

void JOBS_OUTPUT_HANDLER::SetOutputPath ( const wxString &  aPath)
inline

Definition at line 50 of file jobs_output.h.

Referenced by DIALOG_JOB_OUTPUT::TransferDataFromWindow().

◆ ToJson()

virtual void JOBS_OUTPUT_HANDLER::ToJson ( nlohmann::json &  j) const
pure virtual

Implemented in JOBS_OUTPUT_ARCHIVE, and JOBS_OUTPUT_FOLDER.

Referenced by to_json().

Member Data Documentation

◆ m_outputPath


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