PCB net inspection panel. More...

#include <pcb_net_inspector_panel.h>

Inheritance diagram for PCB_NET_INSPECTOR_PANEL:

Classes
struct	COLUMN_DESC
	Column metadata. More...

class	DATA_MODEL
	Data model for display in the Net Inspector panel. More...

class	LIST_ITEM
	Primary data item for entries in the Net Inspector list. More...

struct	LIST_ITEM_GROUP_NUMBER_CMP_LESS

struct	LIST_ITEM_NETCODE_CMP_LESS

Public Member Functions
	PCB_NET_INSPECTOR_PANEL (wxWindow parent, PCB_EDIT_FRAME aFrame)

virtual	~PCB_NET_INSPECTOR_PANEL ()

void	OnParentSetupChanged () override
	Updates the netlist based on global board changes (e.g.

void	OnBoardItemAdded (BOARD &aBoard, BOARD_ITEM *aBoardItem) override

void	OnBoardItemsAdded (BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItems) override

void	OnBoardItemRemoved (BOARD &aBoard, BOARD_ITEM *aBoardItem) override

void	OnBoardItemsRemoved (BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItems) override

void	OnBoardNetSettingsChanged (BOARD &aBoard) override

void	OnBoardItemChanged (BOARD &aBoard, BOARD_ITEM *aBoardItem) override

void	OnBoardItemsChanged (BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItems) override

void	OnBoardHighlightNetChanged (BOARD &aBoard) override

void	OnBoardCompositeUpdate (BOARD &aBoard, std::vector< BOARD_ITEM * > &aAddedItems, std::vector< BOARD_ITEM * > &aRemovedItems, std::vector< BOARD_ITEM * > &aChangedItems) override

void	OnBoardChanged () override
	Update panel when board is changed.

void	OnShowPanel () override
	Prepare the panel when shown in the editor.

void	SaveSettings () override
	Persist the net inspector configuration to project / global settings.

virtual void	OnBoardRatsnestChanged (BOARD &aBoard)

Protected Member Functions
void	OnLanguageChangedImpl () override
	Reloads strings on an application language change.

void	OnSearchTextChanged (wxCommandEvent &event) override

void	OnConfigButton (wxCommandEvent &event) override

void	OnExpandCollapseRow (wxCommandEvent &event)

void	OnHeaderContextMenu (wxCommandEvent &event)

void	OnNetsListContextMenu (wxDataViewEvent &event)

void	OnNetsListItemActivated (wxDataViewEvent &event)

void	OnColumnSorted (wxDataViewEvent &event)

virtual void	OnSetFocus (wxFocusEvent &event)

virtual void	OnSize (wxSizeEvent &event)

virtual void	OnLanguageChanged (wxCommandEvent &event)

Protected Attributes
wxGridBagSizer *	m_sizerOuter

wxSearchCtrl *	m_searchCtrl

BITMAP_BUTTON *	m_configureBtn

wxDataViewCtrl *	m_netsList

Private Types
enum class	CSV_COLUMN_DESC : int { CSV_NONE = 0 , CSV_QUOTE = 1 << 0 }
	CSV output control. More...

enum	{ COLUMN_NAME = 0 , COLUMN_NETCLASS , COLUMN_TOTAL_LENGTH , COLUMN_VIA_COUNT , COLUMN_VIA_LENGTH , COLUMN_BOARD_LENGTH , COLUMN_PAD_DIE_LENGTH , COLUMN_PAD_COUNT , COLUMN_LAST_STATIC_COL = COLUMN_PAD_COUNT }
	Column static IDs. Used to refer to columns as user re-ordering can occur. More...

enum	POPUP_MENU_OPTIONS { ID_ADD_NET = ID_POPUP_MENU_START , ID_RENAME_NET , ID_DELETE_NET , ID_ADD_GROUP , ID_GROUP_BY_CONSTRAINT , ID_GROUP_BY_NETCLASS , ID_FILTER_BY_NET_NAME , ID_FILTER_BY_NETCLASS , ID_REMOVE_SELECTED_GROUP , ID_REMOVE_GROUPS , ID_SHOW_ZERO_NET_PADS , ID_SHOW_UNCONNECTED_NETS , ID_GENERATE_REPORT , ID_HIGHLIGHT_SELECTED_NETS , ID_CLEAR_HIGHLIGHTING , ID_SHOW_TIME_DOMAIN_DETAILS , ID_LAST_STATIC_MENU = ID_CLEAR_HIGHLIGHTING , ID_HIDE_COLUMN }
	Popup menu item IDs. More...

using	LIST_ITEM_ITER = std::vector< std::unique_ptr< LIST_ITEM > >::iterator

using	LIST_ITEM_CONST_ITER = std::vector< std::unique_ptr< LIST_ITEM > >::const_iterator

Private Member Functions
void	updateNets (const std::vector< NETINFO_ITEM * > &aNets) const
	Updates displayed statistics for the given nets.

void	updateBoardItems (const std::vector< BOARD_ITEM * > &aBoardItems)
	Unified handling of added / deleted / modified board items.

wxString	formatLength (int64_t aValue) const

wxString	formatDelay (int64_t aValue) const

void	generateShowHideColumnMenu (wxMenu *target)
	Generates a sub-menu for the show / hide columns submenu.

std::vector< CN_ITEM * >	relevantConnectivityItems () const
	Fetches an ordered (by NetCode) list of all board connectivity items.

bool	netFilterMatches (NETINFO_ITEM aNet, PANEL_NET_INSPECTOR_SETTINGS cfg=nullptr) const
	Filter to determine whether a board net should be included in the net inspector.

void	buildNetsList (bool rebuildColumns=false)
	Rebuilds the net inspector list, removing all previous entries.

void	buildColumns ()
	Build the required columns in the net inspector grid.

void	setColumnWidths ()
	Set sensible default column widths.

void	adjustListColumnSizes (PANEL_NET_INSPECTOR_SETTINGS *cfg) const
	Adjust the sizing of list columns.

bool	restoreSortColumn (int sortingColumnId, bool sortOrderAsc) const
	Sets the sort column in the grid to that showing the given model ID column.

wxDataViewColumn *	getDisplayedColumnForModelField (int columnId) const
	Fetches the displayed grid view column for the given model column ID.

void	generateReport ()
	Generates a CSV report from currently disaplyed data.

void	highlightSelectedNets ()
	Highlight the currently selected net.

void	onUnitsChanged (wxCommandEvent &event)
	Handle an application-level change of units.

void	onContextMenuSelection (wxCommandEvent &event)
	Handle a net row(s) context menu selection.

void	onItemContextMenu (wxCommandEvent &event)
	Display a new row(s) context menu.

void	onAddNet ()
	Adds a new user-specified net to the board.

void	onRenameSelectedNet ()
	Renames a selected net.

void	onDeleteSelectedNet ()
	Deletes a selected net.

void	onAddGroup ()
	Adds a custom display grouping of nets.

void	onRemoveSelectedGroup ()
	Removes a custom display grouping.

void	onClearHighlighting ()
	Clears highlighting from nets.

std::vector< std::unique_ptr< LIST_ITEM > >	calculateNets (const std::vector< NETINFO_ITEM * > &aNetCodes, bool aIncludeZeroPadNets) const
	Calculates the length statistics for each given netcode.

void	updateDisplayedRowValues (const std::optional< LIST_ITEM_ITER > &aRow) const
	Refreshes displayed data for the given rows.

Static Private Member Functions
static wxString	formatNetCode (const NETINFO_ITEM *aNet)

static wxString	formatNetName (const NETINFO_ITEM *aNet)

static wxString	formatCount (unsigned int aValue)

Private Attributes
BOARD *	m_board = nullptr
	Parent BOARD.

PCB_EDIT_FRAME *	m_frame = nullptr
	Owning edit frame.

wxObjectDataPtr< DATA_MODEL >	m_dataModel
	The bound data model to display.

friend	DATA_MODEL

bool	m_inReporting = false

bool	m_inBuildNetsList = false

bool	m_boardLoaded = false

bool	m_boardLoading = false

bool	m_rowExpanding = false

bool	m_highlightingNets = false

bool	m_filterByNetName = true

bool	m_filterByNetclass = true

bool	m_showZeroPadNets = false

bool	m_showUnconnectedNets = false

bool	m_groupByNetclass = false

bool	m_groupByConstraint = false

bool	m_showTimeDomainDetails = false

std::vector< std::unique_ptr< EDA_COMBINED_MATCHER > >	m_custom_group_rules
	Custom net grouping rules.

std::vector< COLUMN_DESC >	m_columns
	All displayed (or hidden) columns.

Detailed Description

PCB net inspection panel.

Provides a read-only view of net information, such as routed lengths. Data is updated after every change of board items.

Definition at line 45 of file pcb_net_inspector_panel.h.

Member Typedef Documentation

◆ LIST_ITEM_CONST_ITER

using PCB_NET_INSPECTOR_PANEL::LIST_ITEM_CONST_ITER = std::vector<std::unique_ptr<LIST_ITEM> >::const_iterator

private

Definition at line 208 of file pcb_net_inspector_panel.h.

◆ LIST_ITEM_ITER

using PCB_NET_INSPECTOR_PANEL::LIST_ITEM_ITER = std::vector<std::unique_ptr<LIST_ITEM> >::iterator

private

Definition at line 207 of file pcb_net_inspector_panel.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Column static IDs. Used to refer to columns as user re-ordering can occur.

Enumerator
COLUMN_NAME
COLUMN_NETCLASS
COLUMN_TOTAL_LENGTH
COLUMN_VIA_COUNT
COLUMN_VIA_LENGTH
COLUMN_BOARD_LENGTH
COLUMN_PAD_DIE_LENGTH
COLUMN_PAD_COUNT
COLUMN_LAST_STATIC_COL

Definition at line 298 of file pcb_net_inspector_panel.h.

◆ CSV_COLUMN_DESC

enum class PCB_NET_INSPECTOR_PANEL::CSV_COLUMN_DESC : int

strongprivate

CSV output control.

Enumerator
CSV_NONE
CSV_QUOTE

Definition at line 265 of file pcb_net_inspector_panel.h.

◆ POPUP_MENU_OPTIONS

enum PCB_NET_INSPECTOR_PANEL::POPUP_MENU_OPTIONS

private

Popup menu item IDs.

Enumerator
ID_ADD_NET
ID_RENAME_NET
ID_DELETE_NET
ID_ADD_GROUP
ID_GROUP_BY_CONSTRAINT
ID_GROUP_BY_NETCLASS
ID_FILTER_BY_NET_NAME
ID_FILTER_BY_NETCLASS
ID_REMOVE_SELECTED_GROUP
ID_REMOVE_GROUPS
ID_SHOW_ZERO_NET_PADS
ID_SHOW_UNCONNECTED_NETS
ID_GENERATE_REPORT
ID_HIGHLIGHT_SELECTED_NETS
ID_CLEAR_HIGHLIGHTING
ID_SHOW_TIME_DOMAIN_DETAILS
ID_LAST_STATIC_MENU
ID_HIDE_COLUMN

Definition at line 312 of file pcb_net_inspector_panel.h.

Constructor & Destructor Documentation

◆ PCB_NET_INSPECTOR_PANEL()

PCB_NET_INSPECTOR_PANEL::PCB_NET_INSPECTOR_PANEL	(	wxWindow *	parent,
		PCB_EDIT_FRAME *	aFrame
	)

Definition at line 46 of file pcb_net_inspector_panel.cpp.

References BOARD::AddListener(), buildNetsList(), PCB_BASE_FRAME::GetBoard(), m_board, m_dataModel, m_frame, NET_INSPECTOR_PANEL::m_netsList, OnBoardHighlightNetChanged(), OnColumnSorted(), OnExpandCollapseRow(), OnHeaderContextMenu(), OnNetsListContextMenu(), OnNetsListItemActivated(), and onUnitsChanged().

◆ ~PCB_NET_INSPECTOR_PANEL()

PCB_NET_INSPECTOR_PANEL::~PCB_NET_INSPECTOR_PANEL ( )

virtual

Definition at line 77 of file pcb_net_inspector_panel.cpp.

References m_frame, NET_INSPECTOR_PANEL::m_netsList, OnColumnSorted(), OnExpandCollapseRow(), OnHeaderContextMenu(), OnNetsListContextMenu(), OnNetsListItemActivated(), onUnitsChanged(), and SaveSettings().

Member Function Documentation

◆ adjustListColumnSizes()

void PCB_NET_INSPECTOR_PANEL::adjustListColumnSizes ( PANEL_NET_INSPECTOR_SETTINGS * cfg ) const

private

Adjust the sizing of list columns.

Parameters

cfg	the PANEL_NET_INSPECTOR_SETTINGS from which to read column widths

Definition at line 294 of file pcb_net_inspector_panel.cpp.

References PANEL_NET_INSPECTOR_SETTINGS::col_hidden, PANEL_NET_INSPECTOR_SETTINGS::col_order, PANEL_NET_INSPECTOR_SETTINGS::col_widths, COLUMN_NAME, COLUMN_NETCLASS, COLUMN_PAD_COUNT, COLUMN_VIA_COUNT, m_columns, and NET_INSPECTOR_PANEL::m_netsList.

Referenced by buildColumns().

◆ buildColumns()

void PCB_NET_INSPECTOR_PANEL::buildColumns ( )

private

Build the required columns in the net inspector grid.

Definition at line 103 of file pcb_net_inspector_panel.cpp.

References _, adjustListColumnSizes(), PANEL_NET_INSPECTOR_SETTINGS::col_hidden, PANEL_NET_INSPECTOR_SETTINGS::col_order, COLUMN_BOARD_LENGTH, COLUMN_NAME, COLUMN_NETCLASS, COLUMN_PAD_COUNT, COLUMN_PAD_DIE_LENGTH, COLUMN_TOTAL_LENGTH, COLUMN_VIA_COUNT, COLUMN_VIA_LENGTH, CSV_NONE, CSV_QUOTE, BOARD::GetCopperLayerCount(), getDisplayedColumnForModelField(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), PROJECT::GetLocalSettings(), PGM_BASE::GetSettingsManager(), IsCopperLayer(), m_board, m_boardLoaded, m_columns, PROJECT_LOCAL_SETTINGS::m_NetInspectorPanel, NET_INSPECTOR_PANEL::m_netsList, m_showTimeDomainDetails, Pgm(), SETTINGS_MANAGER::Prj(), LSET::Seq(), and UNDEFINED_LAYER.

Referenced by buildNetsList().

◆ buildNetsList()

void PCB_NET_INSPECTOR_PANEL::buildNetsList ( bool rebuildColumns = false )

private

Rebuilds the net inspector list, removing all previous entries.

Definition at line 392 of file pcb_net_inspector_panel.cpp.

Referenced by onAddGroup(), OnBoardChanged(), OnBoardNetSettingsChanged(), onContextMenuSelection(), OnLanguageChangedImpl(), OnParentSetupChanged(), onRemoveSelectedGroup(), onRenameSelectedNet(), OnSearchTextChanged(), OnShowPanel(), PCB_NET_INSPECTOR_PANEL(), and updateBoardItems().

◆ calculateNets()

std::vector< std::unique_ptr< PCB_NET_INSPECTOR_PANEL::LIST_ITEM > > PCB_NET_INSPECTOR_PANEL::calculateNets	(	const std::vector< NETINFO_ITEM * > &	aNetCodes,
		bool	aIncludeZeroPadNets
	)		const

private

Calculates the length statistics for each given netcode.

Parameters

aNetCodes	is the list of netcodes to calculate statistics for. This must be sorted in ascending netcode order
aIncludeZeroPadNets	determines whether the results should include nets with no pads

Returns: a map of net code to net length detail objects

Definition at line 627 of file pcb_net_inspector_panel.cpp.

References end, GetKiCadThreadPool(), BOARD::GetLengthCalculation(), LENGTH_DELAY_CALCULATION::GetLengthCalculationItem(), m_board, relevantConnectivityItems(), and tp.

Referenced by buildNetsList(), and updateNets().

◆ formatCount()

wxString PCB_NET_INSPECTOR_PANEL::formatCount ( unsigned int aValue )

staticprivate

Definition at line 741 of file pcb_net_inspector_panel.cpp.

Referenced by PCB_NET_INSPECTOR_PANEL::DATA_MODEL::GetValue().

◆ formatDelay()

wxString PCB_NET_INSPECTOR_PANEL::formatDelay ( int64_t aValue ) const

private

Definition at line 754 of file pcb_net_inspector_panel.cpp.

References m_frame, m_inReporting, and UNITS_PROVIDER::MessageTextFromValue().

Referenced by PCB_NET_INSPECTOR_PANEL::DATA_MODEL::GetValue().

◆ formatLength()

wxString PCB_NET_INSPECTOR_PANEL::formatLength ( int64_t aValue ) const

private

Definition at line 747 of file pcb_net_inspector_panel.cpp.

References m_frame, m_inReporting, and UNITS_PROVIDER::MessageTextFromValue().

Referenced by PCB_NET_INSPECTOR_PANEL::DATA_MODEL::GetValue().

◆ formatNetCode()

wxString PCB_NET_INSPECTOR_PANEL::formatNetCode ( const NETINFO_ITEM * aNet )

staticprivate

Definition at line 729 of file pcb_net_inspector_panel.cpp.

References NETINFO_ITEM::GetNetCode().

◆ formatNetName()

wxString PCB_NET_INSPECTOR_PANEL::formatNetName ( const NETINFO_ITEM * aNet )

staticprivate

Definition at line 735 of file pcb_net_inspector_panel.cpp.

References NETINFO_ITEM::GetNetname(), and UnescapeString().

◆ generateReport()

void PCB_NET_INSPECTOR_PANEL::generateReport ( )

private

Generates a CSV report from currently disaplyed data.

Definition at line 1420 of file pcb_net_inspector_panel.cpp.

References _, AddFileExtListToFilter(), CSV_QUOTE, EDA_UNIT_UTILS::GetLabel(), UNITS_PROVIDER::GetUserUnits(), m_columns, m_dataModel, m_frame, and m_inReporting.

Referenced by OnConfigButton(), and onContextMenuSelection().

◆ generateShowHideColumnMenu()

void PCB_NET_INSPECTOR_PANEL::generateShowHideColumnMenu ( wxMenu * target )

private

Generates a sub-menu for the show / hide columns submenu.

Definition at line 1291 of file pcb_net_inspector_panel.cpp.

References COLUMN_LAST_STATIC_COL, getDisplayedColumnForModelField(), ID_HIDE_COLUMN, and m_columns.

Referenced by OnConfigButton(), and OnHeaderContextMenu().

◆ getDisplayedColumnForModelField()

wxDataViewColumn * PCB_NET_INSPECTOR_PANEL::getDisplayedColumnForModelField ( int columnId ) const

private

Fetches the displayed grid view column for the given model column ID.

Parameters

columnId The ID (from column static IDs enum) to find

Returns: Pointer to the wxDataViewColumn, or nullptr if not found

Definition at line 369 of file pcb_net_inspector_panel.cpp.

References NET_INSPECTOR_PANEL::m_netsList.

Referenced by buildColumns(), generateShowHideColumnMenu(), onContextMenuSelection(), and restoreSortColumn().

◆ highlightSelectedNets()

void PCB_NET_INSPECTOR_PANEL::highlightSelectedNets ( )

private

◆ netFilterMatches()

bool PCB_NET_INSPECTOR_PANEL::netFilterMatches	(	NETINFO_ITEM *	aNet,
		PANEL_NET_INSPECTOR_SETTINGS *	cfg = `nullptr`
	)		const

private

Filter to determine whether a board net should be included in the net inspector.

Definition at line 548 of file pcb_net_inspector_panel.cpp.

References PANEL_NET_INSPECTOR_SETTINGS::filter_by_net_name, PANEL_NET_INSPECTOR_SETTINGS::filter_by_netclass, PROJECT::GetLocalSettings(), NETCLASS::GetName(), NETINFO_ITEM::GetNetClass(), NETINFO_ITEM::GetNetCode(), NETINFO_ITEM::GetNetname(), PGM_BASE::GetSettingsManager(), PROJECT_LOCAL_SETTINGS::m_NetInspectorPanel, NET_INSPECTOR_PANEL::m_searchCtrl, m_showUnconnectedNets, Pgm(), SETTINGS_MANAGER::Prj(), and UnescapeString().

Referenced by buildNetsList(), updateBoardItems(), and updateNets().

◆ onAddGroup()

void PCB_NET_INSPECTOR_PANEL::onAddGroup ( )

private

Adds a custom display grouping of nets.

Definition at line 1122 of file pcb_net_inspector_panel.cpp.

References _, buildNetsList(), CTX_NET, KIUI::GetInfoFont(), WX_TEXT_ENTRY_DIALOG::GetValue(), help, WX_TEXT_ENTRY_DIALOG_BASE::m_ContentSizer, m_custom_group_rules, SaveSettings(), WX_TEXT_ENTRY_DIALOG::SetTextValidator(), DIALOG_SHIM::ShowModal(), and UnescapeString().

Referenced by onContextMenuSelection().

◆ onAddNet()

void PCB_NET_INSPECTOR_PANEL::onAddNet ( )

private

Adds a new user-specified net to the board.

Definition at line 1552 of file pcb_net_inspector_panel.cpp.

References _, BOARD::Add(), DisplayError(), BOARD::FindNet(), WX_TEXT_ENTRY_DIALOG::GetValue(), m_board, m_frame, PCB_EDIT_FRAME::OnModify(), WX_TEXT_ENTRY_DIALOG::SetTextValidator(), and DIALOG_SHIM::ShowModal().

Referenced by onContextMenuSelection().

◆ OnBoardChanged()

void PCB_NET_INSPECTOR_PANEL::OnBoardChanged ( )

overridevirtual

Update panel when board is changed.

Reimplemented from NET_INSPECTOR_PANEL.

Definition at line 787 of file pcb_net_inspector_panel.cpp.

References BOARD::AddListener(), buildNetsList(), PCB_BASE_FRAME::GetBoard(), PROJECT::GetLocalSettings(), PGM_BASE::GetSettingsManager(), m_board, m_boardLoaded, m_boardLoading, m_frame, PROJECT_LOCAL_SETTINGS::m_NetInspectorPanel, NET_INSPECTOR_PANEL::m_searchCtrl, Pgm(), and SETTINGS_MANAGER::Prj().

◆ OnBoardCompositeUpdate()

void PCB_NET_INSPECTOR_PANEL::OnBoardCompositeUpdate	(	BOARD &	aBoard,
		std::vector< BOARD_ITEM * > &	aAddedItems,
		std::vector< BOARD_ITEM * > &	aRemovedItems,
		std::vector< BOARD_ITEM * > &	aChangedItems
	)

overridevirtual

Reimplemented from BOARD_LISTENER.

Definition at line 975 of file pcb_net_inspector_panel.cpp.

References updateBoardItems().

◆ OnBoardHighlightNetChanged()

void PCB_NET_INSPECTOR_PANEL::OnBoardHighlightNetChanged ( BOARD & aBoard )

overridevirtual

Reimplemented from BOARD_LISTENER.

Definition at line 990 of file pcb_net_inspector_panel.cpp.

References BOARD::GetHighLightNetCodes(), BOARD::IsHighLightNetON(), m_board, m_dataModel, m_highlightingNets, and NET_INSPECTOR_PANEL::m_netsList.

Referenced by OnShowPanel(), and PCB_NET_INSPECTOR_PANEL().

◆ OnBoardItemAdded()

void PCB_NET_INSPECTOR_PANEL::OnBoardItemAdded	(	BOARD &	aBoard,
		BOARD_ITEM *	aBoardItem
	)

overridevirtual

Reimplemented from BOARD_LISTENER.

Definition at line 807 of file pcb_net_inspector_panel.cpp.

References updateBoardItems().

◆ OnBoardItemChanged()

void PCB_NET_INSPECTOR_PANEL::OnBoardItemChanged	(	BOARD &	aBoard,
		BOARD_ITEM *	aBoardItem
	)

overridevirtual

Reimplemented from BOARD_LISTENER.

Definition at line 961 of file pcb_net_inspector_panel.cpp.

References updateBoardItems().

◆ OnBoardItemRemoved()

void PCB_NET_INSPECTOR_PANEL::OnBoardItemRemoved	(	BOARD &	aBoard,
		BOARD_ITEM *	aBoardItem
	)

overridevirtual

Reimplemented from BOARD_LISTENER.

Definition at line 939 of file pcb_net_inspector_panel.cpp.

References updateBoardItems().

◆ OnBoardItemsAdded()

void PCB_NET_INSPECTOR_PANEL::OnBoardItemsAdded	(	BOARD &	aBoard,
		std::vector< BOARD_ITEM * > &	aBoardItems
	)

overridevirtual

Reimplemented from BOARD_LISTENER.

Definition at line 814 of file pcb_net_inspector_panel.cpp.

References updateBoardItems().

◆ OnBoardItemsChanged()

void PCB_NET_INSPECTOR_PANEL::OnBoardItemsChanged	(	BOARD &	aBoard,
		std::vector< BOARD_ITEM * > &	aBoardItems
	)

overridevirtual

Reimplemented from BOARD_LISTENER.

Definition at line 968 of file pcb_net_inspector_panel.cpp.

References updateBoardItems().

◆ OnBoardItemsRemoved()

void PCB_NET_INSPECTOR_PANEL::OnBoardItemsRemoved	(	BOARD &	aBoard,
		std::vector< BOARD_ITEM * > &	aBoardItems
	)

overridevirtual

Reimplemented from BOARD_LISTENER.

Definition at line 946 of file pcb_net_inspector_panel.cpp.

References updateBoardItems().

◆ OnBoardNetSettingsChanged()

void PCB_NET_INSPECTOR_PANEL::OnBoardNetSettingsChanged ( BOARD & aBoard )

overridevirtual

Reimplemented from BOARD_LISTENER.

Definition at line 952 of file pcb_net_inspector_panel.cpp.

References buildNetsList().

◆ OnBoardRatsnestChanged()

virtual void BOARD_LISTENER::OnBoardRatsnestChanged ( BOARD & aBoard )

inlinevirtualinherited

Reimplemented in PCB_SEARCH_PANE.

Definition at line 290 of file board.h.

Referenced by BOARD::OnRatsnestChanged().

◆ onClearHighlighting()

void PCB_NET_INSPECTOR_PANEL::onClearHighlighting ( )

private

Clears highlighting from nets.

Definition at line 1159 of file pcb_net_inspector_panel.cpp.

References PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), PCB_DRAW_PANEL_GAL::GetView(), m_frame, m_highlightingNets, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::RENDER_SETTINGS::SetHighlight(), and KIGFX::VIEW::UpdateAllLayersColor().

