#include <command_pcb_drc.h>

Inheritance diagram for CLI::PCB_DRC_COMMAND:

Public Member Functions
	PCB_DRC_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	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.

void	addVariantsArg ()
	Set up the list of variants to output arguement.

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.

bool	m_hasVariantsArg
	Whether or not the input arguement for variant names was added for parsing.

std::set< wxString >	m_argVariantNames
	A set of variant names to output.

Detailed Description

Definition at line 28 of file command_pcb_drc.h.

Constructor & Destructor Documentation

◆ PCB_DRC_COMMAND()

CLI::PCB_DRC_COMMAND::PCB_DRC_COMMAND ( )

Definition at line 44 of file command_pcb_drc.cpp.

References _, CLI::COMMAND::addCommonArgs(), CLI::COMMAND::addDefineArg(), ARG_ALL_TRACK_ERRORS, ARG_EXIT_CODE_VIOLATIONS, ARG_FORMAT, ARG_PARITY, ARG_SAVE_BOARD, ARG_SEVERITY_ALL, ARG_SEVERITY_ERROR, ARG_SEVERITY_EXCLUSIONS, ARG_SEVERITY_WARNING, ARG_UNITS, ARG_ZONE_FILL, CLI::COMMAND::COMMAND(), CLI::COMMAND::m_argParser, and UTF8STDSTR.

Member Function Documentation

◆ addCommonArgs()

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

protectedinherited

Set up the most common of args used across cli.

Parameters

aInput	Configures the input arg
aOutput	Configures the output arg
aInputCanBeDir	Configures whether the input arg description will be for either a file or directory
aOutputIsDir	Configures whether the output arg description will be for a file or directory

Definition at line 125 of file command.cpp.

References _, ARG_INPUT, ARG_OUTPUT, m_argParser, m_hasInputArg, m_hasOutputArg, m_outputArgExpectsDir, 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::PCB_UPGRADE_COMMAND::PCB_UPGRADE_COMMAND(), CLI::SCH_ERC_COMMAND::SCH_ERC_COMMAND(), CLI::SCH_EXPORT_BOM_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::SCH_UPGRADE_COMMAND::SCH_UPGRADE_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 178 of file command.cpp.

References _, ARG_DEFINE_VAR_LONG, ARG_DEFINE_VAR_SHORT, m_argParser, m_hasDefineArg, and UTF8STDSTR.

◆ addDrawingSheetArg()

void CLI::COMMAND::addDrawingSheetArg ( )

protectedinherited

Set up the drawing sheet arg used by many of the export commands.

Definition at line 166 of file command.cpp.

References _, ARG_DRAWING_SHEET, m_argParser, m_hasDrawingSheetArg, and UTF8STDSTR.

Referenced by CLI::PCB_EXPORT_DXF_COMMAND::PCB_EXPORT_DXF_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_PS_COMMAND::PCB_EXPORT_PS_COMMAND(), CLI::PCB_EXPORT_SVG_COMMAND::PCB_EXPORT_SVG_COMMAND(), and CLI::SCH_EXPORT_PLOT_COMMAND::SCH_EXPORT_PLOT_COMMAND().

◆ addVariantsArg()

void CLI::COMMAND::addVariantsArg ( )

protectedinherited

Set up the list of variants to output arguement.

Definition at line 193 of file command.cpp.

References _, ARG_VARIANTS, m_argParser, m_hasVariantsArg, and UTF8STDSTR.

◆ doPerform()

int CLI::PCB_DRC_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 104 of file command_pcb_drc.cpp.

References _, ARG_ALL_TRACK_ERRORS, ARG_EXIT_CODE_VIOLATIONS, ARG_FORMAT, ARG_PARITY, ARG_SAVE_BOARD, ARG_SEVERITY_ALL, ARG_SEVERITY_ERROR, ARG_SEVERITY_EXCLUSIONS, ARG_SEVERITY_WARNING, ARG_UNITS, ARG_ZONE_FILL, CLI::EXIT_CODES::ERR_ARGS, KIWAY::FACE_PCB, From_UTF8(), JOB_RC::INCH, JOB_RC::JSON, CLI::COMMAND::m_argDefineVars, CLI::COMMAND::m_argInput, CLI::COMMAND::m_argOutput, CLI::COMMAND::m_argParser, JOB_RC::MILS, JOB_RC::MM, KIWAY::ProcessJob(), JOB_RC::REPORT, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, and RPT_SEVERITY_WARNING.

