#include <command_pcb_diff.h>

Inheritance diagram for CLI::PCB_DIFF_COMMAND:

Public Types
enum	IO_TYPE

Public Member Functions
	PCB_DIFF_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, IO_TYPE aInputType, IO_TYPE aOutputType)
	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.

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_hasVariantArg
	Whether or not the input argument for variant names was added for parsing.

std::vector< wxString >	m_argVariantNames
	The list of variant names to output.

Private Attributes
std::string	m_argA

std::string	m_argB

KIWAY::FACE_T	m_face

Detailed Description

Definition at line 35 of file command_pcb_diff.h.

Member Enumeration Documentation

◆ IO_TYPE

enum CLI::COMMAND::IO_TYPE

stronginherited

Definition at line 65 of file command.h.

Constructor & Destructor Documentation

◆ PCB_DIFF_COMMAND()

CLI::PCB_DIFF_COMMAND::PCB_DIFF_COMMAND ( )

Definition at line 27 of file command_pcb_diff.cpp.

References _, and CLI::DIFF_COMMAND< JOB_PCB_DIFF >::DIFF_COMMAND().

Member Function Documentation

◆ addCommonArgs()

void CLI::COMMAND::addCommonArgs	(	bool	aInput,
		bool	aOutput,
		IO_TYPE	aInputType,
		IO_TYPE	aOutputType )

protectedinherited

Set up the most common of args used across cli.

Parameters

aInput	Configures the input arg
aOutput	Configures the output arg
aInputType	Configures whether the input arg description will be for either a file, a directory or either
aOutputType	Configures whether the output arg description will be for a file, a directory or either

Definition at line 83 of file command.cpp.

◆ addDefineArg()

void CLI::COMMAND::addDefineArg ( )

protectedinherited

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

Definition at line 93 of file command.cpp.

◆ addDrawingSheetArg()

void CLI::COMMAND::addDrawingSheetArg ( )

protectedinherited

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

Definition at line 88 of file command.cpp.

◆ addVariantsArg()

void CLI::COMMAND::addVariantsArg ( )

protectedinherited

Set up the list of variants to output arguement.

Definition at line 98 of file command.cpp.

◆ doPerform()

int CLI::DIFF_COMMAND< JOB_PCB_DIFF >::doPerform ( KIWAY & aKiway )

inlineoverrideprotectedvirtualinherited

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 87 of file command_diff_base.h.

◆ GetArgParser()

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

inlineinherited

Definition at line 60 of file command.h.

◆ GetName()

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

inlineinherited

Definition at line 61 of file command.h.

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

◆ PrintHelp()

void CLI::COMMAND::PrintHelp ( )

inherited

Definition at line 63 of file command.cpp.

Member Data Documentation

◆ m_argA

std::string CLI::DIFF_COMMAND< JOB_PCB_DIFF >::m_argA

privateinherited

Definition at line 116 of file command_diff_base.h.

◆ m_argB

std::string CLI::DIFF_COMMAND< JOB_PCB_DIFF >::m_argB

privateinherited

Definition at line 117 of file command_diff_base.h.

◆ m_argDefineVars

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

protectedinherited

Value of the drawing sheet arg if configured.

Definition at line 153 of file command.h.

◆ m_argDrawingSheet

wxString CLI::COMMAND::m_argDrawingSheet

protectedinherited

Value of the drawing sheet arg if configured.

Definition at line 148 of file command.h.

◆ m_argInput

wxString CLI::COMMAND::m_argInput

protectedinherited

Value of the common input arg if configured.

Definition at line 138 of file command.h.

◆ m_argOutput

wxString CLI::COMMAND::m_argOutput

protectedinherited

Value of the output arg if configured.

Definition at line 143 of file command.h.

◆ m_argParser

argparse::ArgumentParser CLI::COMMAND::m_argParser

protectedinherited

Definition at line 113 of file command.h.

◆ m_argVariantNames

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

protectedinherited

The list of variant names to output.

An empty vector indicates the default variant.

Definition at line 165 of file command.h.

◆ m_face

KIWAY::FACE_T CLI::DIFF_COMMAND< JOB_PCB_DIFF >::m_face

privateinherited

Definition at line 118 of file command_diff_base.h.

◆ m_hasDefineArg

bool CLI::COMMAND::m_hasDefineArg

protectedinherited

Whether or not the input arg was added for parsing.

Definition at line 133 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 128 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 118 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 123 of file command.h.

◆ m_hasVariantArg

bool CLI::COMMAND::m_hasVariantArg

protectedinherited

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

Definition at line 158 of file command.h.

◆ m_name

std::string CLI::COMMAND::m_name

protectedinherited

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

Definition at line 111 of file command.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ IO_TYPE

Constructor & Destructor Documentation

◆ PCB_DIFF_COMMAND()

Member Function Documentation

◆ addCommonArgs()

◆ addDefineArg()

◆ addDrawingSheetArg()

◆ addVariantsArg()

◆ doPerform()

◆ GetArgParser()

◆ GetName()

◆ Perform()

◆ PrintHelp()

Member Data Documentation

◆ m_argA

◆ m_argB

◆ m_argDefineVars

◆ m_argDrawingSheet

◆ m_argInput

◆ m_argOutput

◆ m_argParser

◆ m_argVariantNames

◆ m_face

◆ m_hasDefineArg

◆ m_hasDrawingSheetArg

◆ m_hasInputArg

◆ m_hasOutputArg

◆ m_hasVariantArg

◆ m_name