PCB_NET_INSPECTOR_PANEL::DATA_MODEL Class Reference

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

#include <pcb_net_inspector_panel_data_model.h>

Inheritance diagram for PCB_NET_INSPECTOR_PANEL::DATA_MODEL:

Public Member Functions
	DATA_MODEL (PCB_NET_INSPECTOR_PANEL &parent)
unsigned int	columnCount () const
unsigned int	itemCount () const
wxVariant	valueAt (unsigned int aCol, unsigned int aRow) const
const LIST_ITEM &	itemAt (unsigned int aRow) const
std::vector< std::pair< wxString, wxDataViewItem > >	getGroupDataViewItems ()
std::optional< LIST_ITEM_ITER >	findItem (int aNetCode)
std::optional< LIST_ITEM_ITER >	findItem (NETINFO_ITEM *aNet)
std::optional< LIST_ITEM_ITER >	findGroupItem (int aGroupNumber)
LIST_ITEM_ITER	addGroup (LIST_ITEM_ITER groupsBegin, LIST_ITEM_ITER groupsEnd, wxString groupName, LIST_ITEM::GROUP_TYPE groupType)
std::optional< LIST_ITEM_ITER >	addItem (std::unique_ptr< LIST_ITEM > aItem)
void	addItems (std::vector< std::unique_ptr< LIST_ITEM > > aItems)
std::unique_ptr< LIST_ITEM >	deleteItem (const std::optional< LIST_ITEM_ITER > &aRow)
void	addCustomGroups ()
	Adds all custom group-by entries to the items table.
void	deleteAllItems ()
void	updateItem (const std::optional< LIST_ITEM_ITER > &aRow)
void	updateAllItems ()
void	resortIfChanged (LIST_ITEM *aItem)
bool	itemColumnChanged (const LIST_ITEM *aItem, unsigned int aCol) const

Protected Member Functions
unsigned int	GetColumnCount () const override
void	GetValue (wxVariant &aOutValue, const wxDataViewItem &aItem, unsigned int aCol) const override
int	Compare (const wxDataViewItem &aItem1, const wxDataViewItem &aItem2, unsigned int aCol, bool aAsc) const override
bool	SetValue (const wxVariant &aInValue, const wxDataViewItem &aItem, unsigned int aCol) override
wxDataViewItem	GetParent (const wxDataViewItem &aItem) const override
bool	IsContainer (const wxDataViewItem &aItem) const override
bool	HasContainerColumns (const wxDataViewItem &aItem) const override
unsigned int	GetChildren (const wxDataViewItem &aParent, wxDataViewItemArray &aChildren) const override
wxString	GetColumnType (unsigned int) const override

Static Protected Member Functions
static int	compareUInt (uint64_t aValue1, uint64_t aValue2, bool aAsc)

Private Attributes
PCB_NET_INSPECTOR_PANEL &	m_parent
std::vector< std::unique_ptr< LIST_ITEM > >	m_items
std::map< wxString, LIST_ITEM * >	m_custom_group_map
	Map of custom group names to their representative list item.

Detailed Description

Data model for display in the Net Inspector panel.

Definition at line 378 of file pcb_net_inspector_panel_data_model.h.

Constructor & Destructor Documentation

DATA_MODEL()

PCB_NET_INSPECTOR_PANEL::DATA_MODEL::DATA_MODEL ( PCB_NET_INSPECTOR_PANEL &  parent )

inline

Definition at line 381 of file pcb_net_inspector_panel_data_model.h.

Member Function Documentation

addCustomGroups()

void PCB_NET_INSPECTOR_PANEL::DATA_MODEL::addCustomGroups ( )

inline

Adds all custom group-by entries to the items table.

Note this assumes that m_items is empty prior to adding these groups

Definition at line 571 of file pcb_net_inspector_panel_data_model.h.

References group, m_custom_group_map, PCB_NET_INSPECTOR_PANEL::m_custom_group_rules, m_items, m_parent, and PCB_NET_INSPECTOR_PANEL::LIST_ITEM::USER_DEFINED.

addGroup()

LIST_ITEM_ITER PCB_NET_INSPECTOR_PANEL::DATA_MODEL::addGroup ( LIST_ITEM_ITER  groupsBegin, LIST_ITEM_ITER  groupsEnd, wxString  groupName, LIST_ITEM::GROUP_TYPE  groupType  )

inline

