2013-03-15 13:27:18 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2013 NBEE Embedded Systems SL, Miguel Angel Ajo <miguelangel@ajo.es>
|
2017-05-25 07:05:35 +00:00
|
|
|
* Copyright (C) 2013 KiCad Developers, see AUTHORS.txt for contributors.
|
2013-03-15 13:27:18 +00:00
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, you may find one here:
|
|
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
2012-05-09 17:37:25 +00:00
|
|
|
/**
|
2015-04-26 16:32:16 +00:00
|
|
|
* @file class_footprint_wizard.h
|
2012-05-09 17:37:25 +00:00
|
|
|
* @brief Class PCBNEW_FOOTPRINT_WIZARDS
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef CLASS_FOOTPRINT_WIZARD_H
|
2013-03-16 03:27:48 +00:00
|
|
|
#define CLASS_FOOTPRINT_WIZARD_H
|
2012-05-09 17:37:25 +00:00
|
|
|
#include <vector>
|
|
|
|
#include <wxPcbStruct.h>
|
|
|
|
|
2017-01-03 15:01:47 +00:00
|
|
|
// Allowable parameter types for PCB wizards
|
|
|
|
const wxString WIZARD_PARAM_UNITS_MM = "mm"; // Millimetres
|
|
|
|
const wxString WIZARD_PARAM_UNITS_MILS = "mils"; // Mils / thou
|
|
|
|
const wxString WIZARD_PARAM_UNITS_FLOAT = "float"; // Floating point (dimensionless)
|
|
|
|
const wxString WIZARD_PARAM_UNITS_INTEGER = "integer"; // Integer (dimensionless)
|
|
|
|
const wxString WIZARD_PARAM_UNITS_BOOL = "bool"; // Boolean option
|
|
|
|
const wxString WIZARD_PARAM_UNITS_RADIANS = "radians"; // Angle (radians)
|
|
|
|
const wxString WIZARD_PARAM_UNITS_DEGREES = "degrees"; // Angle (degrees)
|
|
|
|
const wxString WIZARD_PARAM_UNITS_PERCENT = "%"; // Percent (0% -> 100%)
|
|
|
|
const wxString WIZARD_PARAM_UNITS_STRING = "string"; // String
|
|
|
|
|
2012-07-06 19:10:55 +00:00
|
|
|
/**
|
|
|
|
* Class FOOTPRINT_WIZARD
|
2012-09-12 17:28:55 +00:00
|
|
|
* This is the parent class from where any footprint wizard class must
|
2012-05-09 17:37:25 +00:00
|
|
|
* derive */
|
|
|
|
class FOOTPRINT_WIZARD
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
FOOTPRINT_WIZARD() {}
|
2013-03-16 03:27:48 +00:00
|
|
|
virtual ~FOOTPRINT_WIZARD();
|
2012-09-12 17:28:55 +00:00
|
|
|
|
|
|
|
/**
|
2012-06-27 21:19:19 +00:00
|
|
|
* Function GetName
|
|
|
|
* @return the name of the wizard
|
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
virtual wxString GetName() = 0;
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2012-06-27 21:19:19 +00:00
|
|
|
/**
|
|
|
|
* Function GetImage
|
|
|
|
* @return an svg image of the wizard to be rendered
|
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
virtual wxString GetImage() = 0;
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2012-06-27 21:19:19 +00:00
|
|
|
/**
|
|
|
|
* Function GetDescription
|
2012-09-12 17:28:55 +00:00
|
|
|
* @return a description of the footprint wizard
|
2012-06-27 21:19:19 +00:00
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
virtual wxString GetDescription() = 0;
|
2012-09-12 17:28:55 +00:00
|
|
|
|
|
|
|
/**
|
2012-06-27 21:19:19 +00:00
|
|
|
* Function GetNumParameterPages
|
|
|
|
* @return the number of parameter pages that this wizard will show to the user
|
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
virtual int GetNumParameterPages() = 0;
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2012-06-27 21:19:19 +00:00
|
|
|
/**
|
|
|
|
* Function GetParameterPageName
|
|
|
|
* @param aPage is the page we want the name of
|
|
|
|
* @return a string with the page name
|
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
virtual wxString GetParameterPageName( int aPage ) = 0;
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2012-06-27 21:19:19 +00:00
|
|
|
/**
|
|
|
|
* Function GetParameterNames
|
|
|
|
* @param aPage is the page we want the parameter names of
|
2012-09-12 17:28:55 +00:00
|
|
|
* @return an array string with the parameter names on a certain page
|
2012-06-27 21:19:19 +00:00
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
virtual wxArrayString GetParameterNames( int aPage ) = 0;
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2012-07-22 22:23:17 +00:00
|
|
|
/**
|
|
|
|
* Function GetParameterTypes
|
|
|
|
* @param aPage is the page we want the parameter types of
|
|
|
|
* @return an array string with the parameter types on a certain page
|
|
|
|
* "IU" for internal units, "UNITS" for units (0,1,2,3...,N)
|
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
virtual wxArrayString GetParameterTypes( int aPage ) = 0;
|
2012-09-12 17:28:55 +00:00
|
|
|
|
|
|
|
|
2012-06-27 21:19:19 +00:00
|
|
|
/**
|
|
|
|
* Function GetParameterValues
|
|
|
|
* @param aPage is the page we want the parameter values of
|
|
|
|
* @return an array of parameter values
|
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
virtual wxArrayString GetParameterValues( int aPage ) = 0;
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2012-06-27 21:19:19 +00:00
|
|
|
/**
|
|
|
|
* Function GetParameterErrors
|
2012-09-12 17:28:55 +00:00
|
|
|
* @param aPage is the page we want to know the errors of
|
2012-06-27 21:19:19 +00:00
|
|
|
* @return an array of errors (if any) for the parameters, empty strings for OK parameters
|
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
virtual wxArrayString GetParameterErrors( int aPage ) = 0;
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2017-01-03 15:01:47 +00:00
|
|
|
/**
|
|
|
|
* Function GetParameterHints
|
|
|
|
* @param aPage is the page we want to know the hints of
|
|
|
|
* @return an array of hints (if any) for the parameters, empty string for no hints
|
|
|
|
*/
|
|
|
|
virtual wxArrayString GetParameterHints( int aPage ) = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function GetParamaterDesignators
|
|
|
|
* @param aPage is the page we want to know the designators of
|
|
|
|
* @return an array of designators (blank strings for no designators
|
|
|
|
*/
|
|
|
|
virtual wxArrayString GetParameterDesignators( int aPage ) = 0;
|
|
|
|
|
2012-06-27 21:19:19 +00:00
|
|
|
/**
|
|
|
|
* Function SetParameterValues
|
|
|
|
* @param aPage is the page we want to set the parameters in
|
|
|
|
* @param aValues are the values we want to set into the parameters
|
|
|
|
* @return an array of parameter values
|
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
virtual wxString SetParameterValues( int aPage, wxArrayString& aValues ) = 0;
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2017-01-03 15:01:47 +00:00
|
|
|
/**
|
|
|
|
* Function ResetParameters
|
|
|
|
* Reset all wizard parameters to default values
|
|
|
|
*/
|
|
|
|
virtual void ResetParameters() = 0;
|
|
|
|
|
2012-09-12 17:28:55 +00:00
|
|
|
/**
|
2012-06-27 21:19:19 +00:00
|
|
|
* Function GetModule
|
2012-09-12 17:28:55 +00:00
|
|
|
* This method builds the module itself and returns it to the caller function
|
2012-06-27 21:19:19 +00:00
|
|
|
* @return PCB module built from the parameters given to the class
|
2015-09-05 12:10:54 +00:00
|
|
|
* @param aMessage a wxString to store messages (if any) generated by the
|
|
|
|
* footprint generator
|
2012-06-27 21:19:19 +00:00
|
|
|
*/
|
2015-09-05 12:10:54 +00:00
|
|
|
virtual MODULE* GetFootprint( wxString* aMessage ) = 0;
|
2013-03-16 03:27:48 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function GetObject
|
|
|
|
* This method gets the pointer to the object from where this wizard constructs
|
|
|
|
* @return it's a void pointer, as it could be a PyObject or any other
|
|
|
|
*/
|
|
|
|
virtual void* GetObject() = 0;
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2012-06-27 21:19:19 +00:00
|
|
|
/**
|
|
|
|
* Function register_wizard
|
|
|
|
* It's the standard method of a "FOOTPRINT_WIZARD" to register itself into
|
|
|
|
* the FOOTPRINT_WIZARDS singleton manager
|
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
void register_wizard();
|
2012-05-09 17:37:25 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
2012-09-12 17:28:55 +00:00
|
|
|
class FOOTPRINT_WIZARDS
|
2012-05-09 17:37:25 +00:00
|
|
|
{
|
|
|
|
private:
|
2013-03-15 16:35:24 +00:00
|
|
|
/**
|
2013-03-16 03:27:48 +00:00
|
|
|
* FOOTPRINT_WIZARD system wide static list
|
|
|
|
*/
|
|
|
|
static std::vector<FOOTPRINT_WIZARD*> m_FootprintWizards;
|
2015-04-26 16:32:16 +00:00
|
|
|
|
2012-05-09 17:37:25 +00:00
|
|
|
public:
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2012-06-27 21:19:19 +00:00
|
|
|
/**
|
|
|
|
* Function register_wizard
|
|
|
|
* A footprint wizard calls this static method when it wants to register itself
|
|
|
|
* into the system wizards
|
2017-01-09 13:44:07 +00:00
|
|
|
* Note: if it is already registered, this function do nothing
|
|
|
|
* if n existing wizard with the same name exists, this existing wizard will be
|
|
|
|
* unregistered.
|
2012-06-27 21:19:19 +00:00
|
|
|
* @param aWizard is the footprint wizard to be registered
|
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
static void register_wizard( FOOTPRINT_WIZARD* aWizard );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function deregister_object
|
|
|
|
* Anyone calls this method to deregister an object which builds a wizard,
|
|
|
|
* it will lookup on the vector calling GetObject until find, then removed
|
|
|
|
* and deleted
|
|
|
|
*
|
|
|
|
* @param aObject is the footprint wizard object to be deregistered
|
|
|
|
*/
|
|
|
|
static bool deregister_object( void* aObject );
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2012-06-27 21:19:19 +00:00
|
|
|
/**
|
|
|
|
* Function GetWizard
|
2012-09-12 17:28:55 +00:00
|
|
|
* @param aName is the footprint wizard name
|
2012-06-27 21:19:19 +00:00
|
|
|
* @return a wizard object by it's name or NULL if it isn't available.
|
|
|
|
*/
|
2017-09-23 09:20:10 +00:00
|
|
|
static FOOTPRINT_WIZARD* GetWizard( const wxString& aName );
|
2012-09-12 17:28:55 +00:00
|
|
|
|
2012-06-27 21:19:19 +00:00
|
|
|
/**
|
|
|
|
* Function GetWizard
|
|
|
|
* @return a wizard object by it's number or NULL if it isn't available.
|
2012-09-12 17:28:55 +00:00
|
|
|
* @param aIndex is the wizard index in list
|
2012-06-27 21:19:19 +00:00
|
|
|
*/
|
2013-03-16 03:27:48 +00:00
|
|
|
static FOOTPRINT_WIZARD* GetWizard( int aIndex );
|
2012-09-12 17:28:55 +00:00
|
|
|
|
|
|
|
/**
|
2015-04-26 16:32:16 +00:00
|
|
|
* Function GetWizardsCount
|
2012-06-27 21:19:19 +00:00
|
|
|
* @return the number of wizards available into the system
|
|
|
|
*/
|
2015-04-26 16:32:16 +00:00
|
|
|
static int GetWizardsCount();
|
2012-05-09 17:37:25 +00:00
|
|
|
};
|
|
|
|
|
2013-03-16 03:27:48 +00:00
|
|
|
#endif /* PCBNEW_FOOTPRINT_WIZARDS_H */
|