JOBS_OUTPUT_HANDLER Class Reference

#include <jobs_output.h>

Inheritance diagram for JOBS_OUTPUT_HANDLER:

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 &aBaseTempPath, PROJECT *aProject, const std::vector< JOB_OUTPUT > &aOutputsToHandle, std::optional< wxString > &aResolvedOutputPath)=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
virtual wxString	GetDefaultDescription () const

Protected Attributes
wxString	m_outputPath

Detailed Description

Definition at line 30 of file jobs_output.h.

Constructor & Destructor Documentation

JOBS_OUTPUT_HANDLER()

JOBS_OUTPUT_HANDLER::JOBS_OUTPUT_HANDLER ( )

inline

Definition at line 33 of file jobs_output.h.

Referenced by JOBS_OUTPUT_ARCHIVE::JOBS_OUTPUT_ARCHIVE(), and JOBS_OUTPUT_FOLDER::JOBS_OUTPUT_FOLDER().

~JOBS_OUTPUT_HANDLER()

virtual JOBS_OUTPUT_HANDLER::~JOBS_OUTPUT_HANDLER ( )

inlinevirtual

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

GetDefaultDescription()

virtual wxString JOBS_OUTPUT_HANDLER::GetDefaultDescription ( ) const

inlinevirtual

Reimplemented in JOBS_OUTPUT_ARCHIVE, and JOBS_OUTPUT_FOLDER.

Definition at line 58 of file jobs_output.h.

GetOutputPath()

wxString JOBS_OUTPUT_HANDLER::GetOutputPath ( ) const

inline

Definition at line 56 of file jobs_output.h.

References m_outputPath.

HandleOutputs()

virtual bool JOBS_OUTPUT_HANDLER::HandleOutputs ( const wxString & aBaseTempPath, PROJECT * aProject, const std::vector< JOB_OUTPUT > & aOutputsToHandle, std::optional< wxString > & aResolvedOutputPath )

pure virtual

Implemented in JOBS_OUTPUT_ARCHIVE, and JOBS_OUTPUT_FOLDER.

Referenced by JOBS_RUNNER::RunJobsForDestination().

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 45 of file jobs_output.h.

Referenced by JOBS_RUNNER::RunJobsForDestination().

SetOutputPath()

void JOBS_OUTPUT_HANDLER::SetOutputPath ( const wxString & aPath )

inline

Definition at line 55 of file jobs_output.h.

References m_outputPath.

Referenced by KICAD_MANAGER_FRAME::OpenJobsFile().

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

wxString JOBS_OUTPUT_HANDLER::m_outputPath

protected

Definition at line 61 of file jobs_output.h.

Referenced by JOBS_OUTPUT_ARCHIVE::FromJson(), JOBS_OUTPUT_FOLDER::FromJson(), GetOutputPath(), JOBS_OUTPUT_ARCHIVE::HandleOutputs(), JOBS_OUTPUT_FOLDER::HandleOutputs(), JOBS_OUTPUT_ARCHIVE::OutputPrecheck(), JOBS_OUTPUT_FOLDER::OutputPrecheck(), SetOutputPath(), JOBS_OUTPUT_ARCHIVE::ToJson(), and JOBS_OUTPUT_FOLDER::ToJson().

---

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

• jobs_output.h