#include <command_sch_export_bom.h>
|
int | doPerform (KIWAY &aKiway) override |
| The internal handler that should be overloaded to implement command specific processing and work.
|
|
void | addCommonArgs (bool aInput, bool aOutput, bool aInputIsDir, 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.
|
|
|
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.
|
|
Definition at line 83 of file command_sch_export_bom.h.
◆ SCH_EXPORT_BOM_COMMAND()
CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND |
( |
| ) |
|
Definition at line 34 of file command_sch_export_bom.cpp.
References _, CLI::COMMAND::addCommonArgs(), ARG_EXCLUDE_DNP, ARG_EXCLUDE_DNP_DESC, ARG_FIELD_DELIMITER, ARG_FIELD_DELIMITER_DESC, ARG_FIELDS, ARG_FIELDS_DESC, ARG_FILTER, ARG_FILTER_DESC, ARG_FMT_PRESET, ARG_FMT_PRESET_DESC, ARG_GROUP_BY, ARG_GROUP_BY_DESC, ARG_KEEP_LINE_BREAKS, ARG_KEEP_LINE_BREAKS_DESC, ARG_KEEP_TABS, ARG_KEEP_TABS_DESC, ARG_LABELS, ARG_LABELS_DESC, ARG_PRESET, ARG_PRESET_DESC, ARG_REF_DELIMITER, ARG_REF_DELIMITER_DESC, ARG_REF_RANGE_DELIMITER, ARG_REF_RANGE_DELIMITER_DESC, ARG_SORT_ASC, ARG_SORT_ASC_DESC, ARG_SORT_FIELD, ARG_SORT_FIELD_DESC, ARG_STRING_DELIMITER, ARG_STRING_DELIMITER_DESC, CLI::COMMAND::m_argParser, and UTF8STDSTR.
◆ addCommonArgs()
void CLI::COMMAND::addCommonArgs |
( |
bool |
aInput, |
|
|
bool |
aOutput, |
|
|
bool |
aInputIsDir, |
|
|
bool |
aOutputIsDir |
|
) |
| |
|
protectedinherited |
Set up the most common of args used across cli.
- Parameters
-
aInput | Configures the input arg |
aOutput | Configures the output arg |
aInputIsDir | Configures whether the input arg description will be for a file or directory |
aOutputIsDir | Configures whether the output arg description will be for a file or directory |
Definition at line 115 of file command.cpp.
References _, ARG_INPUT, ARG_OUTPUT, and UTF8STDSTR.
Referenced by CLI::JOBSET_RUN_COMMAND::JOBSET_RUN_COMMAND(), CLI::PCB_DRC_COMMAND::PCB_DRC_COMMAND(), CLI::PCB_EXPORT_3D_COMMAND::PCB_EXPORT_3D_COMMAND(), CLI::PCB_EXPORT_BASE_COMMAND::PCB_EXPORT_BASE_COMMAND(), CLI::PCB_RENDER_COMMAND::PCB_RENDER_COMMAND(), CLI::SCH_ERC_COMMAND::SCH_ERC_COMMAND(), SCH_EXPORT_BOM_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::SYM_EXPORT_SVG_COMMAND::SYM_EXPORT_SVG_COMMAND(), and CLI::SYM_UPGRADE_COMMAND::SYM_UPGRADE_COMMAND().
◆ addDefineArg()
void CLI::COMMAND::addDefineArg |
( |
| ) |
|
|
protectedinherited |
Set up the drawing sheet arg used by many of the export commands.
Definition at line 169 of file command.cpp.
References _, ARG_DEFINE_VAR_LONG, ARG_DEFINE_VAR_SHORT, and UTF8STDSTR.
Referenced by CLI::FP_EXPORT_SVG_COMMAND::FP_EXPORT_SVG_COMMAND(), CLI::PCB_DRC_COMMAND::PCB_DRC_COMMAND(), CLI::PCB_EXPORT_3D_COMMAND::PCB_EXPORT_3D_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_IPC2581_COMMAND::PCB_EXPORT_IPC2581_COMMAND(), CLI::PCB_EXPORT_ODB_COMMAND::PCB_EXPORT_ODB_COMMAND(), CLI::PCB_EXPORT_PDF_COMMAND::PCB_EXPORT_PDF_COMMAND(), CLI::PCB_EXPORT_SVG_COMMAND::PCB_EXPORT_SVG_COMMAND(), CLI::PCB_RENDER_COMMAND::PCB_RENDER_COMMAND(), CLI::SCH_ERC_COMMAND::SCH_ERC_COMMAND(), and CLI::SCH_EXPORT_PLOT_COMMAND::SCH_EXPORT_PLOT_COMMAND().
◆ addDrawingSheetArg()
void CLI::COMMAND::addDrawingSheetArg |
( |
| ) |
|
|
protectedinherited |
◆ convertStringList()
std::vector< wxString > CLI::SCH_EXPORT_BOM_COMMAND::convertStringList |
( |
const wxString & |
aList | ) |
|
|
private |
◆ doPerform()
int CLI::SCH_EXPORT_BOM_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.
Definition at line 131 of file command_sch_export_bom.cpp.
References _, ARG_EXCLUDE_DNP, ARG_FIELD_DELIMITER, ARG_FIELDS, ARG_FILTER, ARG_FMT_PRESET, ARG_GROUP_BY, ARG_INCLUDE_EXCLUDED_FROM_BOM, ARG_KEEP_LINE_BREAKS, ARG_KEEP_TABS, ARG_LABELS, ARG_PRESET, ARG_REF_DELIMITER, ARG_REF_RANGE_DELIMITER, ARG_SORT_ASC, ARG_SORT_FIELD, ARG_STRING_DELIMITER, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, KIWAY::FACE_SCH, From_UTF8(), and KIWAY::ProcessJob().
◆ GetArgParser()
argparse::ArgumentParser & CLI::COMMAND::GetArgParser |
( |
| ) |
|
|
inlineinherited |
◆ GetName()
const std::string & CLI::COMMAND::GetName |
( |
| ) |
const |
|
inlineinherited |
◆ Perform()
int CLI::COMMAND::Perform |
( |
KIWAY & |
aKiway | ) |
|
|
inherited |
◆ PrintHelp()
void CLI::COMMAND::PrintHelp |
( |
| ) |
|
|
inherited |
◆ m_argDefineVars
std::map<wxString, wxString> CLI::COMMAND::m_argDefineVars |
|
protectedinherited |
Value of the drawing sheet arg if configured.
Definition at line 145 of file command.h.
◆ m_argDrawingSheet
wxString CLI::COMMAND::m_argDrawingSheet |
|
protectedinherited |
Value of the drawing sheet arg if configured.
Definition at line 140 of file command.h.
◆ m_argInput
wxString CLI::COMMAND::m_argInput |
|
protectedinherited |
Value of the common input arg if configured.
Definition at line 130 of file command.h.
◆ m_argOutput
wxString CLI::COMMAND::m_argOutput |
|
protectedinherited |
Value of the output arg if configured.
Definition at line 135 of file command.h.
◆ m_argParser
argparse::ArgumentParser CLI::COMMAND::m_argParser |
|
protectedinherited |
Definition at line 100 of file command.h.
Referenced by CLI::COMMAND::COMMAND(), 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(), CLI::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_IPC2581_COMMAND::PCB_EXPORT_IPC2581_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_SVG_COMMAND::PCB_EXPORT_SVG_COMMAND(), CLI::PCB_RENDER_COMMAND::PCB_RENDER_COMMAND(), CLI::SCH_COMMAND::SCH_COMMAND(), CLI::SCH_ERC_COMMAND::SCH_ERC_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::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.
◆ 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.
◆ 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.
◆ 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.
◆ m_name
std::string CLI::COMMAND::m_name |
|
protectedinherited |
◆ 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.
The documentation for this class was generated from the following files: