CLI::EXPORT_PCB_POS_COMMAND Class Reference

#include <command_export_pcb_pos.h>

Inheritance diagram for CLI::EXPORT_PCB_POS_COMMAND:

Public Member Functions
	EXPORT_PCB_POS_COMMAND ()
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
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 28 of file command_export_pcb_pos.h.

Constructor & Destructor Documentation

EXPORT_PCB_POS_COMMAND()

CLI::EXPORT_PCB_POS_COMMAND::EXPORT_PCB_POS_COMMAND

(

)

Definition at line 42 of file command_export_pcb_pos.cpp.

 : EXPORT_PCB_BASE_COMMAND( "pos" )
{
 m_argParser.add_description( UTF8STDSTR( _( "Generate Position File" ) ) );
 
 m_argParser.add_argument( ARG_SIDE )
 .default_value( std::string( "both" ) )
 .help( UTF8STDSTR( _(
 "Valid options: front,back,both. Gerber format only supports \"both\"." ) ) );
 
 m_argParser.add_argument( ARG_FORMAT )
 .default_value( std::string( "ascii" ) )
 .help( UTF8STDSTR( _( "Valid options: ascii,csv,gerber" ) ) );
 
 m_argParser.add_argument( ARG_UNITS )
 .default_value( std::string( "in" ) )
 .help( UTF8STDSTR( _( "Output units; ascii or csv format only; valid options: in,mm" ) ) );
 
 m_argParser.add_argument( ARG_NEGATE_BOTTOM_X )
 .help( UTF8STDSTR( _( "Use negative X coordinates for footprints on bottom layer "
 "(ascii or csv formats only)" ) ) )
 .implicit_value( true )
 .default_value( false );
 
 m_argParser.add_argument( ARG_USE_DRILL_FILE_ORIGIN )
 .help( UTF8STDSTR( _( "Use drill/place file origin (ascii or csv only)" ) ) )
 .implicit_value( true )
 .default_value( false );
 
 m_argParser.add_argument( ARG_SMD_ONLY )
 .help( UTF8STDSTR( _( "Include only SMD footprints (ascii or csv only)" ) ) )
 .implicit_value( true )
 .default_value( false );
 
 m_argParser.add_argument( ARG_EXCLUDE_FOOTPRINTS_TH )
 .help( UTF8STDSTR(
 _( "Exclude all footprints with through-hole pads (ascii or csv only)" ) ) )
 .implicit_value( true )
 .default_value( false );
 
 m_argParser.add_argument( ARG_GERBER_BOARD_EDGE )
 .help( UTF8STDSTR( _( "Include board edge layer (gerber only)" ) ) )
 .implicit_value( true )
 .default_value( false );
}

References _, ARG_EXCLUDE_FOOTPRINTS_TH, ARG_FORMAT, ARG_GERBER_BOARD_EDGE, ARG_NEGATE_BOTTOM_X, ARG_SIDE, ARG_SMD_ONLY, ARG_UNITS, ARG_USE_DRILL_FILE_ORIGIN, CLI::COMMAND::m_argParser, and UTF8STDSTR.

Member Function Documentation

addLayerArg()

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

protectedinherited

Definition at line 102 of file command_export_pcb_base.cpp.

{
 m_argParser.add_argument( "-l", ARG_LAYERS )
 .default_value( std::string() )
 .help( UTF8STDSTR(
 _( "Comma separated list of untranslated layer names to include such as "
 "F.Cu,B.Cu" ) ) );
 
 m_hasLayerArg = true;
 m_requireLayers = aRequire;
}

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

protectedinherited

Definition at line 75 of file command_export_pcb_base.cpp.

{
 LSET layerMask;
 
 if( !aLayerString.IsEmpty() )
 {
 layerMask.reset();
 wxStringTokenizer layerTokens( aLayerString, "," );
 while( layerTokens.HasMoreTokens() )
 {
 std::string token = TO_UTF8( layerTokens.GetNextToken() );
 if( m_layerMasks.count( token ) )
 {
 layerMask |= m_layerMasks.at(token);
 aLayerArgSet = true;
 }
 else
 {
 wxFprintf( stderr, _( "Invalid layer name \"%s\"\n" ), token );
 }
 }
 }
 
 return layerMask;
}

References _, and TO_UTF8.

doPerform()

int CLI::EXPORT_PCB_POS_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::EXPORT_PCB_BASE_COMMAND.

Definition at line 88 of file command_export_pcb_pos.cpp.

{
 int baseExit = EXPORT_PCB_BASE_COMMAND::doPerform( aKiway );
 if( baseExit != EXIT_CODES::OK )
 return baseExit;
 
 std::unique_ptr<JOB_EXPORT_PCB_POS> aPosJob( new JOB_EXPORT_PCB_POS( true ) );
 
 aPosJob->m_filename = FROM_UTF8( m_argParser.get<std::string>( ARG_INPUT ).c_str() );
 aPosJob->m_outputFile = FROM_UTF8( m_argParser.get<std::string>( ARG_OUTPUT ).c_str() );
 
 if( !wxFile::Exists( aPosJob->m_filename ) )
 {
 wxFprintf( stderr, _( "Board file does not exist or is not accessible\n" ) );
 return EXIT_CODES::ERR_INVALID_INPUT_FILE;
 }
 
 aPosJob->m_negateBottomX = m_argParser.get<bool>( ARG_NEGATE_BOTTOM_X );
 aPosJob->m_smdOnly = m_argParser.get<bool>( ARG_SMD_ONLY );
 aPosJob->m_excludeFootprintsWithTh = m_argParser.get<bool>( ARG_EXCLUDE_FOOTPRINTS_TH );
 aPosJob->m_useDrillPlaceFileOrigin = m_argParser.get<bool>( ARG_USE_DRILL_FILE_ORIGIN );
 aPosJob->m_gerberBoardEdge = m_argParser.get<bool>( ARG_GERBER_BOARD_EDGE );
 
 wxString format = FROM_UTF8( m_argParser.get<std::string>( ARG_FORMAT ).c_str() );
 if( format == wxS( "ascii" ) )
 {
 aPosJob->m_format = JOB_EXPORT_PCB_POS::FORMAT::ASCII;
 }
 else if( format == wxS( "csv" ) )
 {
 aPosJob->m_format = JOB_EXPORT_PCB_POS::FORMAT::CSV;
 }
 else if( format == wxS( "gerber" ) )
 {
 aPosJob->m_format = JOB_EXPORT_PCB_POS::FORMAT::GERBER;
 }
 else
 {
 wxFprintf( stderr, _( "Invalid format\n" ) );
 return EXIT_CODES::ERR_ARGS;
 }
 
 wxString units = FROM_UTF8( m_argParser.get<std::string>( ARG_UNITS ).c_str() );
 
 if( units == wxS( "mm" ) )
 {
 aPosJob->m_units = JOB_EXPORT_PCB_POS::UNITS::MILLIMETERS;
 }
 else if( units == wxS( "in" ) )
 {
 aPosJob->m_units = JOB_EXPORT_PCB_POS::UNITS::INCHES;
 }
 else
 {
 wxFprintf( stderr, _( "Invalid units specified\n" ) );
 return EXIT_CODES::ERR_ARGS;
 }
 
 wxString side = FROM_UTF8( m_argParser.get<std::string>( ARG_SIDE ).c_str() );
 
 if( side == wxS( "both" ) )
 {
 if( aPosJob->m_format == JOB_EXPORT_PCB_POS::FORMAT::GERBER )
 {
 wxFprintf( stderr, _( "\"both\" not supported for gerber format\n" ) );
 return EXIT_CODES::ERR_ARGS;
 }
 
 aPosJob->m_side = JOB_EXPORT_PCB_POS::SIDE::BOTH;
 }
 else if( side == wxS( "front" ) )
 {
 aPosJob->m_side = JOB_EXPORT_PCB_POS::SIDE::FRONT;
 }
 else if( side == wxS( "back" ) )
 {
 aPosJob->m_side = JOB_EXPORT_PCB_POS::SIDE::BACK;
 }
 else
 {
 wxFprintf( stderr, _( "Invalid side specified\n" ) );
 return EXIT_CODES::ERR_ARGS;
 }
 
 
 LOCALE_IO dummy;
 int exitCode = aKiway.ProcessJob( KIWAY::FACE_PCB, aPosJob.get() );
 
 return exitCode;
}

