FOOTPRINT_WIZARD_LIST Class Reference

#include <footprint_wizard.h>

Static Public Member Functions
static void	register_wizard (FOOTPRINT_WIZARD *aWizard)
	Function register_wizard A footprint wizard calls this static method when it wants to register itself into the system wizards 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. More...
static bool	deregister_object (void *aObject)
	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. More...
static FOOTPRINT_WIZARD *	GetWizard (const wxString &aName)
	Function GetWizard. More...
static FOOTPRINT_WIZARD *	GetWizard (int aIndex)
	Function GetWizard. More...
static int	GetWizardsCount ()
	Function GetWizardsCount. More...

Static Private Attributes
static std::vector< FOOTPRINT_WIZARD * >	m_FootprintWizards
	FOOTPRINT_WIZARD system wide static list. More...

Detailed Description

Definition at line 172 of file footprint_wizard.h.

Member Function Documentation

deregister_object()

bool FOOTPRINT_WIZARD_LIST::deregister_object ( void *  aObject )

static

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.

Parameters

aObject

is the footprint wizard object to be deregistered

Definition at line 103 of file footprint_wizard.cpp.

{
    int max = GetWizardsCount();

    for( int ii = 0; ii < max; ii++ )
    {
        FOOTPRINT_WIZARD* wizard = GetWizard( ii );

        if( wizard->GetObject() == aObject )
        {
            m_FootprintWizards.erase( m_FootprintWizards.begin() + ii );
            delete wizard;
            return true;
        }
    }

    return false;
}

References FOOTPRINT_WIZARD::GetObject(), GetWizard(), GetWizardsCount(), and m_FootprintWizards.

Referenced by PYTHON_FOOTPRINT_WIZARD_LIST::deregister_wizard().

GetWizard() [1/2]

FOOTPRINT_WIZARD * FOOTPRINT_WIZARD_LIST::GetWizard ( const wxString &  aName )

static

Function GetWizard.

Parameters

aName

is the footprint wizard name

Returns

a wizard object by it's name or NULL if it isn't available.

Definition at line 53 of file footprint_wizard.cpp.

{
    int max = GetWizardsCount();

    for( int i = 0; i<max; i++ )
    {
        FOOTPRINT_WIZARD*   wizard = GetWizard( i );

        wxString            name = wizard->GetName();

        if( name.Cmp( aName )==0 )
            return wizard;
    }

    return NULL;
}

References FOOTPRINT_WIZARD::GetName(), GetWizardsCount(), name, and NULL.

Referenced by deregister_object(), FOOTPRINT_WIZARD_FRAME::GetBuiltFootprint(), FOOTPRINT_WIZARD_FRAME::GetMyWizard(), DIALOG_FOOTPRINT_WIZARD_LIST::initLists(), DIALOG_FOOTPRINT_WIZARD_LIST::OnCellFpGeneratorClick(), and register_wizard().

GetWizard() [2/2]

FOOTPRINT_WIZARD * FOOTPRINT_WIZARD_LIST::GetWizard ( int  aIndex )

static

Function GetWizard.

Returns

a wizard object by it's number or NULL if it isn't available.

Parameters

aIndex

is the wizard index in list

Definition at line 47 of file footprint_wizard.cpp.

{
    return m_FootprintWizards[aIndex];
}

References m_FootprintWizards.

GetWizardsCount()

int FOOTPRINT_WIZARD_LIST::GetWizardsCount ( )

static

Function GetWizardsCount.

Returns

the number of wizards available into the system

Definition at line 71 of file footprint_wizard.cpp.

{
    return m_FootprintWizards.size();
}

References m_FootprintWizards.

Referenced by deregister_object(), GetWizard(), DIALOG_FOOTPRINT_WIZARD_LIST::initLists(), and register_wizard().

register_wizard()

void FOOTPRINT_WIZARD_LIST::register_wizard ( FOOTPRINT_WIZARD *  aWizard )

static

Function register_wizard A footprint wizard calls this static method when it wants to register itself into the system wizards 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.

Parameters

aWizard

is the footprint wizard to be registered

Definition at line 77 of file footprint_wizard.cpp.

{
    // Search for this entry do not register twice this wizard):
    for( int ii = 0; ii < GetWizardsCount(); ii++ )
    {
        if( aWizard == GetWizard( ii ) )    // Already registered
            return;
    }

    // Search for a wizard with the same name, and remove it if found
    for( int ii = 0; ii < GetWizardsCount(); ii++ )
    {
        FOOTPRINT_WIZARD* wizard = GetWizard( ii );

        if( wizard->GetName() == aWizard->GetName() )
        {
            m_FootprintWizards.erase( m_FootprintWizards.begin() + ii );
            delete wizard;
            break;
        }
    }

    m_FootprintWizards.push_back( aWizard );
}

References FOOTPRINT_WIZARD::GetName(), GetWizard(), GetWizardsCount(), and m_FootprintWizards.

Referenced by FOOTPRINT_WIZARD::register_wizard().

Member Data Documentation

m_FootprintWizards

std::vector< FOOTPRINT_WIZARD * > FOOTPRINT_WIZARD_LIST::m_FootprintWizards

staticprivate

FOOTPRINT_WIZARD system wide static list.

Definition at line 178 of file footprint_wizard.h.

Referenced by deregister_object(), GetWizard(), GetWizardsCount(), and register_wizard().

---

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

• footprint_wizard.h
• footprint_wizard.cpp