◆ GetArgParser()

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

inlineinherited

Definition at line 60 of file command.h.

References m_argParser.

Referenced by recurseArgParserBuild(), and recurseArgParserSubCommandUsed().

◆ GetName()

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

inlineinherited

Definition at line 61 of file command.h.

References 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 56 of file command.cpp.

References ARG_DEFINE_VAR_LONG, ARG_DRAWING_SHEET, ARG_HELP, ARG_INPUT, ARG_OUTPUT, ARG_VARIANTS, doPerform(), CLI::EXIT_CODES::ERR_ARGS, From_UTF8(), m_argDefineVars, m_argDrawingSheet, m_argInput, m_argOutput, m_argParser, m_argVariantNames, m_hasDefineArg, m_hasDrawingSheetArg, m_hasInputArg, m_hasOutputArg, m_hasVariantsArg, PrintHelp(), and wxStringSplit().

◆ 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

std::map<wxString, wxString> CLI::COMMAND::m_argDefineVars

protectedinherited

Value of the drawing sheet arg if configured.

Definition at line 151 of file command.h.

◆ m_argDrawingSheet

wxString CLI::COMMAND::m_argDrawingSheet

protectedinherited

Value of the drawing sheet arg if configured.

Definition at line 146 of file command.h.

Referenced by CLI::PCB_EXPORT_DXF_COMMAND::doPerform(), CLI::PCB_EXPORT_IPC2581_COMMAND::doPerform(), CLI::PCB_EXPORT_ODB_COMMAND::doPerform(), CLI::PCB_EXPORT_PDF_COMMAND::doPerform(), CLI::PCB_EXPORT_PS_COMMAND::doPerform(), CLI::PCB_EXPORT_SVG_COMMAND::doPerform(), CLI::SCH_EXPORT_PLOT_COMMAND::doPerform(), Perform(), and CLI::PCB_EXPORT_GERBER_COMMAND::populateJob().

◆ m_argInput

wxString CLI::COMMAND::m_argInput

protectedinherited

Value of the common input arg if configured.

Definition at line 136 of file command.h.

◆ m_argOutput

wxString CLI::COMMAND::m_argOutput

protectedinherited

Value of the output arg if configured.

Definition at line 141 of file command.h.

◆ m_argParser

argparse::ArgumentParser CLI::COMMAND::m_argParser

protectedinherited

Definition at line 106 of file command.h.

◆ m_argVariantNames

std::set<wxString> CLI::COMMAND::m_argVariantNames

protectedinherited

A set of variant names to output.

An empty set indicates the default variant only.

Definition at line 163 of file command.h.

Referenced by Perform().

◆ m_hasDefineArg

bool CLI::COMMAND::m_hasDefineArg

protectedinherited

Whether or not the input arg was added for parsing.

Definition at line 126 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 121 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 111 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 116 of file command.h.

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

◆ m_hasVariantsArg

bool CLI::COMMAND::m_hasVariantsArg

protectedinherited

Whether or not the input arguement for variant names was added for parsing.

Definition at line 156 of file command.h.

Referenced by addVariantsArg(), 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 104 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 131 of file command.h.

Referenced by addCommonArgs(), and COMMAND().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PCB_DRC_COMMAND()

Member Function Documentation

◆ addCommonArgs()

◆ addDefineArg()

◆ addDrawingSheetArg()

◆ addVariantsArg()

◆ doPerform()

◆ GetArgParser()

◆ GetName()

◆ Perform()

◆ PrintHelp()

Member Data Documentation

◆ m_argDefineVars

◆ m_argDrawingSheet

◆ m_argInput

◆ m_argOutput

◆ m_argParser

◆ m_argVariantNames

◆ m_hasDefineArg

◆ m_hasDrawingSheetArg

◆ m_hasInputArg

◆ m_hasOutputArg

◆ m_hasVariantsArg

◆ m_name

◆ m_outputArgExpectsDir