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

#include <jobs_output_archive.h>

Inheritance diagram for JOBS_OUTPUT_ARCHIVE:
JOBS_OUTPUT_HANDLER

Public Types

enum class  FORMAT { ZIP }
 

Public Member Functions

 JOBS_OUTPUT_ARCHIVE ()
 
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
 
FORMAT GetFormat () const
 
void SetFormat (FORMAT format)
 
wxString GetDefaultDescription () const override
 
void SetOutputPath (const wxString &aPath)
 
wxString GetOutputPath () const
 

Protected Attributes

wxString m_outputPath
 

Private Attributes

FORMAT m_format
 

Detailed Description

Definition at line 25 of file jobs_output_archive.h.

Member Enumeration Documentation

◆ FORMAT

enum class JOBS_OUTPUT_ARCHIVE::FORMAT
strong
Enumerator
ZIP 

Definition at line 30 of file jobs_output_archive.h.

Constructor & Destructor Documentation

◆ JOBS_OUTPUT_ARCHIVE()

JOBS_OUTPUT_ARCHIVE::JOBS_OUTPUT_ARCHIVE ( )

Definition at line 29 of file jobs_output_archive.cpp.

References JOBS_OUTPUT_HANDLER::JOBS_OUTPUT_HANDLER(), m_format, and ZIP.

Member Function Documentation

◆ FromJson()

void JOBS_OUTPUT_ARCHIVE::FromJson ( const nlohmann::json & j)
overridevirtual

Implements JOBS_OUTPUT_HANDLER.

Definition at line 89 of file jobs_output_archive.cpp.

References m_format, JOBS_OUTPUT_HANDLER::m_outputPath, and ZIP.

◆ GetDefaultDescription()

wxString JOBS_OUTPUT_ARCHIVE::GetDefaultDescription ( ) const
overridevirtual

Reimplemented from JOBS_OUTPUT_HANDLER.

Definition at line 103 of file jobs_output_archive.cpp.

References _.

◆ GetFormat()

FORMAT JOBS_OUTPUT_ARCHIVE::GetFormat ( ) const
inline

Definition at line 44 of file jobs_output_archive.h.

References m_format.

◆ GetOutputPath()

wxString JOBS_OUTPUT_HANDLER::GetOutputPath ( ) const
inlineinherited

Definition at line 56 of file jobs_output.h.

References m_outputPath.

◆ HandleOutputs()

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

Implements JOBS_OUTPUT_HANDLER.

Definition at line 45 of file jobs_output_archive.cpp.

References AddDirectoryToZip(), FILEEXT::ArchiveFileExtension, EnsureFileExtension(), ExpandEnvVarSubstitutions(), ExpandTextVars(), and JOBS_OUTPUT_HANDLER::m_outputPath.

◆ OutputPrecheck()

bool JOBS_OUTPUT_ARCHIVE::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 36 of file jobs_output_archive.cpp.

References JOBS_OUTPUT_HANDLER::m_outputPath.

◆ SetFormat()

void JOBS_OUTPUT_ARCHIVE::SetFormat ( FORMAT format)
inline

Definition at line 45 of file jobs_output_archive.h.

References m_format.

Referenced by DIALOG_DESTINATION::TransferDataFromWindow().

◆ 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_ARCHIVE::ToJson ( nlohmann::json & j) const
overridevirtual

Implements JOBS_OUTPUT_HANDLER.

Definition at line 96 of file jobs_output_archive.cpp.

References JOBS_OUTPUT_HANDLER::m_outputPath.

Member Data Documentation

◆ m_format

FORMAT JOBS_OUTPUT_ARCHIVE::m_format
private

Definition at line 50 of file jobs_output_archive.h.

Referenced by FromJson(), GetFormat(), JOBS_OUTPUT_ARCHIVE(), and SetFormat().

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