KiCad PCB EDA Suite: PANEL_SETUP_TUNING_PROFILES Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

#include <panel_setup_tuning_profiles.h>

Inheritance diagram for PANEL_SETUP_TUNING_PROFILES:

Public Member Functions
	PANEL_SETUP_TUNING_PROFILES (wxWindow aParentWindow, PCB_EDIT_FRAME aFrame, BOARD *aBoard, std::shared_ptr< TUNING_PROFILES > aTimeDomainParameters)

	~PANEL_SETUP_TUNING_PROFILES () override

void	SyncCopperLayers (int aNumCopperLayers)
	Called when switching to this tab to make sure that any changes to the copper layer count made on the physical stackup page are reflected here.

bool	TransferDataToWindow () override
	Load parameter data from the settings object.

bool	TransferDataFromWindow () override
	Save parameter data to the settings object.

std::vector< wxString >	GetDelayProfileNames () const
	Returns all configured tuning profile names. Used by the netclass setup panel.

void	ImportSettingsFrom (const std::shared_ptr< TUNING_PROFILES > &aOtherParameters)
	Load configuration from the given settings object.

void	OnAddTuningProfileClick (wxCommandEvent &event) override
	Adds a new tuning profile entry to the tuning profile grid.

void	OnRemoveTuningProfileClick (wxCommandEvent &event) override
	Removes a tuning profile entry from the tuning profile grid.

bool	Validate () override
	Validates all data.

void	UpdateProfileName (PANEL_SETUP_TUNING_PROFILE_INFO *panel, wxString newName) const
	Update the notebook display of the name for a given panel.

Protected Attributes
wxNotebook *	m_tuningProfiles

STD_BITMAP_BUTTON *	m_addTuningProfileButton

STD_BITMAP_BUTTON *	m_removeTuningProfileButton

Private Attributes
std::shared_ptr< TUNING_PROFILES >	m_tuningProfileParameters
	The parameters object to load / save data from / to.

DIALOG_SHIM *	m_dlg
	The parent dialog.

PCB_EDIT_FRAME *	m_frame
	The active edit frame.

BOARD *	m_board
	The current board.

std::unique_ptr< UNITS_PROVIDER >	m_unitsProvider

std::map< PCB_LAYER_ID, int >	m_copperLayerIdsToIndex

std::map< int, PCB_LAYER_ID >	m_copperIndexToLayerId

std::vector< wxString >	m_layerNames

std::map< wxString, PCB_LAYER_ID >	m_layerNamesToIDs

std::map< wxString, PCB_LAYER_ID >	m_prevLayerNamesToIDs

Friends
class	PANEL_SETUP_TUNING_PROFILE_INFO

Detailed Description

Definition at line 36 of file panel_setup_tuning_profiles.h.

Constructor & Destructor Documentation

◆ PANEL_SETUP_TUNING_PROFILES()

PANEL_SETUP_TUNING_PROFILES::PANEL_SETUP_TUNING_PROFILES	(	wxWindow *	aParentWindow,
		PCB_EDIT_FRAME *	aFrame,
		BOARD *	aBoard,
		std::shared_ptr< TUNING_PROFILES >	aTimeDomainParameters )

Definition at line 37 of file panel_setup_tuning_profiles.cpp.

References GetBoard(), GetUserUnits(), KiBitmapBundle(), PANEL_SETUP_TUNING_PROFILES_BASE::m_addTuningProfileButton, m_board, m_dlg, m_frame, PANEL_SETUP_TUNING_PROFILES_BASE::m_removeTuningProfileButton, m_tuningProfileParameters, m_unitsProvider, move, PANEL_SETUP_TUNING_PROFILES_BASE::PANEL_SETUP_TUNING_PROFILES_BASE(), pcbIUScale, small_plus, and small_trash.

◆ ~PANEL_SETUP_TUNING_PROFILES()

PANEL_SETUP_TUNING_PROFILES::~PANEL_SETUP_TUNING_PROFILES ( )

override

Definition at line 56 of file panel_setup_tuning_profiles.cpp.

Member Function Documentation

◆ GetDelayProfileNames()

std::vector< wxString > PANEL_SETUP_TUNING_PROFILES::GetDelayProfileNames ( ) const

Returns all configured tuning profile names. Used by the netclass setup panel.

Definition at line 184 of file panel_setup_tuning_profiles.cpp.

References PANEL_SETUP_TUNING_PROFILES_BASE::m_tuningProfiles, name, and PANEL_SETUP_TUNING_PROFILE_INFO.

◆ ImportSettingsFrom()

void PANEL_SETUP_TUNING_PROFILES::ImportSettingsFrom ( const std::shared_ptr< TUNING_PROFILES > & aOtherParameters )

Load configuration from the given settings object.

Definition at line 173 of file panel_setup_tuning_profiles.cpp.

