JOB_EXPORT_PCB_POS Class Reference

#include <job_export_pcb_pos.h>

Inheritance diagram for JOB_EXPORT_PCB_POS:

Public Types
enum class	SIDE { FRONT , BACK , BOTH }
enum class	UNITS { INCH , MM }
enum class	FORMAT { ASCII , CSV , GERBER }

Public Member Functions
	JOB_EXPORT_PCB_POS ()
wxString	GetDefaultDescription () const override
wxString	GetSettingsDialogTitle () const override
void	SetDefaultOutputPath (const wxString &aReferenceName)
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
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
wxString	m_filename
bool	m_useDrillPlaceFileOrigin
bool	m_smdOnly
bool	m_excludeFootprintsWithTh
bool	m_excludeDNP
bool	m_negateBottomX
bool	m_singleFile
bool	m_nakedFilename
SIDE	m_side
UNITS	m_units
FORMAT	m_format
bool	m_gerberBoardEdge

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 28 of file job_export_pcb_pos.h.

Member Enumeration Documentation

FORMAT

enum class JOB_EXPORT_PCB_POS::FORMAT

strong

Enumerator
ASCII
CSV
GERBER

Definition at line 50 of file job_export_pcb_pos.h.

SIDE

enum class JOB_EXPORT_PCB_POS::SIDE

strong

Enumerator
FRONT
BACK
BOTH

Definition at line 37 of file job_export_pcb_pos.h.

UNITS

enum class JOB_EXPORT_PCB_POS::UNITS

strong

Enumerator
INCH
MM

Definition at line 44 of file job_export_pcb_pos.h.

Constructor & Destructor Documentation

JOB_EXPORT_PCB_POS()

JOB_EXPORT_PCB_POS::JOB_EXPORT_PCB_POS

(

)

References SetDefaultOutputPath().

Member Function Documentation

AddOutput()

void JOB::AddOutput ( wxString aOutputPath )

inlineinherited

Definition at line 215 of file job.h.

References m_outputs.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

ClearExistingOutputs()

void JOB::ClearExistingOutputs ( )

inlineinherited

Definition at line 213 of file job.h.

References m_outputs.

Referenced by JOB_DISPATCHER::RunJob().

FromJson()

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

virtualinherited

Definition at line 60 of file job.cpp.

References m_params.

Referenced by from_json(), and from_json().

GetConfiguredOutputPath()

wxString JOB::GetConfiguredOutputPath ( ) const

inlineinherited

Returns the configured output path for the job.

Definition at line 232 of file job.h.

References m_outputPath.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCB_PLOTTER::PlotJobToPlotOpts(), and JOBS_RUNNER::runSpecialExecute().

GetDefaultDescription()

wxString JOB_EXPORT_PCB_POS::GetDefaultDescription ( ) const

overridevirtual

Reimplemented from JOB.

Definition at line 95 of file job_export_pcb_pos.cpp.

References _.

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(), m_outputPath, m_outputPathIsDirectory, m_tempOutputDirectory, m_titleBlock, m_workingOutputPath, PrependDirectoryToPath(), and PROJECT::TextVarResolver().

Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSchErc(), JOBS_RUNNER::runSpecialCopyFiles(), and JOBS_RUNNER::runSpecialExecute().

GetOutputPathIsDirectory()

bool JOB::GetOutputPathIsDirectory ( ) const

inlineinherited

Definition at line 253 of file job.h.

References m_outputPathIsDirectory.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportPlot().

GetOutputs()

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

inlineinherited

Definition at line 214 of file job.h.

References m_outputs.

GetParams()

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

inlineinherited

Definition at line 211 of file job.h.

References m_params.

GetSettingsDialogTitle()

wxString JOB_EXPORT_PCB_POS::GetSettingsDialogTitle ( ) const

overridevirtual

Reimplemented from JOB.

Definition at line 101 of file job_export_pcb_pos.cpp.

References _.

GetType()

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

inlineinherited

Definition at line 194 of file job.h.

References m_type.

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

GetVarOverrides()

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

inlineinherited

Definition at line 196 of file job.h.

References m_varOverrides.

Referenced by PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and EESCHEMA_JOBS_HANDLER::JobSchErc().

GetWorkingOutputPath()

wxString JOB::GetWorkingOutputPath ( ) const

inlineinherited

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

Definition at line 243 of file job.h.

References m_workingOutputPath.

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 m_outputPath.

Referenced by BOARD_EDITOR_CONTROL::GenerateODBPPFiles(), EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), EESCHEMA_JOBS_HANDLER::JobSchErc(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), JOBS_RUNNER::runSpecialExecute(), JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath(), JOB_EXPORT_PCB_IPCD356::SetDefaultOutputPath(), JOB_EXPORT_PCB_ODB::SetDefaultOutputPath(), and JOB_EXPORT_PCB_POS::SetDefaultOutputPath().

SetDefaultOutputPath()

void JOB_EXPORT_PCB_POS::SetDefaultOutputPath

(

const wxString &

aReferenceName

)

Definition at line 107 of file job_export_pcb_pos.cpp.

