panel_setup_time_domain_parameters.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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
 
#ifndef PANEL_SETUP_TIME_DOMAIN_PARAMETERS_H
#define PANEL_SETUP_TIME_DOMAIN_PARAMETERS_H
 
#include <utility>
 
#include <board.h>
#include <dialogs/panel_setup_time_domain_parameters_base.h>
#include <project/time_domain_parameters.h>
 
class NET_SETTINGS;
 
 
class PANEL_SETUP_TIME_DOMAIN_PARAMETERS : public PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE
{
public:
    PANEL_SETUP_TIME_DOMAIN_PARAMETERS(
            wxWindow* aParentWindow, PCB_EDIT_FRAME* aFrame, BOARD* aBoard,
            std::shared_ptr<TIME_DOMAIN_PARAMETERS> aTimeDomainParameters );
    ~PANEL_SETUP_TIME_DOMAIN_PARAMETERS() override;
 
    void SyncCopperLayers( int aNumCopperLayers );
 
    bool TransferDataToWindow() override;
 
    bool TransferDataFromWindow() override;
 
    std::vector<wxString> GetDelayProfileNames() const;
 
    void ImportSettingsFrom( const std::shared_ptr<TIME_DOMAIN_PARAMETERS>& aOtherParameters );
 
private:
    enum PROFILE_GRID_REQUIRED_COLS
    {
        PROFILE_GRID_PROFILE_NAME = 0,
        PROFILE_GRID_VIA_PROP_DELAY,
        PROFILE_GRID_NUM_REQUIRED_COLS
    };
 
    enum VIA_GRID_REQUIRED_COLS
    {
        VIA_GRID_PROFILE_NAME = 0,
        VIA_GRID_SIGNAL_LAYER_FROM,
        VIA_GRID_SIGNAL_LAYER_TO,
        VIA_GRID_VIA_LAYER_FROM,
        VIA_GRID_VIA_LAYER_TO,
        VIA_GRID_DELAY
    };
 
    void setColumnWidths();
 
    void updateViaProfileNamesEditor( const wxString& aOldName = wxEmptyString,
                                      const wxString& aNewName = wxEmptyString ) const;
 
    void updateProfileGridColumns();
 
    void updateViaGridColumns();
 
    void OnAddDelayProfileClick( wxCommandEvent& event ) override;
 
    void OnRemoveDelayProfileClick( wxCommandEvent& event ) override;
 
    void OnAddViaOverrideClick( wxCommandEvent& event ) override;
 
    void OnRemoveViaOverrideClick( wxCommandEvent& event ) override;
 
    void OnDelayProfileGridCellChanging( wxGridEvent& event );
 
    bool validateDelayProfileName( int aRow, const wxString& aName, bool focusFirst = true );
 
    bool Validate() override;
 
    bool validateViaRows();
 
    void addProfileRow( const DELAY_PROFILE& aDelayProfile );
 
    DELAY_PROFILE getProfileRow( int aRow );
 
    void addViaRow( const wxString& aProfileName, const DELAY_PROFILE_VIA_OVERRIDE_ENTRY& aViaOverrideEntry ) const;
 
    DELAY_PROFILE_VIA_OVERRIDE_ENTRY getViaRow( int aRow );
 
    wxString getProfileNameForProfileGridRow( int aRow ) const;
 
    std::shared_ptr<TIME_DOMAIN_PARAMETERS> m_timeDomainParameters;
 
    PCB_EDIT_FRAME* m_frame;
 
    BOARD* m_board;
 
    std::unique_ptr<UNITS_PROVIDER> m_unitsProvider;
 
    // Layer / column lookups
    std::map<PCB_LAYER_ID, int> m_copperLayerIdsToColumns;
    std::map<int, PCB_LAYER_ID> m_copperColumnsToLayerId;
    std::vector<wxString>       m_layerNames;
 
    // We cache these in case the names change on the layers panel
    std::map<wxString, PCB_LAYER_ID> m_layerNamesToIDs;
    std::map<wxString, PCB_LAYER_ID> m_prevLayerNamesToIDs;
};
 
#endif // PANEL_SETUP_TIME_DOMAIN_PARAMETERS_H