References m_tuningProfileParameters, and TransferDataToWindow().

◆ OnAddTuningProfileClick()

void PANEL_SETUP_TUNING_PROFILES::OnAddTuningProfileClick ( wxCommandEvent & event )

overridevirtual

Adds a new tuning profile entry to the tuning profile grid.

Reimplemented from PANEL_SETUP_TUNING_PROFILES_BASE.

Definition at line 130 of file panel_setup_tuning_profiles.cpp.

References PANEL_SETUP_TUNING_PROFILES_BASE::m_tuningProfiles, and PANEL_SETUP_TUNING_PROFILE_INFO.

◆ OnRemoveTuningProfileClick()

void PANEL_SETUP_TUNING_PROFILES::OnRemoveTuningProfileClick ( wxCommandEvent & event )

overridevirtual

Removes a tuning profile entry from the tuning profile grid.

Reimplemented from PANEL_SETUP_TUNING_PROFILES_BASE.

Definition at line 137 of file panel_setup_tuning_profiles.cpp.

References PANEL_SETUP_TUNING_PROFILES_BASE::m_tuningProfiles.

◆ SyncCopperLayers()

void PANEL_SETUP_TUNING_PROFILES::SyncCopperLayers ( int aNumCopperLayers )

Called when switching to this tab to make sure that any changes to the copper layer count made on the physical stackup page are reflected here.

Parameters

aNumCopperLayers is the number of copper layers in the board

Definition at line 98 of file panel_setup_tuning_profiles.cpp.

References LSET::AllCuMask(), m_board, m_copperIndexToLayerId, m_copperLayerIdsToIndex, m_layerNames, m_layerNamesToIDs, m_prevLayerNamesToIDs, PANEL_SETUP_TUNING_PROFILES_BASE::m_tuningProfiles, PANEL_SETUP_TUNING_PROFILE_INFO, and PANEL_SETUP_TUNING_PROFILE_INFO::UpdateLayerNames().

Referenced by TransferDataToWindow().

◆ TransferDataFromWindow()

bool PANEL_SETUP_TUNING_PROFILES::TransferDataFromWindow ( )

override

Save parameter data to the settings object.

Definition at line 79 of file panel_setup_tuning_profiles.cpp.

References PANEL_SETUP_TUNING_PROFILE_INFO::GetProfile(), m_tuningProfileParameters, PANEL_SETUP_TUNING_PROFILES_BASE::m_tuningProfiles, PANEL_SETUP_TUNING_PROFILE_INFO, and Validate().

◆ TransferDataToWindow()

bool PANEL_SETUP_TUNING_PROFILES::TransferDataToWindow ( )

override

Load parameter data from the settings object.

Definition at line 61 of file panel_setup_tuning_profiles.cpp.

References PANEL_SETUP_TUNING_PROFILE_INFO::LoadProfile(), m_board, m_tuningProfileParameters, PANEL_SETUP_TUNING_PROFILES_BASE::m_tuningProfiles, PANEL_SETUP_TUNING_PROFILE_INFO, and SyncCopperLayers().

Referenced by ImportSettingsFrom().

◆ UpdateProfileName()

void PANEL_SETUP_TUNING_PROFILES::UpdateProfileName	(	PANEL_SETUP_TUNING_PROFILE_INFO *	panel,
		wxString	newName ) const

Update the notebook display of the name for a given panel.

Definition at line 162 of file panel_setup_tuning_profiles.cpp.

References PANEL_SETUP_TUNING_PROFILES_BASE::m_tuningProfiles, and PANEL_SETUP_TUNING_PROFILE_INFO.

◆ Validate()

bool PANEL_SETUP_TUNING_PROFILES::Validate ( )

override

Validates all data.

Definition at line 147 of file panel_setup_tuning_profiles.cpp.

References PANEL_SETUP_TUNING_PROFILES_BASE::m_tuningProfiles, PANEL_SETUP_TUNING_PROFILE_INFO, and PANEL_SETUP_TUNING_PROFILE_INFO::ValidateProfile().

Referenced by TransferDataFromWindow().

Friends And Related Symbol Documentation

◆ PANEL_SETUP_TUNING_PROFILE_INFO

friend class PANEL_SETUP_TUNING_PROFILE_INFO

friend

Definition at line 39 of file panel_setup_tuning_profiles.h.

References PANEL_SETUP_TUNING_PROFILE_INFO.

Referenced by GetDelayProfileNames(), OnAddTuningProfileClick(), PANEL_SETUP_TUNING_PROFILE_INFO, SyncCopperLayers(), TransferDataFromWindow(), TransferDataToWindow(), UpdateProfileName(), and Validate().

Member Data Documentation

◆ m_addTuningProfileButton

STD_BITMAP_BUTTON* PANEL_SETUP_TUNING_PROFILES_BASE::m_addTuningProfileButton

protectedinherited

