KiCad PCB EDA Suite
LIB_TREE_NODE_UNIT Class Reference

Node type: unit of component. More...

#include <lib_tree_model.h>

Inheritance diagram for LIB_TREE_NODE_UNIT:
LIB_TREE_NODE

Public Types

enum  TYPE {
  ROOT, LIB, LIBID, UNIT,
  INVALID
}
 
typedef std::vector< std::unique_ptr< LIB_TREE_NODE > > PTR_VECTOR
 

Public Member Functions

 LIB_TREE_NODE_UNIT (LIB_TREE_NODE_UNIT const &_)=delete
 The addresses of CMP_TREE_NODEs are used as unique IDs for the wxDataViewModel, so don't let them be copied around. More...
 
void operator= (LIB_TREE_NODE_UNIT const &_)=delete
 
 LIB_TREE_NODE_UNIT (LIB_TREE_NODE *aParent, LIB_TREE_ITEM *aItem, int aUnit)
 Construct a unit node. More...
 
virtual void UpdateScore (EDA_COMBINED_MATCHER &aMatcher) override
 Do nothing, units just take the parent's score. More...
 
void ResetScore ()
 Initialize score to kLowestDefaultScore, recursively. More...
 
void AssignIntrinsicRanks (bool presorted=false)
 Store intrinsic ranks on all children of this node. More...
 
void SortNodes ()
 Sort child nodes quickly and recursively (IntrinsicRanks must have been set). More...
 

Static Public Member Functions

static int Compare (LIB_TREE_NODE const &aNode1, LIB_TREE_NODE const &aNode2)
 Compare two nodes. More...
 

Public Attributes

LIB_TREE_NODEm_Parent
 
PTR_VECTOR m_Children
 
enum TYPE m_Type
 
int m_IntrinsicRank
 The rank of the item before any search terms are applied. More...
 
int m_Score
 
bool m_Pinned
 
wxString m_Name
 
wxString m_Desc
 
wxString m_MatchName
 
wxString m_SearchText
 
bool m_Normalized
 
LIB_ID m_LibId
 
int m_Unit
 
bool m_IsRoot
 

Detailed Description

Node type: unit of component.

Definition at line 147 of file lib_tree_model.h.

Member Typedef Documentation

◆ PTR_VECTOR

typedef std::vector<std::unique_ptr<LIB_TREE_NODE> > LIB_TREE_NODE::PTR_VECTOR
inherited

Definition at line 82 of file lib_tree_model.h.

Member Enumeration Documentation

◆ TYPE

enum LIB_TREE_NODE::TYPE
inherited
Enumerator
ROOT 
LIB 
LIBID 
UNIT 
INVALID 

Definition at line 78 of file lib_tree_model.h.

Constructor & Destructor Documentation

◆ LIB_TREE_NODE_UNIT() [1/2]

LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT ( LIB_TREE_NODE_UNIT const &  _)
delete

The addresses of CMP_TREE_NODEs are used as unique IDs for the wxDataViewModel, so don't let them be copied around.

◆ LIB_TREE_NODE_UNIT() [2/2]

LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT ( LIB_TREE_NODE aParent,
LIB_TREE_ITEM aItem,
int  aUnit 
)

Construct a unit node.

The name of the unit will be "Unit %s", where s is aUnit formatted by LIB_PART::SubReference.

Parameters
aParentparent node, should be a CMP_TREE_NODE_ALIAS
aItemparent item
aUnitunit number

Definition at line 130 of file lib_tree_model.cpp.

131 {
132  static void* locale = nullptr;
133  static wxString namePrefix;
134 
135  // Fetching translations can take a surprising amount of time when loading libraries,
136  // so only do it when necessary.
137  if( Pgm().GetLocale() != locale )
138  {
139  namePrefix = _( "Unit" );
140  locale = Pgm().GetLocale();
141  }
142 
143  m_Parent = aParent;
144  m_Type = UNIT;
145 
146  m_Unit = aUnit;
147  m_LibId = aParent->m_LibId;
148 
149  m_Name = namePrefix + " " + aItem->GetUnitReference( aUnit );
150  m_Desc = wxEmptyString;
151  m_MatchName = wxEmptyString;
152 
153  m_IntrinsicRank = -aUnit;
154 }
int m_IntrinsicRank
The rank of the item before any search terms are applied.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
LIB_TREE_NODE * m_Parent
#define _(s)
Definition: 3d_actions.cpp:33
enum TYPE m_Type
wxString m_Name
wxString m_Desc
virtual wxString GetUnitReference(int aUnit)
For items with units, return an identifier for unit x.
Definition: lib_tree_item.h:68
wxString m_MatchName

References _, LIB_TREE_ITEM::GetUnitReference(), LIB_TREE_NODE::m_Desc, LIB_TREE_NODE::m_IntrinsicRank, LIB_TREE_NODE::m_LibId, LIB_TREE_NODE::m_MatchName, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_Parent, LIB_TREE_NODE::m_Type, LIB_TREE_NODE::m_Unit, Pgm(), and LIB_TREE_NODE::UNIT.

Member Function Documentation

◆ AssignIntrinsicRanks()

void LIB_TREE_NODE::AssignIntrinsicRanks ( bool  presorted = false)
inherited

Store intrinsic ranks on all children of this node.