References ASCII, CSV, FILEEXT::CsvFileExtension, FILEEXT::FootprintPlaceFileExtension, GERBER, FILEEXT::GerberFileExtension, m_format, and JOB::SetConfiguredOutputPath().

Referenced by JOB_EXPORT_PCB_POS().

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 m_tempOutputDirectory.

SetTitleBlock()

void JOB::SetTitleBlock ( const TITLE_BLOCK & aTitleBlock )

inlineinherited

Definition at line 203 of file job.h.

References m_titleBlock.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and EESCHEMA_JOBS_HANDLER::JobSchErc().

SetVarOverrides()

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

inlineinherited

Definition at line 198 of file job.h.

References m_varOverrides.

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 238 of file job.h.

References m_workingOutputPath.

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::JobExportIpcD356(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), 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 m_params.

Referenced by to_json().

Member Data Documentation

m_description

wxString JOB::m_description

protectedinherited

Definition at line 264 of file job.h.

Referenced by JOB().

m_excludeDNP

bool JOB_EXPORT_PCB_POS::m_excludeDNP

Definition at line 63 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

m_excludeFootprintsWithTh

bool JOB_EXPORT_PCB_POS::m_excludeFootprintsWithTh

Definition at line 62 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

m_filename

wxString JOB_EXPORT_PCB_POS::m_filename

Definition at line 58 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

m_format

FORMAT JOB_EXPORT_PCB_POS::m_format

Definition at line 69 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos(), and SetDefaultOutputPath().

m_gerberBoardEdge

bool JOB_EXPORT_PCB_POS::m_gerberBoardEdge

Definition at line 70 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

m_nakedFilename

bool JOB_EXPORT_PCB_POS::m_nakedFilename

Definition at line 66 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

m_negateBottomX

bool JOB_EXPORT_PCB_POS::m_negateBottomX

Definition at line 64 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

m_outputPath

wxString JOB::m_outputPath

protectedinherited

Definition at line 262 of file job.h.

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

m_outputPathIsDirectory

bool JOB::m_outputPathIsDirectory

protectedinherited

Definition at line 263 of file job.h.

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

m_outputs

std::vector<JOB_OUTPUT> JOB::m_outputs

protectedinherited

Definition at line 269 of file job.h.

Referenced by AddOutput(), ClearExistingOutputs(), and GetOutputs().

m_params

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

protectedinherited

Definition at line 267 of file job.h.

Referenced by FromJson(), GetParams(), JOB(), JOB_EXPORT_PCB_3D::JOB_EXPORT_PCB_3D(), JOB_EXPORT_PCB_DXF::JOB_EXPORT_PCB_DXF(), JOB_EXPORT_PCB_GENCAD::JOB_EXPORT_PCB_GENCAD(), JOB_EXPORT_PCB_GERBER::JOB_EXPORT_PCB_GERBER(), JOB_EXPORT_PCB_GERBERS::JOB_EXPORT_PCB_GERBERS(), JOB_EXPORT_PCB_IPC2581::JOB_EXPORT_PCB_IPC2581(), JOB_EXPORT_PCB_ODB::JOB_EXPORT_PCB_ODB(), JOB_EXPORT_SCH_BOM::JOB_EXPORT_SCH_BOM(), JOB_PCB_DRC::JOB_PCB_DRC(), JOB_PCB_RENDER::JOB_PCB_RENDER(), JOB_RC::JOB_RC(), JOB_SPECIAL_COPYFILES::JOB_SPECIAL_COPYFILES(), JOB_SPECIAL_EXECUTE::JOB_SPECIAL_EXECUTE(), ToJson(), and ~JOB().

m_side

SIDE JOB_EXPORT_PCB_POS::m_side

Definition at line 67 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

m_singleFile

bool JOB_EXPORT_PCB_POS::m_singleFile

Definition at line 65 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

m_smdOnly

bool JOB_EXPORT_PCB_POS::m_smdOnly

Definition at line 61 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory

protectedinherited

Definition at line 260 of file job.h.

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

m_titleBlock

TITLE_BLOCK JOB::m_titleBlock

protectedinherited

Definition at line 258 of file job.h.

Referenced by GetFullOutputPath(), and SetTitleBlock().

m_type

std::string JOB::m_type

protectedinherited

Definition at line 256 of file job.h.

Referenced by GetType(), and JOB().

m_units

UNITS JOB_EXPORT_PCB_POS::m_units

Definition at line 68 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

m_useDrillPlaceFileOrigin

bool JOB_EXPORT_PCB_POS::m_useDrillPlaceFileOrigin

Definition at line 60 of file job_export_pcb_pos.h.

Referenced by PCBNEW_JOBS_HANDLER::JobExportPos().

m_varOverrides

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

protectedinherited

Definition at line 257 of file job.h.

Referenced by GetVarOverrides(), JOB(), and SetVarOverrides().

m_workingOutputPath

wxString JOB::m_workingOutputPath

protectedinherited

Definition at line 265 of file job.h.

Referenced by GetFullOutputPath(), GetWorkingOutputPath(), JOB(), and SetWorkingOutputPath().

---

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

• job_export_pcb_pos.h
• job_export_pcb_pos.cpp