#include <job_export_sch_plot.h>

Inheritance diagram for JOB_EXPORT_SCH_PLOT:

Public Member Functions
	JOB_EXPORT_SCH_PLOT (bool aOutputIsDirectory)

const std::string &	GetType () const

const std::map< wxString, wxString > &	GetVarOverrides () const

void	SetVarOverrides (const std::map< wxString, wxString > &aVarOverrides)

void	SetTitleBlock (const TITLE_BLOCK &aTitleBlock)

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

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

virtual wxString	GetDefaultDescription () const

virtual wxString	GetSettingsDialogTitle () const

const std::vector< JOB_PARAM_BASE * > &	GetParams ()

void	ClearExistingOutputs ()

const std::vector< JOB_OUTPUT > &	GetOutputs ()

void	AddOutput (wxString aOutputPath)

void	SetTempOutputDirectory (const wxString &aBase)
	Sets the temporary output directory for the job, this is used to prefix with a given output path when GetFullOutputPath is called.

void	SetConfiguredOutputPath (const wxString &aPath)
	Sets the configured output path for the job, this path is always saved to file.

wxString	GetConfiguredOutputPath () const
	Returns the configured output path for the job.

void	SetWorkingOutputPath (const wxString &aPath)
	Sets a transient output path for the job, it takes priority over the configured output path when GetFullOutputPath is called.

wxString	GetWorkingOutputPath () const
	Returns the working output path for the job, if one has been set.

wxString	GetFullOutputPath (PROJECT *aProject) const
	Returns the full output path for the job, taking into account the configured output path, any configured working path and the temporary output directory.

bool	GetOutputPathIsDirectory () const

Public Attributes
SCH_PLOT_FORMAT	m_plotFormat

wxString	m_filename

wxString	m_drawingSheet

wxString	m_defaultFont

bool	m_plotAll

bool	m_plotDrawingSheet

std::vector< wxString >	m_plotPages

bool	m_blackAndWhite

JOB_PAGE_SIZE	m_pageSizeSelect

bool	m_useBackgroundColor

double	m_HPGLPenSize

JOB_HPGL_PAGE_SIZE	m_HPGLPaperSizeSelect

bool	m_PDFPropertyPopups

bool	m_PDFHierarchicalLinks

bool	m_PDFMetadata

wxString	m_theme

JOB_HPGL_PLOT_ORIGIN_AND_UNITS	m_HPGLPlotOrigin

Protected Attributes
std::string	m_type

std::map< wxString, wxString >	m_varOverrides

TITLE_BLOCK	m_titleBlock

wxString	m_tempOutputDirectory

wxString	m_outputPath

bool	m_outputPathIsDirectory

wxString	m_description

wxString	m_workingOutputPath

std::vector< JOB_PARAM_BASE * >	m_params

std::vector< JOB_OUTPUT >	m_outputs

Detailed Description

Definition at line 74 of file job_export_sch_plot.h.

Constructor & Destructor Documentation

◆ JOB_EXPORT_SCH_PLOT()

JOB_EXPORT_SCH_PLOT::JOB_EXPORT_SCH_PLOT ( bool aOutputIsDirectory )

Member Function Documentation

◆ AddOutput()

void JOB::AddOutput ( wxString aOutputPath )

inlineinherited

Definition at line 209 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

◆ ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )

inlineinherited

Definition at line 207 of file job.h.

Referenced by JOB_DISPATCHER::RunJob().

◆ FromJson()

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

virtualinherited

Definition at line 60 of file job.cpp.

References JOB::m_params.

Referenced by from_json().

◆ GetConfiguredOutputPath()

wxString JOB::GetConfiguredOutputPath ( ) const

inlineinherited

Returns the configured output path for the job.

Definition at line 226 of file job.h.

◆ GetDefaultDescription()

wxString JOB::GetDefaultDescription ( ) const

virtualinherited

◆ GetFullOutputPath()

wxString JOB::GetFullOutputPath ( PROJECT * aProject ) const

inherited

Returns the full output path for the job, taking into account the configured output path, any configured working path and the temporary output directory.

Additionally variable resolution will take place

Definition at line 100 of file job.cpp.