Referenced by onContextMenuSelection().

◆ OnColumnSorted()

void PCB_NET_INSPECTOR_PANEL::OnColumnSorted ( wxDataViewEvent & event )

protected

Definition at line 1538 of file pcb_net_inspector_panel.cpp.

References m_inBuildNetsList, and SaveSettings().

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

◆ OnConfigButton()

void PCB_NET_INSPECTOR_PANEL::OnConfigButton ( wxCommandEvent & event )

overrideprotectedvirtual

◆ onContextMenuSelection()

void PCB_NET_INSPECTOR_PANEL::onContextMenuSelection ( wxCommandEvent & event )

private

Handle a net row(s) context menu selection.

Definition at line 1315 of file pcb_net_inspector_panel.cpp.

References buildNetsList(), generateReport(), getDisplayedColumnForModelField(), highlightSelectedNets(), ID_ADD_GROUP, ID_ADD_NET, ID_CLEAR_HIGHLIGHTING, ID_DELETE_NET, ID_FILTER_BY_NET_NAME, ID_FILTER_BY_NETCLASS, ID_GENERATE_REPORT, ID_GROUP_BY_CONSTRAINT, ID_GROUP_BY_NETCLASS, ID_HIDE_COLUMN, ID_HIGHLIGHT_SELECTED_NETS, ID_REMOVE_GROUPS, ID_REMOVE_SELECTED_GROUP, ID_RENAME_NET, ID_SHOW_TIME_DOMAIN_DETAILS, ID_SHOW_UNCONNECTED_NETS, ID_SHOW_ZERO_NET_PADS, m_custom_group_rules, m_filterByNetclass, m_filterByNetName, m_groupByConstraint, m_groupByNetclass, m_showTimeDomainDetails, m_showUnconnectedNets, m_showZeroPadNets, onAddGroup(), onAddNet(), onClearHighlighting(), onDeleteSelectedNet(), onRemoveSelectedGroup(), onRenameSelectedNet(), and SaveSettings().

