KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CLI::EXPORT_PCB_BASE_COMMAND Struct Reference

#include <command_export_pcb_base.h>

Inheritance diagram for CLI::EXPORT_PCB_BASE_COMMAND:
CLI::COMMAND CLI::EXPORT_PCB_DRILL_COMMAND CLI::EXPORT_PCB_DXF_COMMAND CLI::EXPORT_PCB_GERBER_COMMAND CLI::EXPORT_PCB_PDF_COMMAND CLI::EXPORT_PCB_POS_COMMAND CLI::EXPORT_PCB_SVG_COMMAND CLI::EXPORT_SCH_BOM_COMMAND CLI::EXPORT_SCH_NETLIST_COMMAND CLI::EXPORT_SCH_PLOT_COMMAND CLI::EXPORT_SCH_PYTHONBOM_COMMAND CLI::FP_EXPORT_SVG_COMMAND CLI::FP_UPGRADE_COMMAND CLI::SYM_EXPORT_SVG_COMMAND CLI::SYM_UPGRADE_COMMAND

Public Member Functions

 EXPORT_PCB_BASE_COMMAND (const std::string &aName, bool aOutputIsDir=false)
 
int Perform (KIWAY &aKiway)
 Entry point to processing commands from args and doing work. More...
 
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. More...
 
LSET convertLayerStringList (wxString &aLayerString, bool &aLayerArgSet) const
 
void addLayerArg (bool aRequire)
 

Protected Attributes

std::map< std::string, LSET > m_layerMasks
 
std::map< std::string, LSET > m_layerGuiMasks
 
LSET m_selectedLayers
 
bool m_selectedLayersSet
 
bool m_hasLayerArg
 
bool m_requireLayers
 
std::string m_name
 
argparse::ArgumentParser m_argParser
 

Detailed Description

Definition at line 41 of file command_export_pcb_base.h.

Constructor & Destructor Documentation

◆ EXPORT_PCB_BASE_COMMAND()

CLI::EXPORT_PCB_BASE_COMMAND::EXPORT_PCB_BASE_COMMAND ( const std::string &  aName,
bool  aOutputIsDir = false 
)

Definition at line 31 of file command_export_pcb_base.cpp.

References _, LSET::AllCuMask(), LSET::AllLayersMask(), ARG_INPUT, ARG_OUTPUT, B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, LSET::InternalCuMask(), LayerName(), CLI::COMMAND::m_argParser, m_hasLayerArg, m_layerGuiMasks, m_layerMasks, m_requireLayers, m_selectedLayersSet, LSET::Name(), PCB_LAYER_ID_COUNT, TO_UTF8, and UTF8STDSTR.

Member Function Documentation

◆ addLayerArg()

void CLI::EXPORT_PCB_BASE_COMMAND::addLayerArg ( bool  aRequire)
protected

Definition at line 122 of file command_export_pcb_base.cpp.

References _, ARG_LAYERS, and UTF8STDSTR.

Referenced by CLI::EXPORT_PCB_DXF_COMMAND::EXPORT_PCB_DXF_COMMAND(), CLI::EXPORT_PCB_GERBER_COMMAND::EXPORT_PCB_GERBER_COMMAND(), CLI::EXPORT_PCB_PDF_COMMAND::EXPORT_PCB_PDF_COMMAND(), CLI::EXPORT_PCB_SVG_COMMAND::EXPORT_PCB_SVG_COMMAND(), and CLI::FP_EXPORT_SVG_COMMAND::FP_EXPORT_SVG_COMMAND().

◆ convertLayerStringList()

LSET CLI::EXPORT_PCB_BASE_COMMAND::convertLayerStringList ( wxString &  aLayerString,
bool &  aLayerArgSet 
) const
protected

Definition at line 86 of file command_export_pcb_base.cpp.

References _, and TO_UTF8.

◆ doPerform()

int CLI::EXPORT_PCB_BASE_COMMAND::doPerform ( KIWAY &  aKiway)
overrideprotectedvirtual

The internal handler that should be overloaded to implement command specific processing and work.

If not overloaded, the command will simply emit the help options by default

Reimplemented from CLI::COMMAND.

Reimplemented in CLI::EXPORT_PCB_DRILL_COMMAND, CLI::EXPORT_PCB_DXF_COMMAND, CLI::EXPORT_PCB_GERBER_COMMAND, CLI::EXPORT_PCB_GERBERS_COMMAND, CLI::EXPORT_PCB_PDF_COMMAND, CLI::EXPORT_PCB_POS_COMMAND, CLI::EXPORT_PCB_SVG_COMMAND, CLI::EXPORT_SCH_BOM_COMMAND, CLI::EXPORT_SCH_NETLIST_COMMAND, CLI::EXPORT_SCH_PLOT_COMMAND, CLI::EXPORT_SCH_PYTHONBOM_COMMAND, CLI::FP_EXPORT_SVG_COMMAND, CLI::FP_UPGRADE_COMMAND, CLI::SYM_EXPORT_SVG_COMMAND, and CLI::SYM_UPGRADE_COMMAND.

Definition at line 135 of file command_export_pcb_base.cpp.