References ExpandTextVars(), JOB::m_outputPath, JOB::m_outputPathIsDirectory, JOB::m_tempOutputDirectory, JOB::m_titleBlock, JOB::m_workingOutputPath, PrependDirectoryToPath(), PROJECT::TextVarResolver(), and TITLE_BLOCK::TextVarResolver().

◆ GetOutputPathIsDirectory()

bool JOB::GetOutputPathIsDirectory ( ) const

inlineinherited

Definition at line 247 of file job.h.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ GetOutputs()

const std::vector< JOB_OUTPUT > & JOB::GetOutputs ( )

inlineinherited

Definition at line 208 of file job.h.

◆ GetParams()

const std::vector< JOB_PARAM_BASE * > & JOB::GetParams ( )

inlineinherited

Definition at line 205 of file job.h.

◆ GetSettingsDialogTitle()

wxString JOB::GetSettingsDialogTitle ( ) const

virtualinherited

Reimplemented in JOB_EXPORT_PCB_3D, JOB_EXPORT_PCB_DRILL, JOB_EXPORT_PCB_DXF, JOB_EXPORT_PCB_GENCAD, JOB_EXPORT_PCB_GERBER, JOB_EXPORT_PCB_GERBERS, JOB_EXPORT_PCB_IPC2581, JOB_EXPORT_PCB_ODB, JOB_EXPORT_PCB_PDF, JOB_EXPORT_PCB_POS, JOB_EXPORT_PCB_SVG, JOB_EXPORT_SCH_BOM, JOB_EXPORT_SCH_NETLIST, JOB_EXPORT_SCH_PLOT_PDF, JOB_EXPORT_SCH_PLOT_DXF, JOB_EXPORT_SCH_PLOT_SVG, JOB_EXPORT_SCH_PLOT_PS, JOB_EXPORT_SCH_PLOT_HPGL, JOB_PCB_DRC, JOB_PCB_RENDER, and JOB_SCH_ERC.

Definition at line 80 of file job.cpp.

References _.

Referenced by DIALOG_PLOT::DIALOG_PLOT(), and DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC().

◆ GetType()

const std::string & JOB::GetType ( ) const

inlineinherited

Definition at line 188 of file job.h.

Referenced by JOB_DISPATCHER::HandleJobConfig(), and JOB_DISPATCHER::RunJob().

◆ GetVarOverrides()

const std::map< wxString, wxString > & JOB::GetVarOverrides ( ) const

inlineinherited

Definition at line 190 of file job.h.

◆ GetWorkingOutputPath()

wxString JOB::GetWorkingOutputPath ( ) const

inlineinherited

Returns the working output path for the job, if one has been set.

Definition at line 237 of file job.h.

◆ SetConfiguredOutputPath()

void JOB::SetConfiguredOutputPath ( const wxString & aPath )

inherited

Sets the configured output path for the job, this path is always saved to file.

Definition at line 153 of file job.cpp.

References JOB::m_outputPath.

Referenced by PCB_EDIT_FRAME::GenODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), DIALOG_EXPORT_NETLIST::NetlistUpdateOpt(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GEN_FOOTPRINT_POSITION::onGenerate(), DIALOG_SYMBOL_FIELDS_TABLE::OnOk(), DIALOG_PLOT_SCHEMATIC::OnPlotAll(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), JOBS_RUNNER::runSpecialExecute(), JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath(), JOB_EXPORT_PCB_ODB::SetDefaultOutputPath(), JOB_EXPORT_PCB_POS::SetDefaultOutputPath(), DIALOG_RC_JOB::TransferDataFromWindow(), DIALOG_EXECUTECOMMAND_JOB_SETTINGS::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), DIALOG_EXPORT_ODBPP::TransferDataFromWindow(), DIALOG_GENDRILL::TransferDataFromWindow(), DIALOG_RENDER_JOB::TransferDataFromWindow(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ SetTempOutputDirectory()

void JOB::SetTempOutputDirectory ( const wxString & aBase )

inherited

Sets the temporary output directory for the job, this is used to prefix with a given output path when GetFullOutputPath is called.

This is intended for use with running jobsets and otherwise has no impact on individual job runs outside jobsets.

Definition at line 86 of file job.cpp.

References JOB::m_tempOutputDirectory.

◆ SetTitleBlock()

void JOB::SetTitleBlock ( const TITLE_BLOCK & aTitleBlock )

inlineinherited

Definition at line 197 of file job.h.

◆ SetVarOverrides()

void JOB::SetVarOverrides ( const std::map< wxString, wxString > & aVarOverrides )

inlineinherited

Definition at line 192 of file job.h.

Referenced by CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

◆ SetWorkingOutputPath()

void JOB::SetWorkingOutputPath ( const wxString & aPath )

inlineinherited

Sets a transient output path for the job, it takes priority over the configured output path when GetFullOutputPath is called.

Definition at line 232 of file job.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), and PCBNEW_JOBS_HANDLER::JobExportSvg().

