Model class in the component selector Model-View-Adapter (mediated MVC) architecture. More...

#include <lib_tree_model.h>

Inheritance diagram for 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
virtual void	UpdateScore (EDA_COMBINED_MATCHER &aMatcher, const wxString &aLib)=0
	Update the score for this part. 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...

	LIB_TREE_NODE ()

virtual	~LIB_TREE_NODE ()

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_NODE *	m_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_Footprint

wxString	m_MatchName

wxString	m_SearchText

bool	m_Normalized

std::map< wxString, wxString >	m_Fields

LIB_ID	m_LibId

int	m_Unit

bool	m_IsRoot

Detailed Description

Model class in the component selector Model-View-Adapter (mediated MVC) architecture.

The other pieces are in:

Adapter: LIB_TREE_MODEL_ADAPTER in common/lib_tree_model_adapter.h
View:
- DIALOG_CHOOSE_COMPONENT in eeschema/dialogs/dialog_choose_component.h
- wxDataViewCtrl

This model is populated from LIB_ALIASes; helper methods in the adapter can accept entire libraries.

Quick summary of methods used to populate this class:

CMP_TREE_NODE_ROOT::AddLib() - add a new, empty library to the root
CMP_TREE_NODE_LIB::AddAlias() - add an alias and its units from a given LIB_ALIAS*

Quick summary of methods used to drive this class:

UpdateScore() - accumulate scores recursively given a new search token
ResetScore() - reset scores recursively for a new search string
AssignIntrinsicRanks() - calculate and cache the initial sort order
SortNodes() - recursively sort the tree by score
Compare() - compare two nodes; used by SortNodes()

The data in the model is meant to be accessed directly. Quick summary of data members:

Parent - parent node, or nullptr if root
Children - vector of unique_ptrs to children
Type - ROOT, LIB, ALIAS, or UNIT
m_IntrinsicRank - cached initial sort order
m_Score - score taking into account search terms. Zero means irrelevant and should be hidden.
Name - name of the library/alias/unit, to be displayed
Desc - description of the alias, to be displayed
m_MatchName - Name, normalized to lowercase for matching
m_SearchText - normalized composite of keywords and description
LibId - the LIB_ID this alias or unit is from, or not valid
Unit - the unit number, or zero for non-units

Definition at line 76 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

Definition at line 116 of file lib_tree_model.h.

Member Enumeration Documentation

◆ TYPE

enum LIB_TREE_NODE::TYPE

Enumerator
ROOT
LIB
LIBID
UNIT
INVALID

Definition at line 112 of file lib_tree_model.h.

 {
 ROOT, LIB, LIBID, UNIT, INVALID
 };

Constructor & Destructor Documentation

◆ LIB_TREE_NODE()

LIB_TREE_NODE::LIB_TREE_NODE ( )

Definition at line 127 of file lib_tree_model.cpp.

 : m_Parent( nullptr ),
 m_Type( INVALID ),
 m_IntrinsicRank( 0 ),
 m_Score( kLowestDefaultScore ),
 m_Pinned( false ),
 m_Normalized( false ),
 m_Unit( 0 ),
 m_IsRoot( false )
{}

◆ ~LIB_TREE_NODE()

virtual LIB_TREE_NODE::~LIB_TREE_NODE ( )

inlinevirtual

Definition at line 110 of file lib_tree_model.h.

110{}

Member Function Documentation

◆ AssignIntrinsicRanks()

void LIB_TREE_NODE::AssignIntrinsicRanks ( bool presorted = false )

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.

{
 std::vector<LIB_TREE_NODE*> sort_buf;
 
 if( presorted )
 {
 int max = m_Children.size() - 1;
 
 for( int i = 0; i <= max; ++i )
 m_Children[i]->m_IntrinsicRank = max - i;
 }
 else
 {
 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
 sort_buf.push_back( child.get() );
 
 std::sort( sort_buf.begin(), sort_buf.end(),
 []( LIB_TREE_NODE* a, LIB_TREE_NODE* b ) -> bool
 {
 return StrNumCmp( a->m_Name, b->m_Name, true ) > 0;
 } );
 
 for( int i = 0; i < (int) sort_buf.size(); ++i )
 sort_buf[i]->m_IntrinsicRank = i;
 }
}

References m_Children, and m_IntrinsicRank.

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

◆ Compare()

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

static

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.

{
 if( aNode1.m_Type != aNode2.m_Type )
 return 0;
 
 // Recently used sorts at top
 if( aNode1.m_Name.StartsWith( wxT( "-- " ) ) )
 return 1;
 else if( aNode2.m_Name.StartsWith( wxT( "-- " ) ) )
 return 0;
 
 // Pinned nodes go next
 if( aNode1.m_Pinned && !aNode2.m_Pinned )
 return 1;
 else if( aNode2.m_Pinned && !aNode1.m_Pinned )
 return -1;
 
 if( aNode1.m_Parent != aNode2.m_Parent )
 return 0;
 
 return aNode1.m_IntrinsicRank - aNode2.m_IntrinsicRank;
}

References m_IntrinsicRank, m_Name, m_Parent, m_Pinned, and m_Type.

◆ ResetScore()

void LIB_TREE_NODE::ResetScore ( )

Initialize score to kLowestDefaultScore, recursively.

Definition at line 53 of file lib_tree_model.cpp.

{
 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
 child->ResetScore();
 
 m_Score = kLowestDefaultScore;
}

References kLowestDefaultScore, m_Children, and m_Score.

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ SortNodes()

void LIB_TREE_NODE::SortNodes ( )

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

Definition at line 90 of file lib_tree_model.cpp.

{
 std::sort( m_Children.begin(), m_Children.end(),
 []( std::unique_ptr<LIB_TREE_NODE>& a, std::unique_ptr<LIB_TREE_NODE>& b )
 {
 return Compare( *a, *b ) > 0;
 } );
 
 for( std::unique_ptr<LIB_TREE_NODE>& node: m_Children )
 node->SortNodes();
}