#include <panel_setup_time_domain_parameters.h>

Inheritance diagram for PANEL_SETUP_TIME_DOMAIN_PARAMETERS:

Public Member Functions
	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)
	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< TIME_DOMAIN_PARAMETERS > &aOtherParameters)
	Load configuration from the given settings object.

Protected Member Functions
virtual void	OnUpdateUI (wxUpdateUIEvent &event)

virtual void	OnSizeTraceParametersGrid (wxSizeEvent &event)

Protected Attributes
wxSplitterWindow *	m_splitter

WX_PANEL *	m_timeDomainParametersPane

wxStaticText *	m_staticText3

WX_GRID *	m_tracePropagationGrid

STD_BITMAP_BUTTON *	m_addDelayProfileButton

STD_BITMAP_BUTTON *	m_removeDelayProfileButton

WX_PANEL *	m_timeDomainParametersPane1

wxStaticText *	m_staticText31

WX_GRID *	m_viaPropagationGrid

STD_BITMAP_BUTTON *	m_addViaOverrideButton

STD_BITMAP_BUTTON *	m_removeViaOverrideButton

Private Types
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 }

Private Member Functions
void	setColumnWidths ()
	Optimise grid columns to fit titles and content.

void	updateViaProfileNamesEditor (const wxString &aOldName=wxEmptyString, const wxString &aNewName=wxEmptyString) const
	Updates the via override tuning profile name dropdown lists Updates entries if aOldName and aNewName are passed.

void	updateProfileGridColumns ()
	Update the dynamic (per-layer) columns in the tuning profiles grid.

void	updateViaGridColumns ()
	Update the dynamic (per-layer) columns in the via overrides grid.

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

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

void	OnAddViaOverrideClick (wxCommandEvent &event) override
	Adds a new via override profile entry to the via overrides grid.

void	OnRemoveViaOverrideClick (wxCommandEvent &event) override
	Removes a via override profile entry from the via overrides grid.

void	OnDelayProfileGridCellChanging (wxGridEvent &event)
	Validates a tuning profile row data.

bool	validateDelayProfileName (int aRow, const wxString &aName, bool focusFirst=true)
	Validates a tuning profile name (checks for not empty and not duplicated)

bool	Validate () override
	Validates all data.

bool	validateViaRows ()
	Validates all via override rows.

void	addProfileRow (const DELAY_PROFILE &aDelayProfile)
	Adds a tuning profile row with the given persisted parameters.

DELAY_PROFILE	getProfileRow (int aRow)
	Gets a tuning profile row as a set of persistable parameters.

void	addViaRow (const wxString &aProfileName, const DELAY_PROFILE_VIA_OVERRIDE_ENTRY &aViaOverrideEntry) const
	Adds a via override row with the given persisted parameters.

DELAY_PROFILE_VIA_OVERRIDE_ENTRY	getViaRow (int aRow)
	Gets a via override row as a set of persistable parameters.

wxString	getProfileNameForProfileGridRow (int aRow) const
	Gets the profile name for the given profile grid row.

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

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_copperLayerIdsToColumns

std::map< int, PCB_LAYER_ID >	m_copperColumnsToLayerId

std::vector< wxString >	m_layerNames

std::map< wxString, PCB_LAYER_ID >	m_layerNamesToIDs

std::map< wxString, PCB_LAYER_ID >	m_prevLayerNamesToIDs

Detailed Description

Definition at line 37 of file panel_setup_time_domain_parameters.h.

Member Enumeration Documentation

◆ PROFILE_GRID_REQUIRED_COLS

enum PANEL_SETUP_TIME_DOMAIN_PARAMETERS::PROFILE_GRID_REQUIRED_COLS

private

Enumerator
PROFILE_GRID_PROFILE_NAME
PROFILE_GRID_VIA_PROP_DELAY
PROFILE_GRID_NUM_REQUIRED_COLS

Definition at line 65 of file panel_setup_time_domain_parameters.h.

◆ VIA_GRID_REQUIRED_COLS

enum PANEL_SETUP_TIME_DOMAIN_PARAMETERS::VIA_GRID_REQUIRED_COLS

private