Referenced by OnConfigButton(), OnHeaderContextMenu(), and OnNetsListContextMenu().

◆ onDeleteSelectedNet()

void PCB_NET_INSPECTOR_PANEL::onDeleteSelectedNet ( )

private

◆ OnExpandCollapseRow()

void PCB_NET_INSPECTOR_PANEL::OnExpandCollapseRow ( wxCommandEvent & event )

protected

Definition at line 1171 of file pcb_net_inspector_panel.cpp.

References m_rowExpanding, and SaveSettings().

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

◆ OnHeaderContextMenu()

void PCB_NET_INSPECTOR_PANEL::OnHeaderContextMenu ( wxCommandEvent & event )

protected

Definition at line 1178 of file pcb_net_inspector_panel.cpp.

References generateShowHideColumnMenu(), and onContextMenuSelection().

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

◆ onItemContextMenu()

void PCB_NET_INSPECTOR_PANEL::onItemContextMenu ( wxCommandEvent & event )

private

Display a new row(s) context menu.

◆ OnLanguageChanged()

void NET_INSPECTOR_PANEL::OnLanguageChanged ( wxCommandEvent & event )

protectedvirtualinherited

Definition at line 96 of file net_inspector_panel.cpp.

References _, NET_INSPECTOR_PANEL::m_configureBtn, NET_INSPECTOR_PANEL::m_searchCtrl, and NET_INSPECTOR_PANEL::OnLanguageChangedImpl().

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

