KiCad PCB EDA Suite
FOOTPRINT_WIZARD Class Referenceabstract

Class FOOTPRINT_WIZARD This is the parent class from where any footprint wizard class must derive. More...

#include <class_footprint_wizard.h>

Inheritance diagram for FOOTPRINT_WIZARD:
PYTHON_FOOTPRINT_WIZARD

Public Member Functions

 FOOTPRINT_WIZARD ()
 
virtual ~FOOTPRINT_WIZARD ()
 
virtual wxString GetName ()=0
 Function GetName. More...
 
virtual wxString GetImage ()=0
 Function GetImage. More...
 
virtual wxString GetDescription ()=0
 Function GetDescription. More...
 
virtual int GetNumParameterPages ()=0
 Function GetNumParameterPages. More...
 
virtual wxString GetParameterPageName (int aPage)=0
 Function GetParameterPageName. More...
 
virtual wxArrayString GetParameterNames (int aPage)=0
 Function GetParameterNames. More...
 
virtual wxArrayString GetParameterTypes (int aPage)=0
 Function GetParameterTypes. More...
 
virtual wxArrayString GetParameterValues (int aPage)=0
 Function GetParameterValues. More...
 
virtual wxArrayString GetParameterErrors (int aPage)=0
 Function GetParameterErrors. More...
 
virtual wxArrayString GetParameterHints (int aPage)=0
 Function GetParameterHints. More...
 
virtual wxArrayString GetParameterDesignators (int aPage)=0
 Function GetParamaterDesignators. More...
 
virtual wxString SetParameterValues (int aPage, wxArrayString &aValues)=0
 Function SetParameterValues. More...
 
virtual void ResetParameters ()=0
 Function ResetParameters Reset all wizard parameters to default values. More...
 
virtual MODULEGetFootprint (wxString *aMessage)=0
 Function GetModule This method builds the module itself and returns it to the caller function. More...
 
virtual void * GetObject ()=0
 Function GetObject This method gets the pointer to the object from where this wizard constructs. More...
 
void register_wizard ()
 Function register_wizard It's the standard method of a "FOOTPRINT_WIZARD" to register itself into the FOOTPRINT_WIZARDS singleton manager. More...
 

Detailed Description

Class FOOTPRINT_WIZARD This is the parent class from where any footprint wizard class must derive.

Definition at line 51 of file class_footprint_wizard.h.

Constructor & Destructor Documentation

FOOTPRINT_WIZARD::FOOTPRINT_WIZARD ( )
inline

Definition at line 54 of file class_footprint_wizard.h.

54 {}
FOOTPRINT_WIZARD::~FOOTPRINT_WIZARD ( )
virtual

Definition at line 34 of file class_footprint_wizard.cpp.

35 {
36 }

Member Function Documentation

virtual wxString FOOTPRINT_WIZARD::GetDescription ( )
pure virtual

Function GetDescription.

Returns
a description of the footprint wizard

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by DIALOG_FOOTPRINT_WIZARD_LIST::initLists(), and FOOTPRINT_WIZARD_FRAME::SelectFootprintWizard().

virtual MODULE* FOOTPRINT_WIZARD::GetFootprint ( wxString *  aMessage)
pure virtual

Function GetModule This method builds the module itself and returns it to the caller function.

Returns
PCB module built from the parameters given to the class
Parameters
aMessagea wxString to store messages (if any) generated by the footprint generator

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARD_FRAME::GetBuiltFootprint(), and FOOTPRINT_WIZARD_FRAME::ReloadFootprint().

virtual wxString FOOTPRINT_WIZARD::GetImage ( )
pure virtual

Function GetImage.

Returns
an svg image of the wizard to be rendered

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by DIALOG_FOOTPRINT_WIZARD_LIST::initLists().

virtual wxString FOOTPRINT_WIZARD::GetName ( )
pure virtual
virtual int FOOTPRINT_WIZARD::GetNumParameterPages ( )
pure virtual

Function GetNumParameterPages.

Returns
the number of parameter pages that this wizard will show to the user

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARD_FRAME::ReCreatePageList().

virtual void* FOOTPRINT_WIZARD::GetObject ( )
pure virtual

Function GetObject This method gets the pointer to the object from where this wizard constructs.

Returns
it's a void pointer, as it could be a PyObject or any other

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARDS::deregister_object().

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterDesignators ( int  aPage)
pure virtual

Function GetParamaterDesignators.

Parameters
aPageis the page we want to know the designators of
Returns
an array of designators (blank strings for no designators

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARD_FRAME::ReCreateParameterList().

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterErrors ( int  aPage)
pure virtual

Function GetParameterErrors.

Parameters
aPageis the page we want to know the errors of
Returns
an array of errors (if any) for the parameters, empty strings for OK parameters

Implemented in PYTHON_FOOTPRINT_WIZARD.

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterHints ( int  aPage)
pure virtual

Function GetParameterHints.

Parameters
aPageis the page we want to know the hints of
Returns
an array of hints (if any) for the parameters, empty string for no hints

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARD_FRAME::ReCreateParameterList().

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterNames ( int  aPage)
pure virtual

Function GetParameterNames.

Parameters
aPageis the page we want the parameter names of
Returns
an array string with the parameter names on a certain page

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARD_FRAME::ReCreateParameterList().

virtual wxString FOOTPRINT_WIZARD::GetParameterPageName ( int  aPage)
pure virtual

Function GetParameterPageName.

Parameters
aPageis the page we want the name of
Returns
a string with the page name

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARD_FRAME::ReCreatePageList().

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterTypes ( int  aPage)
pure virtual

Function GetParameterTypes.

Parameters
aPageis the page we want the parameter types of
Returns
an array string with the parameter types on a certain page "IU" for internal units, "UNITS" for units (0,1,2,3...,N)

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARD_FRAME::ParametersUpdated(), and FOOTPRINT_WIZARD_FRAME::ReCreateParameterList().

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterValues ( int  aPage)
pure virtual

Function GetParameterValues.

Parameters
aPageis the page we want the parameter values of
Returns
an array of parameter values

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARD_FRAME::ParametersUpdated(), and FOOTPRINT_WIZARD_FRAME::ReCreateParameterList().

void FOOTPRINT_WIZARD::register_wizard ( )

Function register_wizard It's the standard method of a "FOOTPRINT_WIZARD" to register itself into the FOOTPRINT_WIZARDS singleton manager.

Definition at line 39 of file class_footprint_wizard.cpp.

References FOOTPRINT_WIZARDS::register_wizard().

Referenced by PYTHON_FOOTPRINT_WIZARDS::register_wizard().

40 {
42 }
static void register_wizard(FOOTPRINT_WIZARD *aWizard)
Function register_wizard A footprint wizard calls this static method when it wants to register itself...
virtual void FOOTPRINT_WIZARD::ResetParameters ( )
pure virtual

Function ResetParameters Reset all wizard parameters to default values.

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARD_FRAME::DefaultParameters().

virtual wxString FOOTPRINT_WIZARD::SetParameterValues ( int  aPage,
wxArrayString &  aValues 
)
pure virtual

Function SetParameterValues.

Parameters
aPageis the page we want to set the parameters in
aValuesare the values we want to set into the parameters
Returns
an array of parameter values

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARD_FRAME::ParametersUpdated().


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