Enumerator
VIA_GRID_PROFILE_NAME
VIA_GRID_SIGNAL_LAYER_FROM
VIA_GRID_SIGNAL_LAYER_TO
VIA_GRID_VIA_LAYER_FROM
VIA_GRID_VIA_LAYER_TO
VIA_GRID_DELAY

Definition at line 72 of file panel_setup_time_domain_parameters.h.

Constructor & Destructor Documentation

◆ PANEL_SETUP_TIME_DOMAIN_PARAMETERS()

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

Definition at line 37 of file panel_setup_time_domain_parameters.cpp.

◆ ~PANEL_SETUP_TIME_DOMAIN_PARAMETERS()

PANEL_SETUP_TIME_DOMAIN_PARAMETERS::~PANEL_SETUP_TIME_DOMAIN_PARAMETERS ( )

override

Definition at line 97 of file panel_setup_time_domain_parameters.cpp.

References PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid, and OnDelayProfileGridCellChanging().

Member Function Documentation

◆ addProfileRow()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::addProfileRow ( const DELAY_PROFILE & aDelayProfile )

private

Adds a tuning profile row with the given persisted parameters.

Definition at line 157 of file panel_setup_time_domain_parameters.cpp.

References m_copperLayerIdsToColumns, DELAY_PROFILE::m_LayerPropagationDelays, DELAY_PROFILE::m_ProfileName, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid, DELAY_PROFILE::m_ViaPropagationDelay, PROFILE_GRID_PROFILE_NAME, PROFILE_GRID_VIA_PROP_DELAY, and WX_GRID::SetUnitValue().

Referenced by TransferDataToWindow().

◆ addViaRow()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::addViaRow	(	const wxString &	aProfileName,
		const DELAY_PROFILE_VIA_OVERRIDE_ENTRY &	aViaOverrideEntry
	)		const

private

Adds a via override row with the given persisted parameters.

Definition at line 195 of file panel_setup_time_domain_parameters.cpp.

References BOARD::GetLayerName(), m_board, DELAY_PROFILE_VIA_OVERRIDE_ENTRY::m_Delay, DELAY_PROFILE_VIA_OVERRIDE_ENTRY::m_SignalLayerFrom, DELAY_PROFILE_VIA_OVERRIDE_ENTRY::m_SignalLayerTo, DELAY_PROFILE_VIA_OVERRIDE_ENTRY::m_ViaLayerFrom, DELAY_PROFILE_VIA_OVERRIDE_ENTRY::m_ViaLayerTo, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid, WX_GRID::SetUnitValue(), VIA_GRID_DELAY, VIA_GRID_PROFILE_NAME, VIA_GRID_SIGNAL_LAYER_FROM, VIA_GRID_SIGNAL_LAYER_TO, VIA_GRID_VIA_LAYER_FROM, and VIA_GRID_VIA_LAYER_TO.

Referenced by TransferDataToWindow().

◆ GetDelayProfileNames()

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

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

Definition at line 635 of file panel_setup_time_domain_parameters.cpp.

References getProfileNameForProfileGridRow(), and PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid.

Referenced by DIALOG_BOARD_SETUP::onPageChanged().

◆ getProfileNameForProfileGridRow()

wxString PANEL_SETUP_TIME_DOMAIN_PARAMETERS::getProfileNameForProfileGridRow ( int aRow ) const

private

Gets the profile name for the given profile grid row.

Definition at line 671 of file panel_setup_time_domain_parameters.cpp.

References PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid, and PROFILE_GRID_PROFILE_NAME.

Referenced by GetDelayProfileNames(), getProfileRow(), OnAddViaOverrideClick(), OnDelayProfileGridCellChanging(), OnRemoveDelayProfileClick(), updateViaProfileNamesEditor(), Validate(), and validateDelayProfileName().

◆ getProfileRow()

DELAY_PROFILE PANEL_SETUP_TIME_DOMAIN_PARAMETERS::getProfileRow ( int aRow )

private

Gets a tuning profile row as a set of persistable parameters.

Definition at line 178 of file panel_setup_time_domain_parameters.cpp.

References getProfileNameForProfileGridRow(), WX_GRID::GetUnitValue(), m_copperLayerIdsToColumns, DELAY_PROFILE::m_LayerPropagationDelays, DELAY_PROFILE::m_ProfileName, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid, DELAY_PROFILE::m_ViaPropagationDelay, and PROFILE_GRID_VIA_PROP_DELAY.

