KiCad PCB EDA Suite
Loading...
Searching...
No Matches
CLI::PCB_EXPORT_SVG_COMMAND Struct Reference

#include <command_pcb_export_svg.h>

Inheritance diagram for CLI::PCB_EXPORT_SVG_COMMAND:
CLI::PCB_EXPORT_BASE_COMMAND CLI::COMMAND

Public Member Functions

 PCB_EXPORT_SVG_COMMAND ()
 
int Perform (KIWAY &aKiway)
 Entry point to processing commands from args and doing work.
 
argparse::ArgumentParser & GetArgParser ()
 
const std::string & GetName () const
 
void PrintHelp ()
 

Protected Member Functions

int doPerform (KIWAY &aKiway) override
 The internal handler that should be overloaded to implement command specific processing and work.
 
void addLayerArg ()
 
void addCommonLayersArg ()
 
void addCommonArgs (bool aInput, bool aOutput, bool aInputCanBeDir, bool aOutputIsDir)
 Set up the most common of args used across cli.
 
void addDrawingSheetArg ()
 Set up the drawing sheet arg used by many of the export commands.
 
void addDefineArg ()
 Set up the drawing sheet arg used by many of the export commands.
 

Protected Attributes

std::string m_name
 Name of this command that is exported and used in the cli.
 
argparse::ArgumentParser m_argParser
 
bool m_hasInputArg
 Whether or not the input arg was added for parsing.
 
bool m_hasOutputArg
 Whether or not the output arg was added for parsing.
 
bool m_hasDrawingSheetArg
 Whether or not the input arg was added for parsing.
 
bool m_hasDefineArg
 Whether or not the input arg was added for parsing.
 
bool m_outputArgExpectsDir
 Whether or not the output arg is expecting a directory.
 
wxString m_argInput
 Value of the common input arg if configured.
 
wxString m_argOutput
 Value of the output arg if configured.
 
wxString m_argDrawingSheet
 Value of the drawing sheet arg if configured.
 
std::map< wxString, wxString > m_argDefineVars
 Value of the drawing sheet arg if configured.
 

Detailed Description

Definition at line 28 of file command_pcb_export_svg.h.

Constructor & Destructor Documentation

◆ PCB_EXPORT_SVG_COMMAND()

Member Function Documentation

◆ addCommonArgs()

void CLI::COMMAND::addCommonArgs ( bool aInput,
bool aOutput,
bool aInputCanBeDir,
bool aOutputIsDir )
protectedinherited

◆ addCommonLayersArg()

◆ addDefineArg()

◆ addDrawingSheetArg()

◆ addLayerArg()

◆ doPerform()

◆ GetArgParser()

argparse::ArgumentParser & CLI::COMMAND::GetArgParser ( )
inlineinherited

Definition at line 59 of file command.h.

References m_argParser.

Referenced by recurseArgParserBuild(), and recurseArgParserSubCommandUsed().

◆ GetName()

const std::string & CLI::COMMAND::GetName ( ) const
inlineinherited

Definition at line 60 of file command.h.

References m_name.

Referenced by recurseArgParserSubCommandUsed().

◆ Perform()

int CLI::COMMAND::Perform ( KIWAY & aKiway)
inherited

◆ PrintHelp()

void CLI::COMMAND::PrintHelp ( )
inherited

Definition at line 48 of file command.cpp.

References From_UTF8(), and m_argParser.

Referenced by doPerform(), and Perform().

Member Data Documentation

◆ m_argDefineVars

◆ m_argDrawingSheet

◆ m_argInput

◆ m_argOutput

◆ m_argParser

argparse::ArgumentParser CLI::COMMAND::m_argParser
protectedinherited

Definition at line 100 of file command.h.