Definition at line 40 of file panel_setup_tuning_profiles_base.h.

Referenced by PANEL_SETUP_TUNING_PROFILES::PANEL_SETUP_TUNING_PROFILES(), and PANEL_SETUP_TUNING_PROFILES_BASE().

◆ m_board

BOARD* PANEL_SETUP_TUNING_PROFILES::m_board

private

The current board.

Definition at line 87 of file panel_setup_tuning_profiles.h.

Referenced by PANEL_SETUP_TUNING_PROFILES(), SyncCopperLayers(), and TransferDataToWindow().

◆ m_copperIndexToLayerId

std::map<int, PCB_LAYER_ID> PANEL_SETUP_TUNING_PROFILES::m_copperIndexToLayerId

private

Definition at line 93 of file panel_setup_tuning_profiles.h.

Referenced by SyncCopperLayers().

◆ m_copperLayerIdsToIndex

std::map<PCB_LAYER_ID, int> PANEL_SETUP_TUNING_PROFILES::m_copperLayerIdsToIndex

private

Definition at line 92 of file panel_setup_tuning_profiles.h.

Referenced by SyncCopperLayers().

◆ m_dlg

DIALOG_SHIM* PANEL_SETUP_TUNING_PROFILES::m_dlg

private

The parent dialog.

Definition at line 81 of file panel_setup_tuning_profiles.h.

Referenced by PANEL_SETUP_TUNING_PROFILES().

◆ m_frame

PCB_EDIT_FRAME* PANEL_SETUP_TUNING_PROFILES::m_frame

private

The active edit frame.

Definition at line 84 of file panel_setup_tuning_profiles.h.

Referenced by PANEL_SETUP_TUNING_PROFILES().

◆ m_layerNames

std::vector<wxString> PANEL_SETUP_TUNING_PROFILES::m_layerNames

private

Definition at line 94 of file panel_setup_tuning_profiles.h.

Referenced by SyncCopperLayers().

◆ m_layerNamesToIDs

std::map<wxString, PCB_LAYER_ID> PANEL_SETUP_TUNING_PROFILES::m_layerNamesToIDs

private

Definition at line 97 of file panel_setup_tuning_profiles.h.

Referenced by SyncCopperLayers().

◆ m_prevLayerNamesToIDs

std::map<wxString, PCB_LAYER_ID> PANEL_SETUP_TUNING_PROFILES::m_prevLayerNamesToIDs

private

Definition at line 98 of file panel_setup_tuning_profiles.h.

Referenced by SyncCopperLayers().

◆ m_removeTuningProfileButton

STD_BITMAP_BUTTON* PANEL_SETUP_TUNING_PROFILES_BASE::m_removeTuningProfileButton

protectedinherited

Definition at line 41 of file panel_setup_tuning_profiles_base.h.

Referenced by PANEL_SETUP_TUNING_PROFILES::PANEL_SETUP_TUNING_PROFILES(), and PANEL_SETUP_TUNING_PROFILES_BASE().

◆ m_tuningProfileParameters

std::shared_ptr<TUNING_PROFILES> PANEL_SETUP_TUNING_PROFILES::m_tuningProfileParameters

private

The parameters object to load / save data from / to.

Definition at line 78 of file panel_setup_tuning_profiles.h.

Referenced by ImportSettingsFrom(), PANEL_SETUP_TUNING_PROFILES(), TransferDataFromWindow(), and TransferDataToWindow().

◆ m_tuningProfiles

wxNotebook* PANEL_SETUP_TUNING_PROFILES_BASE::m_tuningProfiles

protectedinherited

Definition at line 39 of file panel_setup_tuning_profiles_base.h.

Referenced by PANEL_SETUP_TUNING_PROFILES::GetDelayProfileNames(), PANEL_SETUP_TUNING_PROFILES::OnAddTuningProfileClick(), PANEL_SETUP_TUNING_PROFILES::OnRemoveTuningProfileClick(), PANEL_SETUP_TUNING_PROFILES_BASE(), PANEL_SETUP_TUNING_PROFILES::SyncCopperLayers(), PANEL_SETUP_TUNING_PROFILES::TransferDataFromWindow(), PANEL_SETUP_TUNING_PROFILES::TransferDataToWindow(), PANEL_SETUP_TUNING_PROFILES::UpdateProfileName(), and PANEL_SETUP_TUNING_PROFILES::Validate().

◆ m_unitsProvider

std::unique_ptr<UNITS_PROVIDER> PANEL_SETUP_TUNING_PROFILES::m_unitsProvider

private

Definition at line 89 of file panel_setup_tuning_profiles.h.

Referenced by PANEL_SETUP_TUNING_PROFILES().

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

PANEL_SETUP_TUNING_PROFILES
Generated on Sun Oct 19 2025 00:07:25 for KiCad PCB EDA Suite by 1.13.2