◆ ToJson()

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

virtualinherited

Definition at line 67 of file job.cpp.

References JOB::m_params.

Referenced by to_json().

Member Data Documentation

◆ m_blackAndWhite

bool JOB_EXPORT_SCH_PLOT::m_blackAndWhite

Definition at line 88 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), and DIALOG_PLOT_SCHEMATIC::OnPlotAll().

◆ m_defaultFont

wxString JOB_EXPORT_SCH_PLOT::m_defaultFont

Definition at line 82 of file job_export_sch_plot.h.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ m_description

wxString JOB::m_description

protectedinherited

Definition at line 258 of file job.h.

Referenced by JOB::JOB().

◆ m_drawingSheet

wxString JOB_EXPORT_SCH_PLOT::m_drawingSheet

Definition at line 81 of file job_export_sch_plot.h.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ m_filename

wxString JOB_EXPORT_SCH_PLOT::m_filename

Definition at line 80 of file job_export_sch_plot.h.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ m_HPGLPaperSizeSelect

JOB_HPGL_PAGE_SIZE JOB_EXPORT_SCH_PLOT::m_HPGLPaperSizeSelect

Definition at line 92 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), and EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ m_HPGLPenSize

double JOB_EXPORT_SCH_PLOT::m_HPGLPenSize

Definition at line 91 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), and DIALOG_PLOT_SCHEMATIC::OnPlotAll().

◆ m_HPGLPlotOrigin

JOB_HPGL_PLOT_ORIGIN_AND_UNITS JOB_EXPORT_SCH_PLOT::m_HPGLPlotOrigin

Definition at line 98 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), and DIALOG_PLOT_SCHEMATIC::OnPlotAll().

◆ m_outputPath

wxString JOB::m_outputPath

protectedinherited

Definition at line 256 of file job.h.

Referenced by JOB::GetFullOutputPath(), JOB::JOB(), and JOB::SetConfiguredOutputPath().

◆ m_outputPathIsDirectory

bool JOB::m_outputPathIsDirectory

protectedinherited

Definition at line 257 of file job.h.

Referenced by JOB::GetFullOutputPath(), and JOB::JOB().

◆ m_outputs

std::vector<JOB_OUTPUT> JOB::m_outputs

protectedinherited

Definition at line 263 of file job.h.

◆ m_pageSizeSelect

JOB_PAGE_SIZE JOB_EXPORT_SCH_PLOT::m_pageSizeSelect

Definition at line 89 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), and DIALOG_PLOT_SCHEMATIC::OnPlotAll().

◆ m_params

std::vector<JOB_PARAM_BASE*> JOB::m_params

protectedinherited

Definition at line 261 of file job.h.

Referenced by JOB::FromJson(), JOB::JOB(), JOB_EXPORT_PCB_3D::JOB_EXPORT_PCB_3D(), JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_GERBERS::JOB_EXPORT_PCB_GERBERS(), JOB_EXPORT_PCB_PLOT::JOB_EXPORT_PCB_PLOT(), JOB_EXPORT_SCH_BOM::JOB_EXPORT_SCH_BOM(), JOB_PCB_DRC::JOB_PCB_DRC(), JOB_SPECIAL_COPYFILES::JOB_SPECIAL_COPYFILES(), JOB_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), JOB::ToJson(), and JOB::~JOB().

◆ m_PDFHierarchicalLinks

bool JOB_EXPORT_SCH_PLOT::m_PDFHierarchicalLinks