References _, ARG_LAYERS, CLI::EXIT_CODES::ERR_ARGS, FROM_UTF8(), CLI::EXIT_CODES::OK, and LSET::Seq().

Referenced by CLI::EXPORT_PCB_DXF_COMMAND::doPerform(), CLI::EXPORT_PCB_GERBER_COMMAND::doPerform(), CLI::EXPORT_PCB_GERBERS_COMMAND::doPerform(), CLI::EXPORT_PCB_PDF_COMMAND::doPerform(), CLI::EXPORT_PCB_POS_COMMAND::doPerform(), CLI::EXPORT_PCB_SVG_COMMAND::doPerform(), and CLI::FP_EXPORT_SVG_COMMAND::doPerform().

◆ GetArgParser()

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

Definition at line 54 of file command.h.

References CLI::COMMAND::m_argParser.

Referenced by recurseArgParserBuild(), and recurseArgParserSubCommandUsed().

◆ GetName()

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

Definition at line 55 of file command.h.

References CLI::COMMAND::m_name.

Referenced by recurseArgParserSubCommandUsed().

◆ Perform()

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

Entry point to processing commands from args and doing work.

Definition at line 49 of file command.cpp.

References ARG_HELP.

◆ PrintHelp()

void CLI::COMMAND::PrintHelp ( )
inherited

Definition at line 41 of file command.cpp.

References FROM_UTF8().

Member Data Documentation

◆ m_argParser

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

Definition at line 68 of file command.h.

Referenced by CLI::COMMAND::COMMAND(), EXPORT_PCB_BASE_COMMAND(), CLI::EXPORT_PCB_DRILL_COMMAND::EXPORT_PCB_DRILL_COMMAND(), CLI::EXPORT_PCB_DXF_COMMAND::EXPORT_PCB_DXF_COMMAND(), CLI::EXPORT_PCB_GERBER_COMMAND::EXPORT_PCB_GERBER_COMMAND(), CLI::EXPORT_PCB_GERBERS_COMMAND::EXPORT_PCB_GERBERS_COMMAND(), CLI::EXPORT_PCB_PDF_COMMAND::EXPORT_PCB_PDF_COMMAND(), CLI::EXPORT_PCB_POS_COMMAND::EXPORT_PCB_POS_COMMAND(), CLI::EXPORT_PCB_STEP_COMMAND::EXPORT_PCB_STEP_COMMAND(), CLI::EXPORT_PCB_SVG_COMMAND::EXPORT_PCB_SVG_COMMAND(), CLI::EXPORT_SCH_BOM_COMMAND::EXPORT_SCH_BOM_COMMAND(), CLI::EXPORT_SCH_NETLIST_COMMAND::EXPORT_SCH_NETLIST_COMMAND(), CLI::EXPORT_SCH_PLOT_COMMAND::EXPORT_SCH_PLOT_COMMAND(), CLI::FP_EXPORT_SVG_COMMAND::FP_EXPORT_SVG_COMMAND(), CLI::FP_UPGRADE_COMMAND::FP_UPGRADE_COMMAND(), CLI::COMMAND::GetArgParser(), CLI::SYM_EXPORT_SVG_COMMAND::SYM_EXPORT_SVG_COMMAND(), CLI::SYM_UPGRADE_COMMAND::SYM_UPGRADE_COMMAND(), and CLI::VERSION_COMMAND::VERSION_COMMAND().

◆ m_hasLayerArg

bool CLI::EXPORT_PCB_BASE_COMMAND::m_hasLayerArg
protected

Definition at line 59 of file command_export_pcb_base.h.

Referenced by EXPORT_PCB_BASE_COMMAND().

◆ m_layerGuiMasks

std::map<std::string, LSET> CLI::EXPORT_PCB_BASE_COMMAND::m_layerGuiMasks
protected

Definition at line 54 of file command_export_pcb_base.h.

Referenced by EXPORT_PCB_BASE_COMMAND().

◆ m_layerMasks

std::map<std::string, LSET> CLI::EXPORT_PCB_BASE_COMMAND::m_layerMasks
protected

Definition at line 51 of file command_export_pcb_base.h.

Referenced by EXPORT_PCB_BASE_COMMAND().

◆ m_name

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

Definition at line 67 of file command.h.

Referenced by CLI::COMMAND::GetName().

◆ m_requireLayers

bool CLI::EXPORT_PCB_BASE_COMMAND::m_requireLayers
protected

Definition at line 60 of file command_export_pcb_base.h.

Referenced by EXPORT_PCB_BASE_COMMAND(), and CLI::EXPORT_PCB_GERBERS_COMMAND::EXPORT_PCB_GERBERS_COMMAND().

◆ m_selectedLayers

LSET CLI::EXPORT_PCB_BASE_COMMAND::m_selectedLayers
protected

Definition at line 56 of file command_export_pcb_base.h.

◆ m_selectedLayersSet

bool CLI::EXPORT_PCB_BASE_COMMAND::m_selectedLayersSet
protected

Definition at line 57 of file command_export_pcb_base.h.

Referenced by EXPORT_PCB_BASE_COMMAND().

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