References _, ARG_EXCLUDE_FOOTPRINTS_TH, ARG_FORMAT, ARG_GERBER_BOARD_EDGE, ARG_INPUT, ARG_NEGATE_BOTTOM_X, ARG_OUTPUT, ARG_SIDE, ARG_SMD_ONLY, ARG_UNITS, ARG_USE_DRILL_FILE_ORIGIN, JOB_EXPORT_PCB_POS::ASCII, JOB_EXPORT_PCB_POS::BACK, JOB_EXPORT_PCB_POS::BOTH, JOB_EXPORT_PCB_POS::CSV, CLI::EXPORT_PCB_BASE_COMMAND::doPerform(), dummy, CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, KIWAY::FACE_PCB, FROM_UTF8(), JOB_EXPORT_PCB_POS::FRONT, JOB_EXPORT_PCB_POS::GERBER, JOB_EXPORT_PCB_POS::INCHES, JOB_EXPORT_PCB_POS::MILLIMETERS, CLI::EXIT_CODES::OK, and KIWAY::ProcessJob().

GetArgParser()

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

inlineinherited

Definition at line 54 of file command.h.

{ return m_argParser; }

References CLI::COMMAND::m_argParser.

Referenced by recurseArgParserBuild(), and recurseArgParserSubCommandUsed().

GetName()

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

inlineinherited

Definition at line 55 of file command.h.

{ return m_name; }

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.

{
 if( m_argParser[ARG_HELP] == true )
 {
 PrintHelp();
 
 return 0;
 }
 
 return doPerform( aKiway );
}

References ARG_HELP.

PrintHelp()

void CLI::COMMAND::PrintHelp ( )

inherited

Definition at line 41 of file command.cpp.

{
 std::stringstream ss;
 ss << m_argParser;
 wxPrintf( FROM_UTF8( ss.str().c_str() ) );
}

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(), CLI::EXPORT_PCB_BASE_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(), 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_NETLIST_COMMAND::EXPORT_SCH_NETLIST_COMMAND(), CLI::EXPORT_SCH_PDF_COMMAND::EXPORT_SCH_PDF_COMMAND(), CLI::EXPORT_SCH_SVG_COMMAND::EXPORT_SCH_SVG_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

protectedinherited

Definition at line 54 of file command_export_pcb_base.h.

Referenced by CLI::EXPORT_PCB_BASE_COMMAND::EXPORT_PCB_BASE_COMMAND().

m_layerMasks

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

protectedinherited

Definition at line 50 of file command_export_pcb_base.h.

Referenced by CLI::EXPORT_PCB_BASE_COMMAND::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

protectedinherited

Definition at line 55 of file command_export_pcb_base.h.

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

m_selectedLayers

LSET CLI::EXPORT_PCB_BASE_COMMAND::m_selectedLayers

protectedinherited

Definition at line 51 of file command_export_pcb_base.h.

m_selectedLayersSet

bool CLI::EXPORT_PCB_BASE_COMMAND::m_selectedLayersSet

protectedinherited

Definition at line 52 of file command_export_pcb_base.h.

Referenced by CLI::EXPORT_PCB_BASE_COMMAND::EXPORT_PCB_BASE_COMMAND().

---

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

• command_export_pcb_pos.h
• command_export_pcb_pos.cpp