dialog_create_net_chain.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 DIALOG_CREATE_NET_CHAIN_H
#define DIALOG_CREATE_NET_CHAIN_H
 
#include <dialogs/dialog_create_net_chain_base.h>
 
#include <set>
#include <vector>
#include <wx/string.h>
#include <kiid.h>
#include <math/box2.h>
#include <sch_sheet_path.h>
 
class SCH_EDIT_FRAME;
class SCH_NETCHAIN;
class SCH_SCREEN;
class SCH_SYMBOL;
 
 
class DIALOG_CREATE_NET_CHAIN : public DIALOG_CREATE_NET_CHAIN_BASE
{
public:
    struct FOCUS_HINT
    {
        wxString fromRef;   
        wxString toRef;     
        wxString netName;   
    };
 
    DIALOG_CREATE_NET_CHAIN( SCH_EDIT_FRAME* aParent, const FOCUS_HINT& aHint = {} );
 
    ~DIALOG_CREATE_NET_CHAIN() override;
 
    bool TransferDataToWindow() override;
    bool TransferDataFromWindow() override;
 
protected:
    void OnChainSelected( wxGridEvent& aEvent ) override;
    void OnFilterChanged( wxCommandEvent& aEvent ) override;
    void OnRefreshClicked( wxCommandEvent& aEvent ) override;
    void OnFindPathClicked( wxCommandEvent& aEvent ) override;
 
private:
    struct POTENTIAL_ROW
    {
        SCH_NETCHAIN*      livePtr = nullptr; 
        wxString           suggestedName;
        std::set<wxString> memberNets;
        wxString           terminals; 
        bool               isManual = false;

        KIID     forceFromUuid;
        KIID     forceToUuid;
        KIID     forceFromPinUuid;
        KIID     forceToPinUuid;
        wxString forceFromRef;
        wxString forceToRef;
        wxString forceFromPinNum;
        wxString forceToPinNum;

        SCH_SHEET_PATH cachedSheet;
        bool           cachedSheetResolved = false;
    };
 
    void loadPotentials();
    void rebuildGrid();
    void updateMemberDetail( int aRow );
    void populateComponentCombos();

    BOX2I highlightChainNets( const std::set<wxString>& aNets, SCH_SCREEN* aScreen );

    void navigateAndHighlightChain( POTENTIAL_ROW& aRow );

    const SCH_SHEET_PATH& findSheetForRow( POTENTIAL_ROW& aRow );

    void applyFocusHint();
 
    int  selectedRow() const;

    void recalculateAndReload( bool aRunRecalculate );
 
    bool validateAndCreate();

    void autoSelectFirstRow();
 
    SCH_EDIT_FRAME*            m_frame;
    FOCUS_HINT                 m_hint;
    std::vector<POTENTIAL_ROW> m_rows;
    std::vector<int>           m_filteredIndices; 
    int                        m_createdCount = 0;
    bool                       m_rebuilding = false;
    SCH_SHEET_PATH             m_lastHighlightedSheet; 
};
 
#endif // DIALOG_CREATE_NET_CHAIN_H