Definition at line 444 of file pcb_net_inspector_panel_data_model.h.

References group, and m_items.

Referenced by addItem().

addItem()

std::optional< LIST_ITEM_ITER > PCB_NET_INSPECTOR_PANEL::DATA_MODEL::addItem ( std::unique_ptr< LIST_ITEM >  aItem )

inline

Definition at line 467 of file pcb_net_inspector_panel_data_model.h.

References addGroup(), group, m_custom_group_map, PCB_NET_INSPECTOR_PANEL::m_custom_group_rules, PCB_NET_INSPECTOR_PANEL::m_group_by_netclass, m_items, m_parent, and PCB_NET_INSPECTOR_PANEL::LIST_ITEM::NETCLASS.

Referenced by addItems().

addItems()

void PCB_NET_INSPECTOR_PANEL::DATA_MODEL::addItems ( std::vector< std::unique_ptr< LIST_ITEM > >  aItems )

inline

Definition at line 521 of file pcb_net_inspector_panel_data_model.h.

References addItem(), and m_items.

columnCount()

unsigned int PCB_NET_INSPECTOR_PANEL::DATA_MODEL::columnCount ( ) const

inline

Definition at line 383 of file pcb_net_inspector_panel_data_model.h.

References PCB_NET_INSPECTOR_PANEL::m_columns, and m_parent.

Referenced by GetColumnCount().

Compare()

int PCB_NET_INSPECTOR_PANEL::DATA_MODEL::Compare ( const wxDataViewItem &  aItem1, const wxDataViewItem &  aItem2, unsigned int  aCol, bool  aAsc  ) const

inlineoverrideprotected

Definition at line 733 of file pcb_net_inspector_panel_data_model.h.

