The parent class from where any footprint wizard class must derive. More...

#include <footprint_wizard.h>

Inheritance diagram for FOOTPRINT_WIZARD:

Public Member Functions
	FOOTPRINT_WIZARD ()

virtual	~FOOTPRINT_WIZARD ()

virtual wxString	GetName ()=0

virtual wxString	GetImage ()=0

virtual wxString	GetDescription ()=0

virtual int	GetNumParameterPages ()=0

virtual wxString	GetParameterPageName (int aPage)=0

virtual wxArrayString	GetParameterNames (int aPage)=0

virtual wxArrayString	GetParameterTypes (int aPage)=0

virtual wxArrayString	GetParameterValues (int aPage)=0

virtual wxArrayString	GetParameterErrors (int aPage)=0

virtual wxArrayString	GetParameterHints (int aPage)=0

virtual wxArrayString	GetParameterDesignators (int aPage)=0

virtual wxString	SetParameterValues (int aPage, wxArrayString &aValues)=0

virtual void	ResetParameters ()=0
	Reset all wizard parameters to default values.

virtual FOOTPRINT *	GetFootprint (wxString *aMessage)=0
	Build the footprint itself and returns it to the caller function.

virtual void *	GetObject ()=0
	Get the object from where this wizard constructs.

void	register_wizard ()
	The standard method of a "FOOTPRINT_WIZARD" to register itself into the FOOTPRINT_WIZARD_LIST singleton manager.

Detailed Description

The parent class from where any footprint wizard class must derive.

Definition at line 51 of file footprint_wizard.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_WIZARD()

FOOTPRINT_WIZARD::FOOTPRINT_WIZARD ( )

inline

Definition at line 54 of file footprint_wizard.h.

◆ ~FOOTPRINT_WIZARD()

FOOTPRINT_WIZARD::~FOOTPRINT_WIZARD ( )

virtual

Definition at line 34 of file footprint_wizard.cpp.

Member Function Documentation

◆ GetDescription()

virtual wxString FOOTPRINT_WIZARD::GetDescription ( )

pure virtual

Returns: a description of the footprint wizard.

Implemented in PYTHON_FOOTPRINT_WIZARD.

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

◆ GetFootprint()

virtual FOOTPRINT * FOOTPRINT_WIZARD::GetFootprint ( wxString * aMessage )

pure virtual

Build the footprint itself and returns it to the caller function.

Parameters

aMessage is storage for messages (if any) generated by the footprint generator.

Returns: a footprint built from the parameters given to the class.

Implemented in PYTHON_FOOTPRINT_WIZARD.

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

◆ GetImage()

virtual wxString FOOTPRINT_WIZARD::GetImage ( )

pure virtual

Returns: an svg image of the wizard to be rendered.

Implemented in PYTHON_FOOTPRINT_WIZARD.

◆ GetName()

virtual wxString FOOTPRINT_WIZARD::GetName ( )

pure virtual

Returns: the name of the wizard.

Implemented in PYTHON_FOOTPRINT_WIZARD.

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

◆ GetNumParameterPages()

virtual int FOOTPRINT_WIZARD::GetNumParameterPages ( )

pure virtual

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().

◆ GetObject()

virtual void * FOOTPRINT_WIZARD::GetObject ( )

pure virtual

Get 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_WIZARD_LIST::deregister_object().

◆ GetParameterDesignators()

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterDesignators ( int aPage )

pure virtual

Parameters

aPage is 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().

◆ GetParameterErrors()

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterErrors ( int aPage )

pure virtual

Parameters

aPage is 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.

◆ GetParameterHints()

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterHints ( int aPage )

pure virtual

Parameters

aPage is 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().

◆ GetParameterNames()

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterNames ( int aPage )

pure virtual

Parameters

aPage is 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().

◆ GetParameterPageName()

virtual wxString FOOTPRINT_WIZARD::GetParameterPageName ( int aPage )

pure virtual

Parameters

aPage is 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().

◆ GetParameterTypes()

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterTypes ( int aPage )

pure virtual

Parameters

aPage is 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::ReCreateParameterList().

◆ GetParameterValues()

virtual wxArrayString FOOTPRINT_WIZARD::GetParameterValues ( int aPage )

pure virtual

Parameters

aPage is 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().

◆ register_wizard()

void FOOTPRINT_WIZARD::register_wizard ( )

The standard method of a "FOOTPRINT_WIZARD" to register itself into the FOOTPRINT_WIZARD_LIST singleton manager.

Definition at line 39 of file footprint_wizard.cpp.

References FOOTPRINT_WIZARD_LIST::register_wizard().

Referenced by PYTHON_FOOTPRINT_WIZARD_LIST::register_wizard().

◆ ResetParameters()

virtual void FOOTPRINT_WIZARD::ResetParameters ( )

pure virtual

Reset all wizard parameters to default values.

Implemented in PYTHON_FOOTPRINT_WIZARD.

Referenced by FOOTPRINT_WIZARD_FRAME::DefaultParameters(), and FOOTPRINT_WIZARD_FRAME::SelectFootprintWizard().

◆ SetParameterValues()

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

pure virtual

Parameters

aPage	is the page we want to set the parameters in.
aValues	are 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:

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FOOTPRINT_WIZARD()

◆ ~FOOTPRINT_WIZARD()

Member Function Documentation

◆ GetDescription()

◆ GetFootprint()

◆ GetImage()

◆ GetName()

◆ GetNumParameterPages()

◆ GetObject()

◆ GetParameterDesignators()

◆ GetParameterErrors()

◆ GetParameterHints()

◆ GetParameterNames()

◆ GetParameterPageName()

◆ GetParameterTypes()

◆ GetParameterValues()

◆ register_wizard()

◆ ResetParameters()

◆ SetParameterValues()