JOBS_OUTPUT_FOLDER Class Reference

#include <jobs_output_folder.h>

Inheritance diagram for JOBS_OUTPUT_FOLDER:

Public Member Functions
	JOBS_OUTPUT_FOLDER ()
bool	HandleOutputs (const wxString &aBaseTempPath, PROJECT *aProject, const std::vector< JOB_OUTPUT > &aOutputsToHandle, std::optional< wxString > &aResolvedOutputPath) override
bool	OutputPrecheck () override
	Checks if the output process can proceed before doing anything else This can include user prompts.
void	FromJson (const nlohmann::json &j) override
void	ToJson (nlohmann::json &j) const override
wxString	GetDefaultDescription () const override
void	SetOutputPath (const wxString &aPath)
wxString	GetOutputPath () const

Protected Attributes
wxString	m_outputPath

Detailed Description

Definition at line 25 of file jobs_output_folder.h.

Constructor & Destructor Documentation

JOBS_OUTPUT_FOLDER()

JOBS_OUTPUT_FOLDER::JOBS_OUTPUT_FOLDER

(

)

Definition at line 26 of file jobs_output_folder.cpp.

References JOBS_OUTPUT_HANDLER::JOBS_OUTPUT_HANDLER().

Member Function Documentation

FromJson()

void JOBS_OUTPUT_FOLDER::FromJson ( const nlohmann::json & j )

overridevirtual

Implements JOBS_OUTPUT_HANDLER.

Definition at line 78 of file jobs_output_folder.cpp.

References JOBS_OUTPUT_HANDLER::m_outputPath.

GetDefaultDescription()

wxString JOBS_OUTPUT_FOLDER::GetDefaultDescription ( ) const

overridevirtual

Reimplemented from JOBS_OUTPUT_HANDLER.

Definition at line 90 of file jobs_output_folder.cpp.

References _.

GetOutputPath()

wxString JOBS_OUTPUT_HANDLER::GetOutputPath ( ) const

inlineinherited

Definition at line 56 of file jobs_output.h.

References m_outputPath.

HandleOutputs()

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

overridevirtual

Implements JOBS_OUTPUT_HANDLER.

Definition at line 33 of file jobs_output_folder.cpp.

References CopyDirectory(), ExpandEnvVarSubstitutions(), ExpandTextVars(), and JOBS_OUTPUT_HANDLER::m_outputPath.

OutputPrecheck()

bool JOBS_OUTPUT_FOLDER::OutputPrecheck ( )

overridevirtual

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 from JOBS_OUTPUT_HANDLER.

Definition at line 69 of file jobs_output_folder.cpp.

References JOBS_OUTPUT_HANDLER::m_outputPath.

SetOutputPath()

void JOBS_OUTPUT_HANDLER::SetOutputPath ( const wxString & aPath )

inlineinherited

Definition at line 55 of file jobs_output.h.

References m_outputPath.

Referenced by KICAD_MANAGER_FRAME::OpenJobsFile().

ToJson()

void JOBS_OUTPUT_FOLDER::ToJson ( nlohmann::json & j ) const

overridevirtual

Implements JOBS_OUTPUT_HANDLER.

Definition at line 84 of file jobs_output_folder.cpp.

References JOBS_OUTPUT_HANDLER::m_outputPath.

Member Data Documentation

m_outputPath

wxString JOBS_OUTPUT_HANDLER::m_outputPath

protectedinherited

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 files:

• jobs_output_folder.h
• jobs_output_folder.cpp