References PCB_NET_INSPECTOR_PANEL::COLUMN_BOARD_LENGTH, PCB_NET_INSPECTOR_PANEL::COLUMN_LAST_STATIC_COL, PCB_NET_INSPECTOR_PANEL::COLUMN_NAME, PCB_NET_INSPECTOR_PANEL::COLUMN_PAD_COUNT, PCB_NET_INSPECTOR_PANEL::COLUMN_PAD_DIE_LENGTH, PCB_NET_INSPECTOR_PANEL::COLUMN_TOTAL_LENGTH, PCB_NET_INSPECTOR_PANEL::COLUMN_VIA_COUNT, PCB_NET_INSPECTOR_PANEL::COLUMN_VIA_LENGTH, compareUInt(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetBoardWireLength(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetIsGroup(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetLayerWireLength(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetNetName(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetPadCount(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetPadDieLength(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetTotalLength(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetViaCount(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetViaLength(), PCB_NET_INSPECTOR_PANEL::m_columns, m_parent, res, and ValueStringCompare().

compareUInt()

static int PCB_NET_INSPECTOR_PANEL::DATA_MODEL::compareUInt ( uint64_t  aValue1, uint64_t  aValue2, bool  aAsc  )

inlinestaticprotected

Definition at line 725 of file pcb_net_inspector_panel_data_model.h.

Referenced by Compare().

deleteAllItems()

void PCB_NET_INSPECTOR_PANEL::DATA_MODEL::deleteAllItems ( )

inline

Definition at line 587 of file pcb_net_inspector_panel_data_model.h.

References m_items.

deleteItem()

std::unique_ptr< LIST_ITEM > PCB_NET_INSPECTOR_PANEL::DATA_MODEL::deleteItem ( const std::optional< LIST_ITEM_ITER > &  aRow )

inline

Definition at line 529 of file pcb_net_inspector_panel_data_model.h.

References PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ChildrenCount(), PCB_NET_INSPECTOR_PANEL::m_group_by_netclass, m_items, m_parent, PCB_NET_INSPECTOR_PANEL::LIST_ITEM::Parent(), and PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SetParent().

findGroupItem()

std::optional< LIST_ITEM_ITER > PCB_NET_INSPECTOR_PANEL::DATA_MODEL::findGroupItem ( int  aGroupNumber )

inline

Definition at line 432 of file pcb_net_inspector_panel_data_model.h.

References m_items.

findItem() [1/2]

std::optional< LIST_ITEM_ITER > PCB_NET_INSPECTOR_PANEL::DATA_MODEL::findItem ( int  aNetCode )

inline

Definition at line 411 of file pcb_net_inspector_panel_data_model.h.

References m_items.

Referenced by findItem().

findItem() [2/2]

std::optional< LIST_ITEM_ITER > PCB_NET_INSPECTOR_PANEL::DATA_MODEL::findItem ( NETINFO_ITEM *  aNet )

inline

Definition at line 423 of file pcb_net_inspector_panel_data_model.h.

References findItem(), and NETINFO_ITEM::GetNetCode().

GetChildren()

unsigned int PCB_NET_INSPECTOR_PANEL::DATA_MODEL::GetChildren ( const wxDataViewItem &  aParent, wxDataViewItemArray &  aChildren  ) const

inlineoverrideprotected

Definition at line 816 of file pcb_net_inspector_panel_data_model.h.

References PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ChildrenBegin(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ChildrenCount(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ChildrenEnd(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetIsGroup(), and m_items.

GetColumnCount()

unsigned int PCB_NET_INSPECTOR_PANEL::DATA_MODEL::GetColumnCount ( ) const

inlineoverrideprotected

Definition at line 667 of file pcb_net_inspector_panel_data_model.h.

References columnCount().

GetColumnType()

wxString PCB_NET_INSPECTOR_PANEL::DATA_MODEL::GetColumnType ( unsigned int  ) const

inlineoverrideprotected

Definition at line 851 of file pcb_net_inspector_panel_data_model.h.

getGroupDataViewItems()

std::vector< std::pair< wxString, wxDataViewItem > > PCB_NET_INSPECTOR_PANEL::DATA_MODEL::getGroupDataViewItems ( )

inline

Definition at line 396 of file pcb_net_inspector_panel_data_model.h.

References m_items.

GetParent()

wxDataViewItem PCB_NET_INSPECTOR_PANEL::DATA_MODEL::GetParent ( const wxDataViewItem &  aItem ) const

inlineoverrideprotected

Definition at line 795 of file pcb_net_inspector_panel_data_model.h.

References PCB_NET_INSPECTOR_PANEL::LIST_ITEM::Parent().

GetValue()

void PCB_NET_INSPECTOR_PANEL::DATA_MODEL::GetValue ( wxVariant &  aOutValue, const wxDataViewItem &  aItem, unsigned int  aCol  ) const

inlineoverrideprotected

Definition at line 669 of file pcb_net_inspector_panel_data_model.h.

References _, PCB_NET_INSPECTOR_PANEL::COLUMN_BOARD_LENGTH, PCB_NET_INSPECTOR_PANEL::COLUMN_LAST_STATIC_COL, PCB_NET_INSPECTOR_PANEL::COLUMN_NAME, PCB_NET_INSPECTOR_PANEL::COLUMN_NETCLASS, PCB_NET_INSPECTOR_PANEL::COLUMN_PAD_COUNT, PCB_NET_INSPECTOR_PANEL::COLUMN_PAD_DIE_LENGTH, PCB_NET_INSPECTOR_PANEL::COLUMN_TOTAL_LENGTH, PCB_NET_INSPECTOR_PANEL::COLUMN_VIA_COUNT, PCB_NET_INSPECTOR_PANEL::COLUMN_VIA_LENGTH, PCB_NET_INSPECTOR_PANEL::formatCount(), PCB_NET_INSPECTOR_PANEL::formatLength(), PCB_NET_INSPECTOR_PANEL::m_columns, m_parent, PCB_NET_INSPECTOR_PANEL::LIST_ITEM::NETCLASS, and PCB_NET_INSPECTOR_PANEL::LIST_ITEM::USER_DEFINED.

Referenced by valueAt().

HasContainerColumns()

bool PCB_NET_INSPECTOR_PANEL::DATA_MODEL::HasContainerColumns ( const wxDataViewItem &  aItem ) const

inlineoverrideprotected

Definition at line 811 of file pcb_net_inspector_panel_data_model.h.

References IsContainer().

IsContainer()

bool PCB_NET_INSPECTOR_PANEL::DATA_MODEL::IsContainer ( const wxDataViewItem &  aItem ) const

inlineoverrideprotected

Definition at line 803 of file pcb_net_inspector_panel_data_model.h.

Referenced by HasContainerColumns().

itemAt()

const LIST_ITEM & PCB_NET_INSPECTOR_PANEL::DATA_MODEL::itemAt ( unsigned int  aRow ) const

inline

Definition at line 394 of file pcb_net_inspector_panel_data_model.h.

References m_items.

itemColumnChanged()

bool PCB_NET_INSPECTOR_PANEL::DATA_MODEL::itemColumnChanged ( const LIST_ITEM *  aItem, unsigned int  aCol  ) const

inline

Definition at line 631 of file pcb_net_inspector_panel_data_model.h.

References PCB_NET_INSPECTOR_PANEL::LIST_ITEM::BoardWireLengthChanged(), PCB_NET_INSPECTOR_PANEL::COLUMN_BOARD_LENGTH, PCB_NET_INSPECTOR_PANEL::COLUMN_LAST_STATIC_COL, PCB_NET_INSPECTOR_PANEL::COLUMN_PAD_COUNT, PCB_NET_INSPECTOR_PANEL::COLUMN_PAD_DIE_LENGTH, PCB_NET_INSPECTOR_PANEL::COLUMN_TOTAL_LENGTH, PCB_NET_INSPECTOR_PANEL::COLUMN_VIA_COUNT, PCB_NET_INSPECTOR_PANEL::COLUMN_VIA_LENGTH, PCB_NET_INSPECTOR_PANEL::m_columns, m_parent, PCB_NET_INSPECTOR_PANEL::LIST_ITEM::PadCountChanged(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::PadDieLengthChanged(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::TotalLengthChanged(), PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ViaCountChanged(), and PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ViaLengthChanged().

Referenced by resortIfChanged().

itemCount()

unsigned int PCB_NET_INSPECTOR_PANEL::DATA_MODEL::itemCount ( ) const

inline

Definition at line 385 of file pcb_net_inspector_panel_data_model.h.

References m_items.

resortIfChanged()

void PCB_NET_INSPECTOR_PANEL::DATA_MODEL::resortIfChanged ( LIST_ITEM *  aItem )

inline

Definition at line 614 of file pcb_net_inspector_panel_data_model.h.

References itemColumnChanged(), NET_INSPECTOR_PANEL::m_netsList, m_parent, and PCB_NET_INSPECTOR_PANEL::LIST_ITEM::Parent().

Referenced by updateItem().

SetValue()

bool PCB_NET_INSPECTOR_PANEL::DATA_MODEL::SetValue ( const wxVariant &  aInValue, const wxDataViewItem &  aItem, unsigned int  aCol  )

inlineoverrideprotected

Definition at line 789 of file pcb_net_inspector_panel_data_model.h.

updateAllItems()

void PCB_NET_INSPECTOR_PANEL::DATA_MODEL::updateAllItems ( )

inline

Definition at line 608 of file pcb_net_inspector_panel_data_model.h.

References m_items.

updateItem()

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

inline

Definition at line 594 of file pcb_net_inspector_panel_data_model.h.

References resortIfChanged().

valueAt()

wxVariant PCB_NET_INSPECTOR_PANEL::DATA_MODEL::valueAt ( unsigned int  aCol, unsigned int  aRow  ) const

inline

Definition at line 387 of file pcb_net_inspector_panel_data_model.h.

References GetValue(), and m_items.

Member Data Documentation

m_custom_group_map

std::map<wxString, LIST_ITEM*> PCB_NET_INSPECTOR_PANEL::DATA_MODEL::m_custom_group_map

private

Map of custom group names to their representative list item.

Definition at line 862 of file pcb_net_inspector_panel_data_model.h.

Referenced by addCustomGroups(), and addItem().

m_items

std::vector<std::unique_ptr<LIST_ITEM> > PCB_NET_INSPECTOR_PANEL::DATA_MODEL::m_items

private

Definition at line 859 of file pcb_net_inspector_panel_data_model.h.

Referenced by addCustomGroups(), addGroup(), addItem(), addItems(), deleteAllItems(), deleteItem(), findGroupItem(), findItem(), GetChildren(), getGroupDataViewItems(), itemAt(), itemCount(), updateAllItems(), and valueAt().

m_parent

PCB_NET_INSPECTOR_PANEL& PCB_NET_INSPECTOR_PANEL::DATA_MODEL::m_parent

private

Definition at line 854 of file pcb_net_inspector_panel_data_model.h.

Referenced by addCustomGroups(), addItem(), columnCount(), Compare(), deleteItem(), GetValue(), itemColumnChanged(), and resortIfChanged().

---

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

• pcb_net_inspector_panel_data_model.h