◆ OnLanguageChangedImpl()

void PCB_NET_INSPECTOR_PANEL::OnLanguageChangedImpl ( )

overrideprotectedvirtual

Reloads strings on an application language change.

Reimplemented from NET_INSPECTOR_PANEL.

Definition at line 1763 of file pcb_net_inspector_panel.cpp.

References buildNetsList(), m_dataModel, and SaveSettings().

◆ OnNetsListContextMenu()

void PCB_NET_INSPECTOR_PANEL::OnNetsListContextMenu ( wxDataViewEvent & event )

protected

◆ OnNetsListItemActivated()

void PCB_NET_INSPECTOR_PANEL::OnNetsListItemActivated ( wxDataViewEvent & event )

protected

Definition at line 1488 of file pcb_net_inspector_panel.cpp.

References highlightSelectedNets().

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

◆ OnParentSetupChanged()

void PCB_NET_INSPECTOR_PANEL::OnParentSetupChanged ( )

overridevirtual

Updates the netlist based on global board changes (e.g.

stackup definition)

Called by PCB_EDIT_FRAME after displaying the Board Setup dialog

Reimplemented from NET_INSPECTOR_PANEL.

Definition at line 1545 of file pcb_net_inspector_panel.cpp.

References buildNetsList().

◆ onRemoveSelectedGroup()

