panel_symbol_pin_map.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef PANEL_SYMBOL_PIN_MAP_H
#define PANEL_SYMBOL_PIN_MAP_H
 
#include <map>
#include <memory>
#include <set>
#include <vector>
#include <wx/string.h>
 
#include <pin_map.h>
#include <panel_symbol_pin_map_base.h>
 
class LIB_SYMBOL;
class PIN_MAP_GRID_TRICKS;
 

class PANEL_SYMBOL_PIN_MAP : public PANEL_SYMBOL_PIN_MAP_BASE
{
public:
    PANEL_SYMBOL_PIN_MAP( wxWindow* aParent );
    ~PANEL_SYMBOL_PIN_MAP() override;

    void SetSymbol( LIB_SYMBOL* aSymbol );
 
    bool TransferDataToWindow() override;
    bool TransferDataFromWindow() override;

    void ApplyToSymbol( LIB_SYMBOL* aSymbol );

    bool CommitPendingChanges();

    static constexpr int FIXED_COLS = 3;

    void ResetColumnToIdentity( int aCol );

    void CopyColumn( int aSrcCol, int aDstCol );

    void RenameColumn( int aCol );

    wxString GetColumnMapName( int aCol ) const;

    void ValidateCell( int aRow, int aCol );
 
protected:
    void OnAddMap( wxCommandEvent& aEvent ) override;
    void OnRemoveMap( wxCommandEvent& aEvent ) override;
    void OnSizeGrid( wxSizeEvent& aEvent ) override;
 
private:
    void onCellChanged( wxGridEvent& aEvent );

    void onLabelDClick( wxGridEvent& aEvent );

    void applyColumnFootprint( int aCol, const wxString& aFootprintId );

    void rebuildGrid();

    void adjustGridColumns();

    void harvestGrid();

    void validateAllCells();

    wxString makeUniqueMapName() const;

    const std::set<wxString>& padNumbersFor( const wxString& aFootprintId );
 
    LIB_SYMBOL*                            m_symbol;
    std::vector<wxString>                  m_pinNumbers; // one per grid row, logical numbers
    PIN_MAP_SET                            m_pinMaps;
    std::vector<ASSOCIATED_FOOTPRINT>      m_associations;
    std::unique_ptr<PIN_MAP_GRID_TRICKS>   m_gridTricks;
    std::map<wxString, std::set<wxString>> m_footprintPads;
};
 
#endif // PANEL_SYMBOL_PIN_MAP_H