KiCad PCB EDA Suite
Loading...
Searching...
No Matches
PCB_NET_INSPECTOR_PANEL::LIST_ITEM Class Reference

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

#include <pcb_net_inspector_panel_data_model.h>

Public Types

enum class  GROUP_TYPE { NONE , USER_DEFINED , NETCLASS }
 

Public Member Functions

 LIST_ITEM (unsigned int aGroupNumber, const wxString &aGroupName, GROUP_TYPE aGroupType)
 
 LIST_ITEM (NETINFO_ITEM *aNet)
 
 LIST_ITEM ()
 
LIST_ITEMoperator= (const LIST_ITEM &)=delete
 
bool GetIsGroup () const
 
const wxString & GetGroupName () const
 
GROUP_TYPE GetGroupType () const
 
int GetGroupNumber () const
 
auto ChildrenBegin () const
 
auto ChildrenEnd () const
 
unsigned int ChildrenCount () const
 
void SetLayerCount (unsigned int aValue)
 
NETINFO_ITEMGetNet () const
 
int GetNetCode () const
 
const wxString & GetNetName () const
 
const wxString & GetNetclassName () const
 
void ResetColumnChangedBits ()
 
unsigned int GetPadCount () const
 
bool PadCountChanged () const
 
void SetPadCount (unsigned int aValue)
 
void AddPadCount (unsigned int aValue)
 
void SubPadCount (unsigned int aValue)
 
unsigned GetViaCount () const
 
bool ViaCountChanged () const
 
void SetViaCount (unsigned int aValue)
 
void AddViaCount (unsigned int aValue)
 
void SubViaCount (unsigned int aValue)
 
uint64_t GetViaLength () const
 
bool ViaLengthChanged () const
 
void SetViaLength (unsigned int aValue)
 
void AddViaLength (unsigned int aValue)
 
void SubViaLength (uint64_t aValue)
 
uint64_t GetBoardWireLength () const
 
uint64_t GetLayerWireLength (PCB_LAYER_ID aLayer) const
 
bool BoardWireLengthChanged () const
 
void SetLayerWireLength (const uint64_t aValue, PCB_LAYER_ID aLayer)
 
std::map< PCB_LAYER_ID, uint64_t > GetLayerWireLength () const
 
void SetLayerWireLength (const std::map< PCB_LAYER_ID, uint64_t > &aValue)
 
void AddLayerWireLength (const uint64_t aValue, PCB_LAYER_ID aLayer)
 
void SubLayerWireLength (const uint64_t aValue, PCB_LAYER_ID aLayer)
 
uint64_t GetPadDieLength () const
 
bool PadDieLengthChanged () const
 
void SetPadDieLength (uint64_t aValue)
 
void AddPadDieLength (uint64_t aValue)
 
void SubPadDieLength (uint64_t aValue)
 
unsigned long long int GetTotalLength () const
 
bool TotalLengthChanged () const
 
LIST_ITEMParent () const
 
void SetParent (LIST_ITEM *aParent)
 

Private Attributes

LIST_ITEMm_parent = nullptr
 
std::vector< LIST_ITEM * > m_children
 
GROUP_TYPE m_group_type = GROUP_TYPE::NONE
 
unsigned int m_group_number = 0
 
NETINFO_ITEMm_net = nullptr
 
unsigned int m_pad_count = 0
 
unsigned int m_via_count = 0
 
uint64_t m_via_length = 0
 
uint64_t m_pad_die_length = 0
 
std::map< PCB_LAYER_ID, uint64_t > m_layer_wire_length {}
 
std::vector< int > m_column_changed
 
wxString m_net_name
 
wxString m_net_class
 
wxString m_group_name
 

Detailed Description

Primary data item for entries in the Net Inspector list.

This class tracks all data for a given net entry in the net inspector list.

Definition at line 31 of file pcb_net_inspector_panel_data_model.h.

Member Enumeration Documentation

◆ GROUP_TYPE

Enumerator
NONE 
USER_DEFINED 
NETCLASS 