See m_IntrinsicRank member doc for more information.

Definition at line 62 of file lib_tree_model.cpp.

63 {
64  std::vector<LIB_TREE_NODE*> sort_buf;
65 
66  if( presorted )
67  {
68  int max = m_Children.size() - 1;
69 
70  for( int i = 0; i <= max; ++i )
71  m_Children[i]->m_IntrinsicRank = max - i;
72  }
73  else
74  {
75  for( auto const& node: m_Children )
76  sort_buf.push_back( &*node );
77 
78  std::sort( sort_buf.begin(), sort_buf.end(),
79  []( LIB_TREE_NODE* a, LIB_TREE_NODE* b ) -> bool
80  {
81  return StrNumCmp( a->m_Name, b->m_Name, true ) > 0;
82  } );
83 
84  for( int i = 0; i < (int) sort_buf.size(); ++i )
85  sort_buf[i]->m_IntrinsicRank = i;
86  }
87 }
int StrNumCmp(const wxString &aString1, const wxString &aString2, bool aIgnoreCase)
Compare two strings with alphanumerical content.
Definition: string.cpp:409
int m_IntrinsicRank
The rank of the item before any search terms are applied.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
wxString m_Name
PTR_VECTOR m_Children

References LIB_TREE_NODE::m_Children, LIB_TREE_NODE::m_IntrinsicRank, LIB_TREE_NODE::m_Name, and StrNumCmp().

Referenced by FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), LIB_TREE_MODEL_ADAPTER::AssignIntrinsicRanks(), LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

◆ Compare()

int LIB_TREE_NODE::Compare ( LIB_TREE_NODE const &  aNode1,
LIB_TREE_NODE const &  aNode2 
)
staticinherited

Compare two nodes.

Returns negative if aNode1 < aNode2, zero if aNode1 == aNode2, or positive if aNode1 > aNode2.

Definition at line 103 of file lib_tree_model.cpp.

104 {
105  if( aNode1.m_Type != aNode2.m_Type )
106  return 0;
107 
108  if( aNode1.m_Score != aNode2.m_Score )
109  return aNode1.m_Score - aNode2.m_Score;
110 
111  if( aNode1.m_Parent != aNode2.m_Parent )
112  return 0;
113 
114  return aNode1.m_IntrinsicRank - aNode2.m_IntrinsicRank;
115 }

References LIB_TREE_NODE::m_IntrinsicRank, LIB_TREE_NODE::m_Parent, LIB_TREE_NODE::m_Score, and LIB_TREE_NODE::m_Type.

Referenced by LIB_TREE_NODE::SortNodes().

◆ operator=()

void LIB_TREE_NODE_UNIT::operator= ( LIB_TREE_NODE_UNIT const &  _)
delete

◆ ResetScore()

void LIB_TREE_NODE::ResetScore ( )
inherited

Initialize score to kLowestDefaultScore, recursively.

Definition at line 53 of file lib_tree_model.cpp.

54 {
55  for( auto& child: m_Children )
56  child->ResetScore();
57 
59 }
static const unsigned kLowestDefaultScore
PTR_VECTOR m_Children

References kLowestDefaultScore, LIB_TREE_NODE::m_Children, and LIB_TREE_NODE::m_Score.

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ SortNodes()

void LIB_TREE_NODE::SortNodes ( )
inherited

Sort child nodes quickly and recursively (IntrinsicRanks must have been set).

Definition at line 90 of file lib_tree_model.cpp.

91 {
92  std::sort( m_Children.begin(), m_Children.end(),
93  []( std::unique_ptr<LIB_TREE_NODE>& a, std::unique_ptr<LIB_TREE_NODE>& b )
94  {
95  return Compare( *a, *b ) > 0;
96  } );
97 
98  for( std::unique_ptr<LIB_TREE_NODE>& node: m_Children )
99  node->SortNodes();
100 }
static int Compare(LIB_TREE_NODE const &aNode1, LIB_TREE_NODE const &aNode2)
Compare two nodes.
PTR_VECTOR m_Children

References LIB_TREE_NODE::Compare(), and LIB_TREE_NODE::m_Children.

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ UpdateScore()

virtual void LIB_TREE_NODE_UNIT::UpdateScore ( EDA_COMBINED_MATCHER aMatcher)
inlineoverridevirtual

Do nothing, units just take the parent's score.

Implements LIB_TREE_NODE.

Definition at line 175 of file lib_tree_model.h.

175 {}

Member Data Documentation

◆ m_Children

◆ m_Desc

◆ m_IntrinsicRank

int LIB_TREE_NODE::m_IntrinsicRank
inherited

The rank of the item before any search terms are applied.

This is a fairly expensive sort (involving string compares) so it helps to store the result of that sort.

Definition at line 93 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE::AssignIntrinsicRanks(), LIB_TREE_NODE::Compare(), and LIB_TREE_NODE_UNIT().

◆ m_IsRoot

◆ m_LibId

◆ m_MatchName

◆ m_Name

◆ m_Normalized

bool LIB_TREE_NODE::m_Normalized
inherited

◆ m_Parent

◆ m_Pinned

◆ m_Score

◆ m_SearchText

wxString LIB_TREE_NODE::m_SearchText
inherited

◆ m_Type

◆ m_Unit

int LIB_TREE_NODE::m_Unit
inherited

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