Referenced by addCommonArgs(), CLI::PCB_EXPORT_BASE_COMMAND::addCommonLayersArg(), addDefineArg(), addDrawingSheetArg(), CLI::PCB_EXPORT_BASE_COMMAND::addLayerArg(), COMMAND(), CLI::FP_EXPORT_SVG_COMMAND::doPerform(), CLI::FP_UPGRADE_COMMAND::doPerform(), CLI::JOBSET_RUN_COMMAND::doPerform(), CLI::PCB_DRC_COMMAND::doPerform(), CLI::PCB_EXPORT_3D_COMMAND::doPerform(), CLI::PCB_EXPORT_DRILL_COMMAND::doPerform(), CLI::PCB_EXPORT_DXF_COMMAND::doPerform(), CLI::PCB_EXPORT_GENCAD_COMMAND::doPerform(), CLI::PCB_EXPORT_GERBERS_COMMAND::doPerform(), CLI::PCB_EXPORT_IPC2581_COMMAND::doPerform(), CLI::PCB_EXPORT_ODB_COMMAND::doPerform(), CLI::PCB_EXPORT_PDF_COMMAND::doPerform(), CLI::PCB_EXPORT_POS_COMMAND::doPerform(), CLI::PCB_EXPORT_PS_COMMAND::doPerform(), CLI::PCB_EXPORT_SVG_COMMAND::doPerform(), CLI::PCB_RENDER_COMMAND::doPerform(), CLI::PCB_UPGRADE_COMMAND::doPerform(), CLI::SCH_ERC_COMMAND::doPerform(), CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), CLI::SCH_EXPORT_NETLIST_COMMAND::doPerform(), CLI::SCH_EXPORT_PLOT_COMMAND::doPerform(), CLI::SCH_UPGRADE_COMMAND::doPerform(), CLI::SYM_EXPORT_SVG_COMMAND::doPerform(), CLI::SYM_UPGRADE_COMMAND::doPerform(), CLI::VERSION_COMMAND::doPerform(), CLI::FP_COMMAND::FP_COMMAND(), CLI::FP_EXPORT_COMMAND::FP_EXPORT_COMMAND(), CLI::FP_EXPORT_SVG_COMMAND::FP_EXPORT_SVG_COMMAND(), CLI::FP_UPGRADE_COMMAND::FP_UPGRADE_COMMAND(), GetArgParser(), CLI::JOBSET_COMMAND::JOBSET_COMMAND(), CLI::JOBSET_RUN_COMMAND::JOBSET_RUN_COMMAND(), CLI::PCB_COMMAND::PCB_COMMAND(), CLI::PCB_DRC_COMMAND::PCB_DRC_COMMAND(), CLI::PCB_EXPORT_3D_COMMAND::PCB_EXPORT_3D_COMMAND(), CLI::PCB_EXPORT_COMMAND::PCB_EXPORT_COMMAND(), CLI::PCB_EXPORT_DRILL_COMMAND::PCB_EXPORT_DRILL_COMMAND(), CLI::PCB_EXPORT_DXF_COMMAND::PCB_EXPORT_DXF_COMMAND(), CLI::PCB_EXPORT_GENCAD_COMMAND::PCB_EXPORT_GENCAD_COMMAND(), CLI::PCB_EXPORT_GERBER_COMMAND::PCB_EXPORT_GERBER_COMMAND(), CLI::PCB_EXPORT_GERBERS_COMMAND::PCB_EXPORT_GERBERS_COMMAND(), CLI::PCB_EXPORT_HPGL_COMMAND::PCB_EXPORT_HPGL_COMMAND(), CLI::PCB_EXPORT_IPC2581_COMMAND::PCB_EXPORT_IPC2581_COMMAND(), CLI::PCB_EXPORT_IPCD356_COMMAND::PCB_EXPORT_IPCD356_COMMAND(), CLI::PCB_EXPORT_ODB_COMMAND::PCB_EXPORT_ODB_COMMAND(), CLI::PCB_EXPORT_PDF_COMMAND::PCB_EXPORT_PDF_COMMAND(), CLI::PCB_EXPORT_POS_COMMAND::PCB_EXPORT_POS_COMMAND(), CLI::PCB_EXPORT_PS_COMMAND::PCB_EXPORT_PS_COMMAND(), CLI::PCB_EXPORT_SVG_COMMAND::PCB_EXPORT_SVG_COMMAND(), CLI::PCB_RENDER_COMMAND::PCB_RENDER_COMMAND(), CLI::PCB_UPGRADE_COMMAND::PCB_UPGRADE_COMMAND(), Perform(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), PrintHelp(), CLI::SCH_COMMAND::SCH_COMMAND(), CLI::SCH_ERC_COMMAND::SCH_ERC_COMMAND(), CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND(), CLI::SCH_EXPORT_COMMAND::SCH_EXPORT_COMMAND(), CLI::SCH_EXPORT_NETLIST_COMMAND::SCH_EXPORT_NETLIST_COMMAND(), CLI::SCH_EXPORT_PLOT_COMMAND::SCH_EXPORT_PLOT_COMMAND(), CLI::SCH_EXPORT_PYTHONBOM_COMMAND::SCH_EXPORT_PYTHONBOM_COMMAND(), CLI::SCH_UPGRADE_COMMAND::SCH_UPGRADE_COMMAND(), CLI::SYM_COMMAND::SYM_COMMAND(), CLI::SYM_EXPORT_COMMAND::SYM_EXPORT_COMMAND(), CLI::SYM_EXPORT_SVG_COMMAND::SYM_EXPORT_SVG_COMMAND(), CLI::SYM_UPGRADE_COMMAND::SYM_UPGRADE_COMMAND(), and CLI::VERSION_COMMAND::VERSION_COMMAND().

◆ m_hasDefineArg

bool CLI::COMMAND::m_hasDefineArg
protectedinherited

Whether or not the input arg was added for parsing.

Definition at line 120 of file command.h.

Referenced by addDefineArg(), COMMAND(), and Perform().

◆ m_hasDrawingSheetArg

bool CLI::COMMAND::m_hasDrawingSheetArg
protectedinherited

Whether or not the input arg was added for parsing.

Definition at line 115 of file command.h.

Referenced by addDrawingSheetArg(), COMMAND(), and Perform().

◆ m_hasInputArg

bool CLI::COMMAND::m_hasInputArg
protectedinherited

Whether or not the input arg was added for parsing.

Definition at line 105 of file command.h.

Referenced by addCommonArgs(), COMMAND(), and Perform().

◆ m_hasOutputArg

bool CLI::COMMAND::m_hasOutputArg
protectedinherited

Whether or not the output arg was added for parsing.

Definition at line 110 of file command.h.

Referenced by addCommonArgs(), COMMAND(), and Perform().

◆ m_name

std::string CLI::COMMAND::m_name
protectedinherited

Name of this command that is exported and used in the cli.

Definition at line 98 of file command.h.

Referenced by COMMAND(), and GetName().

◆ m_outputArgExpectsDir

bool CLI::COMMAND::m_outputArgExpectsDir
protectedinherited

Whether or not the output arg is expecting a directory.

Definition at line 125 of file command.h.

Referenced by addCommonArgs(), and COMMAND().


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