Definition at line 34 of file pcb_net_inspector_panel_data_model.h.

Constructor & Destructor Documentation

◆ LIST_ITEM() [1/3]

PCB_NET_INSPECTOR_PANEL::LIST_ITEM::LIST_ITEM ( unsigned int  aGroupNumber,
const wxString &  aGroupName,
GROUP_TYPE  aGroupType 
)
inline

◆ LIST_ITEM() [2/3]

◆ LIST_ITEM() [3/3]

PCB_NET_INSPECTOR_PANEL::LIST_ITEM::LIST_ITEM ( )
inline

Member Function Documentation

◆ AddLayerWireLength()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::AddLayerWireLength ( const uint64_t  aValue,
PCB_LAYER_ID  aLayer 
)
inline

◆ AddPadCount()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::AddPadCount ( unsigned int  aValue)
inline

◆ AddPadDieLength()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::AddPadDieLength ( uint64_t  aValue)
inline

◆ AddViaCount()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::AddViaCount ( unsigned int  aValue)
inline

◆ AddViaLength()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::AddViaLength ( unsigned int  aValue)
inline

◆ BoardWireLengthChanged()

bool PCB_NET_INSPECTOR_PANEL::LIST_ITEM::BoardWireLengthChanged ( ) const
inline

◆ ChildrenBegin()

auto PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ChildrenBegin ( ) const
inline

◆ ChildrenCount()

unsigned int PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ChildrenCount ( ) const
inline

◆ ChildrenEnd()

auto PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ChildrenEnd ( ) const
inline

◆ GetBoardWireLength()

uint64_t PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetBoardWireLength ( ) const
inline

◆ GetGroupName()

const wxString & PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetGroupName ( ) const
inline

◆ GetGroupNumber()

int PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetGroupNumber ( ) const
inline

Definition at line 67 of file pcb_net_inspector_panel_data_model.h.

References m_group_number.

◆ GetGroupType()

GROUP_TYPE PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetGroupType ( ) const
inline

Definition at line 66 of file pcb_net_inspector_panel_data_model.h.

References m_group_type.

◆ GetIsGroup()

◆ GetLayerWireLength() [1/2]

std::map< PCB_LAYER_ID, uint64_t > PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetLayerWireLength ( ) const
inline

Definition at line 222 of file pcb_net_inspector_panel_data_model.h.

References m_layer_wire_length.

◆ GetLayerWireLength() [2/2]

uint64_t PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetLayerWireLength ( PCB_LAYER_ID  aLayer) const
inline

◆ GetNet()

NETINFO_ITEM * PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetNet ( ) const
inline

Definition at line 78 of file pcb_net_inspector_panel_data_model.h.

References m_net.

Referenced by PCB_NET_INSPECTOR_PANEL::onRenameSelectedNet().

◆ GetNetclassName()

const wxString & PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetNetclassName ( ) const
inline

Definition at line 86 of file pcb_net_inspector_panel_data_model.h.

References m_net_class.

◆ GetNetCode()

int PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetNetCode ( ) const
inline

◆ GetNetName()

const wxString & PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetNetName ( ) const
inline

◆ GetPadCount()

unsigned int PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetPadCount ( ) const
inline

◆ GetPadDieLength()

uint64_t PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetPadDieLength ( ) const
inline

◆ GetTotalLength()

unsigned long long int PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetTotalLength ( ) const
inline

◆ GetViaCount()

unsigned PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetViaCount ( ) const
inline

◆ GetViaLength()

uint64_t PCB_NET_INSPECTOR_PANEL::LIST_ITEM::GetViaLength ( ) const
inline

◆ operator=()

LIST_ITEM & PCB_NET_INSPECTOR_PANEL::LIST_ITEM::operator= ( const LIST_ITEM )
delete

◆ PadCountChanged()

bool PCB_NET_INSPECTOR_PANEL::LIST_ITEM::PadCountChanged ( ) const
inline

◆ PadDieLengthChanged()

