KiCad PCB EDA Suite
CMP_TREE_NODE_LIB Class Reference

Node type: library. More...

#include <cmp_tree_model.h>

Inheritance diagram for CMP_TREE_NODE_LIB:
CMP_TREE_NODE

Public Types

enum  TYPE {
  ROOT, LIB, ALIAS, UNIT,
  INVALID
}
 

Public Member Functions

 CMP_TREE_NODE_LIB (CMP_TREE_NODE_LIB 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= (CMP_TREE_NODE_LIB const &_)=delete
 
 CMP_TREE_NODE_LIB (CMP_TREE_NODE *aParent, wxString const &aName)
 Construct an empty library node. More...
 
CMP_TREE_NODE_ALIASAddAlias (LIB_ALIAS *aAlias)
 Construct a new alias node, add it to this library, and return it. More...
 
virtual void UpdateScore (EDA_COMBINED_MATCHER &aMatcher) override
 Update the score for this part. More...
 
void ResetScore ()
 Initialize score to kLowestDefaultScore, recursively. More...
 
void AssignIntrinsicRanks ()
 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 (CMP_TREE_NODE const &aNode1, CMP_TREE_NODE const &aNode2)
 Compare two nodes. More...
 

Public Attributes

CMP_TREE_NODEParent
 Parent node or null. More...
 
std::vector< std::unique_ptr< CMP_TREE_NODE > > Children
 List of child nodes. More...
 
enum TYPE Type
 Node type. More...
 
int IntrinsicRank
 The rank of the item before any search terms are applied. More...
 
int Score
 The score of an item resulting from the search algorithm. More...
 
wxString Name
 Actual name of the part. More...
 
wxString Desc
 Description to be displayed. More...
 
wxString MatchName
 Normalized name for matching. More...
 
wxString SearchText
 Descriptive text to search. More...
 
LIB_ALIASAlias
 Actual LIB_ALIAS*, or null. More...
 
int Unit
 Actual unit, or zero. More...
 

Detailed Description

Node type: library.

Definition at line 219 of file cmp_tree_model.h.

Member Enumeration Documentation

enum CMP_TREE_NODE::TYPE
inherited
Enumerator
ROOT 
LIB 
ALIAS 
UNIT 
INVALID 

Definition at line 78 of file cmp_tree_model.h.

Constructor & Destructor Documentation

CMP_TREE_NODE_LIB::CMP_TREE_NODE_LIB ( CMP_TREE_NODE_LIB const &  _)
delete

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

CMP_TREE_NODE_LIB::CMP_TREE_NODE_LIB ( CMP_TREE_NODE aParent,
wxString const &  aName 
)

Construct an empty library node.

Parameters
aParentparent node, should be a CMP_TREE_NODE_ROOT
aNamedisplay name of the library

Definition at line 229 of file cmp_tree_model.cpp.

References CMP_TREE_NODE::LIB, CMP_TREE_NODE::MatchName, CMP_TREE_NODE::Name, CMP_TREE_NODE::Parent, and CMP_TREE_NODE::Type.

230 {
231  Type = LIB;
232  Name = aName;
233  MatchName = aName.Lower();
234  Parent = aParent;
235 }
wxString Name
Actual name of the part.
enum TYPE Type
Node type.
wxString MatchName
Normalized name for matching.
CMP_TREE_NODE * Parent
Parent node or null.

Member Function Documentation

CMP_TREE_NODE_ALIAS & CMP_TREE_NODE_LIB::AddAlias ( LIB_ALIAS aAlias)

Construct a new alias node, add it to this library, and return it.

Parameters
aAliasLIB_ALIAS to provide data

Definition at line 238 of file cmp_tree_model.cpp.

References CMP_TREE_NODE::Children.

Referenced by CMP_TREE_MODEL_ADAPTER::AddAliasList().

239 {
240  CMP_TREE_NODE_ALIAS* alias = new CMP_TREE_NODE_ALIAS( this, aAlias );
241  Children.push_back( std::unique_ptr<CMP_TREE_NODE>( alias ) );
242  return *alias;
243 }
Node type: alias.
std::vector< std::unique_ptr< CMP_TREE_NODE > > Children
List of child nodes.
void CMP_TREE_NODE::AssignIntrinsicRanks ( )
inherited

Store intrinsic ranks on all children of this node.

See IntrinsicRank member doc for more information.

Definition at line 61 of file cmp_tree_model.cpp.

References CMP_TREE_NODE::Children, CMP_TREE_NODE::IntrinsicRank, and CMP_TREE_NODE::MatchName.

Referenced by CMP_TREE_MODEL_ADAPTER::AddAliasList(), and CMP_TREE_MODEL_ADAPTER::AddLibrary().

62 {
63  std::vector<CMP_TREE_NODE*> sort_buf;
64 
65  for( auto const& node: Children )
66  sort_buf.push_back( &*node );
67 
68  std::sort( sort_buf.begin(), sort_buf.end(),
69  []( CMP_TREE_NODE* a, CMP_TREE_NODE* b ) -> bool
70  { return a->MatchName > b->MatchName; } );
71 
72  for( int i = 0; i < (int) sort_buf.size(); ++i )
73  sort_buf[i]->IntrinsicRank = i;
74 }
wxString MatchName
Normalized name for matching.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
int IntrinsicRank
The rank of the item before any search terms are applied.
std::vector< std::unique_ptr< CMP_TREE_NODE > > Children
List of child nodes.
int CMP_TREE_NODE::Compare ( CMP_TREE_NODE const &  aNode1,
CMP_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 90 of file cmp_tree_model.cpp.

References CMP_TREE_NODE::IntrinsicRank, CMP_TREE_NODE::Parent, CMP_TREE_NODE::Score, and CMP_TREE_NODE::Type.

Referenced by CMP_TREE_NODE::SortNodes().

91 {
92  if( aNode1.Type != aNode2.Type )
93  return 0;
94 
95  if( aNode1.Score != aNode2.Score )
96  return aNode1.Score - aNode2.Score;
97 
98  if( aNode1.Parent != aNode2.Parent )
99  return 0;
100 
101  return aNode1.IntrinsicRank - aNode2.IntrinsicRank;
102 }
void CMP_TREE_NODE_LIB::operator= ( CMP_TREE_NODE_LIB const &  _)
delete
void CMP_TREE_NODE::ResetScore ( )
inherited

Initialize score to kLowestDefaultScore, recursively.

Definition at line 52 of file cmp_tree_model.cpp.

References CMP_TREE_NODE::Children, kLowestDefaultScore, and CMP_TREE_NODE::Score.

Referenced by CMP_TREE_MODEL_ADAPTER::UpdateSearchString().

53 {
54  for( auto& child: Children )
55  child->ResetScore();
56 
58 }
static const unsigned kLowestDefaultScore
std::vector< std::unique_ptr< CMP_TREE_NODE > > Children
List of child nodes.
int Score
The score of an item resulting from the search algorithm.
void CMP_TREE_NODE::SortNodes ( )
inherited

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

Definition at line 77 of file cmp_tree_model.cpp.

References CMP_TREE_NODE::Children, and CMP_TREE_NODE::Compare().

Referenced by CMP_TREE_MODEL_ADAPTER::UpdateSearchString().

78 {
79  std::sort( Children.begin(), Children.end(),
80  []( std::unique_ptr<CMP_TREE_NODE> const& a, std::unique_ptr<CMP_TREE_NODE> const& b )
81  { return Compare( *a, *b ) > 0; } );
82 
83  for( auto& node: Children )
84  {
85  node->SortNodes();
86  }
87 }
static int Compare(CMP_TREE_NODE const &aNode1, CMP_TREE_NODE const &aNode2)
Compare two nodes.
std::vector< std::unique_ptr< CMP_TREE_NODE > > Children
List of child nodes.
void CMP_TREE_NODE_LIB::UpdateScore ( EDA_COMBINED_MATCHER aMatcher)
overridevirtual

Update the score for this part.

This is accumulative - it will be called once per search term.

Parameters
aMatcheran EDA_COMBINED_MATCHER initialized with the search term

Implements CMP_TREE_NODE.

Definition at line 246 of file cmp_tree_model.cpp.

References CMP_TREE_NODE::Children, max, and CMP_TREE_NODE::Score.

247 {
248  Score = 0;
249 
250  for( auto& child: Children )
251  {
252  child->UpdateScore( aMatcher );
253  Score = std::max( Score, child->Score );
254  }
255 }
#define max(a, b)
Definition: auxiliary.h:86
std::vector< std::unique_ptr< CMP_TREE_NODE > > Children
List of child nodes.
int Score
The score of an item resulting from the search algorithm.

Member Data Documentation

LIB_ALIAS* CMP_TREE_NODE::Alias
inherited

Actual LIB_ALIAS*, or null.

Definition at line 101 of file cmp_tree_model.h.

Referenced by CMP_TREE_NODE_ALIAS::CMP_TREE_NODE_ALIAS(), and CMP_TREE_NODE_UNIT::CMP_TREE_NODE_UNIT().

wxString CMP_TREE_NODE::Desc
inherited
int CMP_TREE_NODE::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 91 of file cmp_tree_model.h.

Referenced by CMP_TREE_NODE::AssignIntrinsicRanks(), CMP_TREE_NODE_UNIT::CMP_TREE_NODE_UNIT(), and CMP_TREE_NODE::Compare().

wxString CMP_TREE_NODE::MatchName
inherited
int CMP_TREE_NODE::Score
inherited
wxString CMP_TREE_NODE::SearchText
inherited

Descriptive text to search.

Definition at line 99 of file cmp_tree_model.h.

Referenced by CMP_TREE_NODE_ALIAS::CMP_TREE_NODE_ALIAS(), and CMP_TREE_NODE_ALIAS::UpdateScore().

int CMP_TREE_NODE::Unit
inherited

Actual unit, or zero.

Definition at line 102 of file cmp_tree_model.h.

Referenced by CMP_TREE_NODE_UNIT::CMP_TREE_NODE_UNIT(), and CMP_TREE_MODEL_ADAPTER::ShowPreselect().


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