Definition at line 94 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), and DIALOG_PLOT_SCHEMATIC::OnPlotAll().

◆ m_PDFMetadata

bool JOB_EXPORT_SCH_PLOT::m_PDFMetadata

Definition at line 95 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), and DIALOG_PLOT_SCHEMATIC::OnPlotAll().

◆ m_PDFPropertyPopups

bool JOB_EXPORT_SCH_PLOT::m_PDFPropertyPopups

Definition at line 93 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), and DIALOG_PLOT_SCHEMATIC::OnPlotAll().

◆ m_plotAll

bool JOB_EXPORT_SCH_PLOT::m_plotAll

Definition at line 84 of file job_export_sch_plot.h.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot(), and DIALOG_PLOT_SCHEMATIC::OnPlotAll().

◆ m_plotDrawingSheet

bool JOB_EXPORT_SCH_PLOT::m_plotDrawingSheet

Definition at line 85 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), and DIALOG_PLOT_SCHEMATIC::OnPlotAll().

◆ m_plotFormat

SCH_PLOT_FORMAT JOB_EXPORT_SCH_PLOT::m_plotFormat

Definition at line 79 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), and EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ m_plotPages

std::vector<wxString> JOB_EXPORT_SCH_PLOT::m_plotPages

Definition at line 86 of file job_export_sch_plot.h.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().

◆ m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory

protectedinherited

Definition at line 254 of file job.h.

Referenced by JOB::GetFullOutputPath(), and JOB::SetTempOutputDirectory().

◆ m_theme

wxString JOB_EXPORT_SCH_PLOT::m_theme

Definition at line 96 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), and DIALOG_PLOT_SCHEMATIC::OnPlotAll().

◆ m_titleBlock

TITLE_BLOCK JOB::m_titleBlock

protectedinherited

Definition at line 252 of file job.h.

Referenced by JOB::GetFullOutputPath().

◆ m_type

std::string JOB::m_type

protectedinherited

Definition at line 250 of file job.h.

◆ m_useBackgroundColor

bool JOB_EXPORT_SCH_PLOT::m_useBackgroundColor

Definition at line 90 of file job_export_sch_plot.h.

Referenced by DIALOG_PLOT_SCHEMATIC::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), and DIALOG_PLOT_SCHEMATIC::OnPlotAll().

◆ m_varOverrides

std::map<wxString, wxString> JOB::m_varOverrides

protectedinherited

Definition at line 251 of file job.h.

◆ m_workingOutputPath

wxString JOB::m_workingOutputPath

protectedinherited

Definition at line 259 of file job.h.

Referenced by JOB::GetFullOutputPath().

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

job_export_sch_plot.h

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JOB_EXPORT_SCH_PLOT()

Member Function Documentation

◆ AddOutput()

◆ ClearExistingOutputs()

◆ FromJson()

◆ GetConfiguredOutputPath()

◆ GetDefaultDescription()

◆ GetFullOutputPath()

◆ GetOutputPathIsDirectory()

◆ GetOutputs()

◆ GetParams()

◆ GetSettingsDialogTitle()

◆ GetType()

◆ GetVarOverrides()

◆ GetWorkingOutputPath()

◆ SetConfiguredOutputPath()

◆ SetTempOutputDirectory()

◆ SetTitleBlock()

◆ SetVarOverrides()

◆ SetWorkingOutputPath()

◆ ToJson()

Member Data Documentation

◆ m_blackAndWhite

◆ m_defaultFont

◆ m_description

◆ m_drawingSheet

◆ m_filename

◆ m_HPGLPaperSizeSelect

◆ m_HPGLPenSize

◆ m_HPGLPlotOrigin

◆ m_outputPath

◆ m_outputPathIsDirectory

◆ m_outputs

◆ m_pageSizeSelect

◆ m_params

◆ m_PDFHierarchicalLinks

◆ m_PDFMetadata

◆ m_PDFPropertyPopups

◆ m_plotAll

◆ m_plotDrawingSheet

◆ m_plotFormat

◆ m_plotPages

◆ m_tempOutputDirectory

◆ m_theme

◆ m_titleBlock

◆ m_type

◆ m_useBackgroundColor

◆ m_varOverrides

◆ m_workingOutputPath