bool PCB_NET_INSPECTOR_PANEL::LIST_ITEM::PadDieLengthChanged ( ) const
inline

◆ Parent()

◆ ResetColumnChangedBits()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ResetColumnChangedBits ( )
inline

Definition at line 88 of file pcb_net_inspector_panel_data_model.h.

References m_column_changed.

◆ SetLayerCount()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SetLayerCount ( unsigned int  aValue)
inline

◆ SetLayerWireLength() [1/2]

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SetLayerWireLength ( const std::map< PCB_LAYER_ID, uint64_t > &  aValue)
inline

Definition at line 224 of file pcb_net_inspector_panel_data_model.h.

References m_layer_wire_length.

◆ SetLayerWireLength() [2/2]

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SetLayerWireLength ( const uint64_t  aValue,
PCB_LAYER_ID  aLayer 
)
inline

◆ SetPadCount()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SetPadCount ( unsigned int  aValue)
inline

◆ SetPadDieLength()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SetPadDieLength ( uint64_t  aValue)
inline

◆ SetParent()

◆ SetViaCount()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SetViaCount ( unsigned int  aValue)
inline

◆ SetViaLength()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SetViaLength ( unsigned int  aValue)
inline

◆ SubLayerWireLength()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SubLayerWireLength ( const uint64_t  aValue,
PCB_LAYER_ID  aLayer 
)
inline

◆ SubPadCount()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SubPadCount ( unsigned int  aValue)
inline

◆ SubPadDieLength()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SubPadDieLength ( uint64_t  aValue)
inline

◆ SubViaCount()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SubViaCount ( unsigned int  aValue)
inline

◆ SubViaLength()

void PCB_NET_INSPECTOR_PANEL::LIST_ITEM::SubViaLength ( uint64_t  aValue)
inline

◆ TotalLengthChanged()

bool PCB_NET_INSPECTOR_PANEL::LIST_ITEM::TotalLengthChanged ( ) const
inline

◆ ViaCountChanged()

bool PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ViaCountChanged ( ) const
inline

◆ ViaLengthChanged()

bool PCB_NET_INSPECTOR_PANEL::LIST_ITEM::ViaLengthChanged ( ) const
inline

Member Data Documentation

◆ m_children

std::vector<LIST_ITEM*> PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_children
private

◆ m_column_changed

◆ m_group_name

wxString PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_group_name
private

Definition at line 351 of file pcb_net_inspector_panel_data_model.h.

Referenced by GetGroupName(), and LIST_ITEM().

◆ m_group_number

unsigned int PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_group_number = 0
private

Definition at line 333 of file pcb_net_inspector_panel_data_model.h.

Referenced by GetGroupNumber(), and GetNetCode().

◆ m_group_type

GROUP_TYPE PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_group_type = GROUP_TYPE::NONE
private

Definition at line 332 of file pcb_net_inspector_panel_data_model.h.

Referenced by GetGroupType(), and GetIsGroup().

◆ m_layer_wire_length

std::map<PCB_LAYER_ID, uint64_t> PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_layer_wire_length {}
private

◆ m_net

NETINFO_ITEM* PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_net = nullptr
private

Definition at line 334 of file pcb_net_inspector_panel_data_model.h.

Referenced by GetNet(), and GetNetCode().

◆ m_net_class

wxString PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_net_class
private

Definition at line 350 of file pcb_net_inspector_panel_data_model.h.

Referenced by GetNetclassName(), and LIST_ITEM().

◆ m_net_name

wxString PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_net_name
private

Definition at line 349 of file pcb_net_inspector_panel_data_model.h.

Referenced by GetNetName(), and LIST_ITEM().

◆ m_pad_count

unsigned int PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_pad_count = 0
private

◆ m_pad_die_length

uint64_t PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_pad_die_length = 0
private

◆ m_parent

◆ m_via_count

unsigned int PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_via_count = 0
private

◆ m_via_length

uint64_t PCB_NET_INSPECTOR_PANEL::LIST_ITEM::m_via_length = 0
private

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