void PCB_NET_INSPECTOR_PANEL::onRemoveSelectedGroup ( )

private

Removes a custom display grouping.

Definition at line 1394 of file pcb_net_inspector_panel.cpp.

References buildNetsList(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetGroupName(), m_custom_group_rules, NET_INSPECTOR_PANEL::m_netsList, and SaveSettings().

Referenced by onContextMenuSelection().

◆ onRenameSelectedNet()

void PCB_NET_INSPECTOR_PANEL::onRenameSelectedNet ( )

private

◆ OnSearchTextChanged()

void PCB_NET_INSPECTOR_PANEL::OnSearchTextChanged ( wxCommandEvent & event )

overrideprotectedvirtual

Reimplemented from NET_INSPECTOR_PANEL.

Definition at line 1115 of file pcb_net_inspector_panel.cpp.

References buildNetsList(), and SaveSettings().

◆ OnSetFocus()

virtual void NET_INSPECTOR_PANEL::OnSetFocus ( wxFocusEvent & event )

inlineprotectedvirtualinherited

Definition at line 75 of file net_inspector_panel.h.

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

◆ OnShowPanel()

void PCB_NET_INSPECTOR_PANEL::OnShowPanel ( )

overridevirtual

Prepare the panel when shown in the editor.

Reimplemented from NET_INSPECTOR_PANEL.

Definition at line 1026 of file pcb_net_inspector_panel.cpp.

References buildNetsList(), m_board, and OnBoardHighlightNetChanged().

◆ OnSize()

virtual void NET_INSPECTOR_PANEL::OnSize ( wxSizeEvent & event )

inlineprotectedvirtualinherited

Definition at line 76 of file net_inspector_panel.h.

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

◆ onUnitsChanged()

void PCB_NET_INSPECTOR_PANEL::onUnitsChanged ( wxCommandEvent & event )

private

Handle an application-level change of units.

Definition at line 1771 of file pcb_net_inspector_panel.cpp.

References m_dataModel.

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

◆ relevantConnectivityItems()

std::vector< CN_ITEM * > PCB_NET_INSPECTOR_PANEL::relevantConnectivityItems ( ) const

private

Fetches an ordered (by NetCode) list of all board connectivity items.

Definition at line 601 of file pcb_net_inspector_panel.cpp.

References BOARD::GetConnectivity(), m_board, PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, and PCB_VIA_T.

Referenced by calculateNets().

◆ restoreSortColumn()

bool PCB_NET_INSPECTOR_PANEL::restoreSortColumn	(	int	sortingColumnId,
		bool	sortOrderAsc
	)		const

private

Sets the sort column in the grid to that showing the given model ID column.

Parameters

sortingColumnId	The model ID of the column to sort by
sortOrderAsc	True for ascending sort, False for descending sort

Returns: true if the column was found

Definition at line 353 of file pcb_net_inspector_panel.cpp.

References getDisplayedColumnForModelField(), and m_dataModel.

Referenced by buildNetsList().

◆ SaveSettings()

void PCB_NET_INSPECTOR_PANEL::SaveSettings ( )

overridevirtual

Persist the net inspector configuration to project / global settings.

Reimplemented from NET_INSPECTOR_PANEL.

Definition at line 1785 of file pcb_net_inspector_panel.cpp.

References PANEL_NET_INSPECTOR_SETTINGS::filter_text, PROJECT::GetLocalSettings(), PGM_BASE::GetSettingsManager(), m_boardLoaded, m_boardLoading, m_custom_group_rules, m_dataModel, m_filterByNetclass, m_filterByNetName, m_groupByConstraint, m_groupByNetclass, PROJECT_LOCAL_SETTINGS::m_NetInspectorPanel, NET_INSPECTOR_PANEL::m_netsList, NET_INSPECTOR_PANEL::m_searchCtrl, m_showTimeDomainDetails, m_showUnconnectedNets, m_showZeroPadNets, Pgm(), and SETTINGS_MANAGER::Prj().

Referenced by onAddGroup(), OnColumnSorted(), onContextMenuSelection(), OnExpandCollapseRow(), OnLanguageChangedImpl(), onRemoveSelectedGroup(), OnSearchTextChanged(), and ~PCB_NET_INSPECTOR_PANEL().

◆ setColumnWidths()

void PCB_NET_INSPECTOR_PANEL::setColumnWidths ( )

private

Set sensible default column widths.

◆ updateBoardItems()

void PCB_NET_INSPECTOR_PANEL::updateBoardItems ( const std::vector< BOARD_ITEM * > & aBoardItems )

private

Unified handling of added / deleted / modified board items.

Definition at line 820 of file pcb_net_inspector_panel.cpp.

References buildNetsList(), ADVANCED_CFG::GetCfg(), NETINFO_ITEM::GetNetCode(), ADVANCED_CFG::m_NetInspectorBulkUpdateOptimisationThreshold, NET_INSPECTOR_PANEL::m_netsList, netFilterMatches(), pad, and updateNets().

Referenced by OnBoardCompositeUpdate(), OnBoardItemAdded(), OnBoardItemChanged(), OnBoardItemRemoved(), OnBoardItemsAdded(), OnBoardItemsChanged(), and OnBoardItemsRemoved().

◆ updateDisplayedRowValues()

void PCB_NET_INSPECTOR_PANEL::updateDisplayedRowValues ( const std::optional< LIST_ITEM_ITER > & aRow ) const

private

Refreshes displayed data for the given rows.

Definition at line 762 of file pcb_net_inspector_panel.cpp.

References m_dataModel, and NET_INSPECTOR_PANEL::m_netsList.

Referenced by updateNets().

◆ updateNets()

void PCB_NET_INSPECTOR_PANEL::updateNets ( const std::vector< NETINFO_ITEM * > & aNets ) const

private

Updates displayed statistics for the given nets.

Definition at line 870 of file pcb_net_inspector_panel.cpp.

References calculateNets(), m_dataModel, NET_INSPECTOR_PANEL::m_netsList, m_showTimeDomainDetails, m_showZeroPadNets, netFilterMatches(), and updateDisplayedRowValues().

Referenced by updateBoardItems().

Member Data Documentation

◆ DATA_MODEL

friend PCB_NET_INSPECTOR_PANEL::DATA_MODEL

private

Definition at line 224 of file pcb_net_inspector_panel.h.

◆ m_board

BOARD* PCB_NET_INSPECTOR_PANEL::m_board = nullptr

private

Parent BOARD.

Definition at line 214 of file pcb_net_inspector_panel.h.

Referenced by PCB_NET_INSPECTOR_PANEL::DATA_MODEL::addCustomGroups(), buildColumns(), buildNetsList(), calculateNets(), onAddNet(), OnBoardChanged(), OnBoardHighlightNetChanged(), onDeleteSelectedNet(), onRenameSelectedNet(), OnShowPanel(), PCB_NET_INSPECTOR_PANEL(), and relevantConnectivityItems().

◆ m_boardLoaded

bool PCB_NET_INSPECTOR_PANEL::m_boardLoaded = false

private

Definition at line 241 of file pcb_net_inspector_panel.h.

Referenced by buildColumns(), buildNetsList(), OnBoardChanged(), and SaveSettings().

◆ m_boardLoading

bool PCB_NET_INSPECTOR_PANEL::m_boardLoading = false

private

Definition at line 242 of file pcb_net_inspector_panel.h.

Referenced by buildNetsList(), OnBoardChanged(), and SaveSettings().

◆ m_columns

std::vector<COLUMN_DESC> PCB_NET_INSPECTOR_PANEL::m_columns

private

All displayed (or hidden) columns.

Definition at line 295 of file pcb_net_inspector_panel.h.

Referenced by adjustListColumnSizes(), buildColumns(), PCB_NET_INSPECTOR_PANEL::DATA_MODEL::columnCount(), PCB_NET_INSPECTOR_PANEL::DATA_MODEL::Compare(), generateReport(), generateShowHideColumnMenu(), PCB_NET_INSPECTOR_PANEL::DATA_MODEL::GetValue(), and PCB_NET_INSPECTOR_PANEL::DATA_MODEL::itemColumnChanged().

◆ m_configureBtn

BITMAP_BUTTON* NET_INSPECTOR_PANEL::m_configureBtn

protectedinherited

Definition at line 91 of file net_inspector_panel.h.

Referenced by NET_INSPECTOR_PANEL::NET_INSPECTOR_PANEL(), NET_INSPECTOR_PANEL::OnLanguageChanged(), and NET_INSPECTOR_PANEL::~NET_INSPECTOR_PANEL().

◆ m_custom_group_rules

std::vector<std::unique_ptr<EDA_COMBINED_MATCHER> > PCB_NET_INSPECTOR_PANEL::m_custom_group_rules

private

Custom net grouping rules.

Definition at line 262 of file pcb_net_inspector_panel.h.

Referenced by PCB_NET_INSPECTOR_PANEL::DATA_MODEL::addCustomGroups(), PCB_NET_INSPECTOR_PANEL::DATA_MODEL::addItem(), buildNetsList(), onAddGroup(), OnConfigButton(), onContextMenuSelection(), onRemoveSelectedGroup(), and SaveSettings().

◆ m_dataModel

wxObjectDataPtr<DATA_MODEL> PCB_NET_INSPECTOR_PANEL::m_dataModel

private

The bound data model to display.

Definition at line 223 of file pcb_net_inspector_panel.h.

Referenced by buildNetsList(), generateReport(), OnBoardHighlightNetChanged(), OnLanguageChangedImpl(), onRenameSelectedNet(), onUnitsChanged(), PCB_NET_INSPECTOR_PANEL(), restoreSortColumn(), SaveSettings(), updateDisplayedRowValues(), and updateNets().

◆ m_filterByNetclass

bool PCB_NET_INSPECTOR_PANEL::m_filterByNetclass = true

private

Definition at line 254 of file pcb_net_inspector_panel.h.

Referenced by buildNetsList(), onContextMenuSelection(), and SaveSettings().

◆ m_filterByNetName

bool PCB_NET_INSPECTOR_PANEL::m_filterByNetName = true

private

Definition at line 253 of file pcb_net_inspector_panel.h.

Referenced by buildNetsList(), onContextMenuSelection(), and SaveSettings().

◆ m_frame

PCB_EDIT_FRAME* PCB_NET_INSPECTOR_PANEL::m_frame = nullptr

private

Owning edit frame.

Definition at line 217 of file pcb_net_inspector_panel.h.

Referenced by formatDelay(), formatLength(), generateReport(), highlightSelectedNets(), onAddNet(), OnBoardChanged(), onClearHighlighting(), onDeleteSelectedNet(), OnNetsListContextMenu(), onRenameSelectedNet(), PCB_NET_INSPECTOR_PANEL(), and ~PCB_NET_INSPECTOR_PANEL().

◆ m_groupByConstraint

bool PCB_NET_INSPECTOR_PANEL::m_groupByConstraint = false

private

Definition at line 258 of file pcb_net_inspector_panel.h.

Referenced by buildNetsList(), onContextMenuSelection(), and SaveSettings().

◆ m_groupByNetclass

bool PCB_NET_INSPECTOR_PANEL::m_groupByNetclass = false

private

Definition at line 257 of file pcb_net_inspector_panel.h.

Referenced by PCB_NET_INSPECTOR_PANEL::DATA_MODEL::addItem(), buildNetsList(), PCB_NET_INSPECTOR_PANEL::DATA_MODEL::deleteItem(), OnConfigButton(), onContextMenuSelection(), and SaveSettings().

◆ m_highlightingNets

bool PCB_NET_INSPECTOR_PANEL::m_highlightingNets = false

private

Definition at line 248 of file pcb_net_inspector_panel.h.

Referenced by highlightSelectedNets(), OnBoardHighlightNetChanged(), and onClearHighlighting().

◆ m_inBuildNetsList

bool PCB_NET_INSPECTOR_PANEL::m_inBuildNetsList = false

private

Definition at line 230 of file pcb_net_inspector_panel.h.

Referenced by buildNetsList(), highlightSelectedNets(), and OnColumnSorted().

◆ m_inReporting

bool PCB_NET_INSPECTOR_PANEL::m_inReporting = false

private

Definition at line 229 of file pcb_net_inspector_panel.h.

Referenced by formatDelay(), formatLength(), and generateReport().

◆ m_netsList

wxDataViewCtrl* NET_INSPECTOR_PANEL::m_netsList

protectedinherited

◆ m_rowExpanding

bool PCB_NET_INSPECTOR_PANEL::m_rowExpanding = false

private

Definition at line 247 of file pcb_net_inspector_panel.h.

Referenced by buildNetsList(), and OnExpandCollapseRow().

◆ m_searchCtrl

wxSearchCtrl* NET_INSPECTOR_PANEL::m_searchCtrl

protectedinherited

Definition at line 90 of file net_inspector_panel.h.

Referenced by NET_INSPECTOR_PANEL::NET_INSPECTOR_PANEL(), netFilterMatches(), OnBoardChanged(), NET_INSPECTOR_PANEL::OnLanguageChanged(), SaveSettings(), and NET_INSPECTOR_PANEL::~NET_INSPECTOR_PANEL().

◆ m_showTimeDomainDetails

bool PCB_NET_INSPECTOR_PANEL::m_showTimeDomainDetails = false

private

Definition at line 259 of file pcb_net_inspector_panel.h.

Referenced by buildColumns(), buildNetsList(), OnConfigButton(), onContextMenuSelection(), SaveSettings(), and updateNets().

◆ m_showUnconnectedNets

bool PCB_NET_INSPECTOR_PANEL::m_showUnconnectedNets = false

private

Definition at line 256 of file pcb_net_inspector_panel.h.

Referenced by netFilterMatches(), OnConfigButton(), onContextMenuSelection(), and SaveSettings().

◆ m_showZeroPadNets

bool PCB_NET_INSPECTOR_PANEL::m_showZeroPadNets = false

private

Definition at line 255 of file pcb_net_inspector_panel.h.

Referenced by buildNetsList(), OnConfigButton(), onContextMenuSelection(), SaveSettings(), and updateNets().

◆ m_sizerOuter

wxGridBagSizer* NET_INSPECTOR_PANEL::m_sizerOuter

protectedinherited

Definition at line 89 of file net_inspector_panel.h.

Referenced by NET_INSPECTOR_PANEL::NET_INSPECTOR_PANEL().

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

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ LIST_ITEM_CONST_ITER

◆ LIST_ITEM_ITER

Member Enumeration Documentation

◆ anonymous enum

◆ CSV_COLUMN_DESC

◆ POPUP_MENU_OPTIONS

Constructor & Destructor Documentation

◆ PCB_NET_INSPECTOR_PANEL()

◆ ~PCB_NET_INSPECTOR_PANEL()

Member Function Documentation

◆ adjustListColumnSizes()

◆ buildColumns()

◆ buildNetsList()

◆ calculateNets()

◆ formatCount()

◆ formatDelay()

◆ formatLength()

◆ formatNetCode()

◆ formatNetName()

◆ generateReport()

◆ generateShowHideColumnMenu()

◆ getDisplayedColumnForModelField()

◆ highlightSelectedNets()

◆ netFilterMatches()

◆ onAddGroup()

◆ onAddNet()

◆ OnBoardChanged()

◆ OnBoardCompositeUpdate()

◆ OnBoardHighlightNetChanged()

◆ OnBoardItemAdded()

◆ OnBoardItemChanged()

◆ OnBoardItemRemoved()

◆ OnBoardItemsAdded()

◆ OnBoardItemsChanged()

◆ OnBoardItemsRemoved()

◆ OnBoardNetSettingsChanged()

◆ OnBoardRatsnestChanged()

◆ onClearHighlighting()

◆ OnColumnSorted()

◆ OnConfigButton()

◆ onContextMenuSelection()

◆ onDeleteSelectedNet()

◆ OnExpandCollapseRow()

◆ OnHeaderContextMenu()

◆ onItemContextMenu()

◆ OnLanguageChanged()

◆ OnLanguageChangedImpl()

◆ OnNetsListContextMenu()

◆ OnNetsListItemActivated()

◆ OnParentSetupChanged()

◆ onRemoveSelectedGroup()

◆ onRenameSelectedNet()

◆ OnSearchTextChanged()

◆ OnSetFocus()

◆ OnShowPanel()

◆ OnSize()

◆ onUnitsChanged()

◆ relevantConnectivityItems()

◆ restoreSortColumn()

◆ SaveSettings()

◆ setColumnWidths()

◆ updateBoardItems()

◆ updateDisplayedRowValues()

◆ updateNets()

Member Data Documentation

◆ DATA_MODEL

◆ m_board

◆ m_boardLoaded

◆ m_boardLoading

◆ m_columns