Referenced by TransferDataFromWindow().

◆ getViaRow()

DELAY_PROFILE_VIA_OVERRIDE_ENTRY PANEL_SETUP_TIME_DOMAIN_PARAMETERS::getViaRow ( int aRow )

private

Gets a via override row as a set of persistable parameters.

Definition at line 213 of file panel_setup_time_domain_parameters.cpp.

References WX_GRID::GetUnitValue(), IsCopperLayerLowerThan(), m_layerNamesToIDs, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid, VIA_GRID_DELAY, VIA_GRID_SIGNAL_LAYER_FROM, VIA_GRID_SIGNAL_LAYER_TO, VIA_GRID_VIA_LAYER_FROM, and VIA_GRID_VIA_LAYER_TO.

Referenced by TransferDataFromWindow(), and validateViaRows().

◆ ImportSettingsFrom()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::ImportSettingsFrom ( const std::shared_ptr< TIME_DOMAIN_PARAMETERS > & aOtherParameters )

Load configuration from the given settings object.

Definition at line 655 of file panel_setup_time_domain_parameters.cpp.

References m_timeDomainParameters, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid, TransferDataToWindow(), and updateViaProfileNamesEditor().

◆ OnAddDelayProfileClick()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::OnAddDelayProfileClick ( wxCommandEvent & event )

overrideprivatevirtual

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

Reimplemented from PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE.

Definition at line 404 of file panel_setup_time_domain_parameters.cpp.

References WX_GRID::CommitPendingChanges(), PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid, PROFILE_GRID_PROFILE_NAME, PROFILE_GRID_VIA_PROP_DELAY, and WX_GRID::SetUnitValue().

◆ OnAddViaOverrideClick()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::OnAddViaOverrideClick ( wxCommandEvent & event )

overrideprivatevirtual

Adds a new via override profile entry to the via overrides grid.

Reimplemented from PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE.

Definition at line 455 of file panel_setup_time_domain_parameters.cpp.

References _, WX_GRID::CommitPendingChanges(), PAGED_DIALOG::GetDialog(), getProfileNameForProfileGridRow(), m_layerNames, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid, PAGED_DIALOG::SetError(), WX_GRID::SetUnitValue(), VIA_GRID_DELAY, VIA_GRID_PROFILE_NAME, VIA_GRID_SIGNAL_LAYER_FROM, VIA_GRID_SIGNAL_LAYER_TO, VIA_GRID_VIA_LAYER_FROM, and VIA_GRID_VIA_LAYER_TO.

◆ OnDelayProfileGridCellChanging()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::OnDelayProfileGridCellChanging ( wxGridEvent & event )

private

Validates a tuning profile row data.

Definition at line 496 of file panel_setup_time_domain_parameters.cpp.

References getProfileNameForProfileGridRow(), PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid, PROFILE_GRID_PROFILE_NAME, updateViaProfileNamesEditor(), validateDelayProfileName(), and VIA_GRID_PROFILE_NAME.

Referenced by PANEL_SETUP_TIME_DOMAIN_PARAMETERS(), and ~PANEL_SETUP_TIME_DOMAIN_PARAMETERS().

◆ OnRemoveDelayProfileClick()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::OnRemoveDelayProfileClick ( wxCommandEvent & event )

overrideprivatevirtual

Removes a tuning profile entry from the tuning profile grid.

Reimplemented from PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE.

Definition at line 424 of file panel_setup_time_domain_parameters.cpp.

References WX_GRID::CommitPendingChanges(), getProfileNameForProfileGridRow(), PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid, updateViaProfileNamesEditor(), and VIA_GRID_PROFILE_NAME.

◆ OnRemoveViaOverrideClick()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::OnRemoveViaOverrideClick ( wxCommandEvent & event )

overrideprivatevirtual

Removes a via override profile entry from the via overrides grid.

Reimplemented from PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE.

Definition at line 479 of file panel_setup_time_domain_parameters.cpp.

References WX_GRID::CommitPendingChanges(), and PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid.

◆ OnSizeTraceParametersGrid()

virtual void PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::OnSizeTraceParametersGrid ( wxSizeEvent & event )

