KiCad PCB EDA Suite
Loading...
Searching...
No Matches
JOB_EXPORT_PCB_DXF Class Reference

#include <job_export_pcb_dxf.h>

Inheritance diagram for JOB_EXPORT_PCB_DXF:
JOB_EXPORT_PCB_PLOT JOB

Public Types

enum class  DXF_UNITS { INCHES , MILLIMETERS }
 
enum class  GEN_MODE { SINGLE , MULTI }
 
enum class  PLOT_FORMAT {
  HPGL , GERBER , POST , DXF ,
  PDF , SVG
}
 
enum class  DRILL_MARKS { NO_DRILL_SHAPE = 0 , SMALL_DRILL_SHAPE = 1 , FULL_DRILL_SHAPE = 2 }
 

Public Member Functions

 JOB_EXPORT_PCB_DXF ()
 
wxString GetDefaultDescription () const override
 
wxString GetSettingsDialogTitle () const override
 
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

bool m_plotGraphicItemsUsingContours
 
bool m_polygonMode
 
DXF_UNITS m_dxfUnits
 
GEN_MODE m_genMode
 
PLOT_FORMAT m_plotFormat
 
wxString m_filename
 
wxString m_colorTheme
 
wxString m_drawingSheet
 
bool m_mirror
 Common Options.
 
bool m_blackAndWhite
 
bool m_negative
 
bool m_sketchPadsOnFabLayers
 
bool m_hideDNPFPsOnFabLayers
 
bool m_sketchDNPFPsOnFabLayers
 
bool m_crossoutDNPFPsOnFabLayers
 
bool m_plotFootprintValues
 
bool m_plotRefDes
 
bool m_plotDrawingSheet
 
bool m_plotPadNumbers
 
bool m_plotInvisibleText
 
LSEQ m_printMaskLayer
 Layers to include on all individual layer prints.
 
LSEQ m_printMaskLayersToIncludeOnAllLayers
 
DRILL_MARKS m_drillShapeOption
 Used by SVG/DXF/PDF/Gerbers.
 
bool m_useDrillOrigin
 

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_OUTPUTm_outputs
 

Detailed Description

Definition at line 31 of file job_export_pcb_dxf.h.

Member Enumeration Documentation

◆ DRILL_MARKS

enum class JOB_EXPORT_PCB_PLOT::DRILL_MARKS
stronginherited
Enumerator
NO_DRILL_SHAPE 
SMALL_DRILL_SHAPE 
FULL_DRILL_SHAPE 

Definition at line 73 of file job_export_pcb_plot.h.

◆ DXF_UNITS

enum class JOB_EXPORT_PCB_DXF::DXF_UNITS
strong
Enumerator
INCHES 
MILLIMETERS 

Definition at line 38 of file job_export_pcb_dxf.h.

◆ GEN_MODE

enum class JOB_EXPORT_PCB_DXF::GEN_MODE
strong
Enumerator
SINGLE 
MULTI 

Definition at line 44 of file job_export_pcb_dxf.h.

◆ PLOT_FORMAT

enum class JOB_EXPORT_PCB_PLOT::PLOT_FORMAT
stronginherited
Enumerator
HPGL 
GERBER 
POST 
DXF 
PDF 
SVG 

Definition at line 33 of file job_export_pcb_plot.h.

Constructor & Destructor Documentation

◆ JOB_EXPORT_PCB_DXF()

JOB_EXPORT_PCB_DXF::JOB_EXPORT_PCB_DXF ( )

Definition at line 37 of file job_export_pcb_dxf.cpp.

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()

◆ GetDefaultDescription()

wxString JOB_EXPORT_PCB_DXF::GetDefaultDescription ( ) const
overridevirtual

Reimplemented from JOB.

Definition at line 56 of file job_export_pcb_dxf.cpp.

References _.

◆ GetFullOutputPath()

◆ 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_EXPORT_PCB_DXF::GetSettingsDialogTitle ( ) const
overridevirtual

Reimplemented from JOB.

Definition at line 62 of file job_export_pcb_dxf.cpp.

References _.

◆ 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()

◆ 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()

◆ 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()

◆ 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

◆ 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_PCB_PLOT::m_blackAndWhite
inherited

◆ m_colorTheme

wxString JOB_EXPORT_PCB_PLOT::m_colorTheme
inherited

Definition at line 48 of file job_export_pcb_plot.h.

Referenced by PCB_PLOTTER::PlotJobToPlotOpts().

◆ m_crossoutDNPFPsOnFabLayers

bool JOB_EXPORT_PCB_PLOT::m_crossoutDNPFPsOnFabLayers
inherited

◆ m_description

wxString JOB::m_description
protectedinherited

Definition at line 258 of file job.h.

Referenced by JOB::JOB().

◆ m_drawingSheet

◆ m_drillShapeOption

DRILL_MARKS JOB_EXPORT_PCB_PLOT::m_drillShapeOption
inherited

Used by SVG/DXF/PDF/Gerbers.

Definition at line 81 of file job_export_pcb_plot.h.

Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ m_dxfUnits

DXF_UNITS JOB_EXPORT_PCB_DXF::m_dxfUnits

◆ m_filename

◆ m_genMode

GEN_MODE JOB_EXPORT_PCB_DXF::m_genMode

◆ m_hideDNPFPsOnFabLayers

bool JOB_EXPORT_PCB_PLOT::m_hideDNPFPsOnFabLayers
inherited

◆ m_mirror

bool JOB_EXPORT_PCB_PLOT::m_mirror
inherited

Common Options.

Definition at line 54 of file job_export_pcb_plot.h.

Referenced by PCB_PLOTTER::PlotJobToPlotOpts(), and DIALOG_PLOT::transferPlotParamsToJob().

◆ m_negative

bool JOB_EXPORT_PCB_PLOT::m_negative
inherited

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

◆ m_plotDrawingSheet

◆ m_plotFootprintValues

bool JOB_EXPORT_PCB_PLOT::m_plotFootprintValues
inherited

◆ m_plotFormat

PLOT_FORMAT JOB_EXPORT_PCB_PLOT::m_plotFormat
inherited

◆ m_plotGraphicItemsUsingContours

bool JOB_EXPORT_PCB_DXF::m_plotGraphicItemsUsingContours

◆ m_plotInvisibleText

◆ m_plotPadNumbers

bool JOB_EXPORT_PCB_PLOT::m_plotPadNumbers
inherited

◆ m_plotRefDes

◆ m_polygonMode

bool JOB_EXPORT_PCB_DXF::m_polygonMode

◆ m_printMaskLayer

◆ m_printMaskLayersToIncludeOnAllLayers

◆ m_sketchDNPFPsOnFabLayers

bool JOB_EXPORT_PCB_PLOT::m_sketchDNPFPsOnFabLayers
inherited

◆ m_sketchPadsOnFabLayers

bool JOB_EXPORT_PCB_PLOT::m_sketchPadsOnFabLayers
inherited

◆ m_tempOutputDirectory

wxString JOB::m_tempOutputDirectory
protectedinherited

Definition at line 254 of file job.h.

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

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

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