inlineprotectedvirtualinherited

Definition at line 57 of file panel_setup_time_domain_parameters_base.h.

Referenced by PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE(), and PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::~PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE().

◆ OnUpdateUI()

virtual void PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::OnUpdateUI ( wxUpdateUIEvent & event )

inlineprotectedvirtualinherited

Definition at line 56 of file panel_setup_time_domain_parameters_base.h.

Referenced by PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE(), and PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::~PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE().

◆ setColumnWidths()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::setColumnWidths ( )

private

Optimise grid columns to fit titles and content.

Definition at line 265 of file panel_setup_time_domain_parameters.cpp.

References PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid, PROFILE_GRID_PROFILE_NAME, and VIA_GRID_PROFILE_NAME.

Referenced by PANEL_SETUP_TIME_DOMAIN_PARAMETERS(), and SyncCopperLayers().

◆ SyncCopperLayers()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::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 239 of file panel_setup_time_domain_parameters.cpp.

References LSET::AllCuMask(), BOARD::GetLayerName(), m_board, m_copperColumnsToLayerId, m_copperLayerIdsToColumns, m_layerNames, m_layerNamesToIDs, m_prevLayerNamesToIDs, PROFILE_GRID_NUM_REQUIRED_COLS, setColumnWidths(), updateProfileGridColumns(), and updateViaGridColumns().

Referenced by DIALOG_BOARD_SETUP::onPageChanged(), and TransferDataToWindow().

◆ TransferDataFromWindow()

bool PANEL_SETUP_TIME_DOMAIN_PARAMETERS::TransferDataFromWindow ( )

override

Save parameter data to the settings object.

Definition at line 132 of file panel_setup_time_domain_parameters.cpp.

References getProfileRow(), getViaRow(), DELAY_PROFILE::m_ProfileName, m_timeDomainParameters, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid, DELAY_PROFILE::m_ViaOverrides, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid, Validate(), and VIA_GRID_PROFILE_NAME.

◆ TransferDataToWindow()

bool PANEL_SETUP_TIME_DOMAIN_PARAMETERS::TransferDataToWindow ( )

override

Load parameter data from the settings object.

Definition at line 109 of file panel_setup_time_domain_parameters.cpp.

References addProfileRow(), addViaRow(), WX_GRID::ClearRows(), BOARD::GetCopperLayerCount(), m_board, m_timeDomainParameters, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid, SyncCopperLayers(), and updateViaProfileNamesEditor().

Referenced by ImportSettingsFrom().

◆ updateProfileGridColumns()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::updateProfileGridColumns ( )

private

Update the dynamic (per-layer) columns in the tuning profiles grid.

Definition at line 291 of file panel_setup_time_domain_parameters.cpp.

References WX_GRID::EnsureColLabelsVisible(), BOARD::GetLayerName(), m_board, m_copperColumnsToLayerId, m_copperLayerIdsToColumns, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_tracePropagationGrid, m_unitsProvider, PROFILE_GRID_NUM_REQUIRED_COLS, PROFILE_GRID_VIA_PROP_DELAY, WX_GRID::SetAutoEvalCols(), and WX_GRID::SetAutoEvalColUnits().

Referenced by SyncCopperLayers().

◆ updateViaGridColumns()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::updateViaGridColumns ( )

private

Update the dynamic (per-layer) columns in the via overrides grid.

Definition at line 328 of file panel_setup_time_domain_parameters.cpp.

References BOARD::GetLayerName(), m_board, m_copperLayerIdsToColumns, m_layerNames, m_prevLayerNamesToIDs, PANEL_SETUP_TIME_DOMAIN_PARAMETERS_BASE::m_viaPropagationGrid, VIA_GRID_SIGNAL_LAYER_FROM, VIA_GRID_SIGNAL_LAYER_TO, VIA_GRID_VIA_LAYER_FROM, and VIA_GRID_VIA_LAYER_TO.

Referenced by SyncCopperLayers().

◆ updateViaProfileNamesEditor()

void PANEL_SETUP_TIME_DOMAIN_PARAMETERS::updateViaProfileNamesEditor	(	const wxString &	aOldName = `wxEmptyString`,
		const wxString &	aNewName = `wxEmptyString`
	)		const