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 class	TYPE { ROOT , LIBRARY , ITEM , UNIT , INVALID }

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

Public Member Functions
virtual void	UpdateScore (const std::vector< std::unique_ptr< EDA_COMBINED_MATCHER > > &aMatchers, std::function< bool(LIB_TREE_NODE &aNode)> *aFilter)=0
	Update the score for this part.

void	RebuildSearchTerms (const std::vector< wxString > &aShownColumns)
	Rebuild search terms from source search terms and shown fields.

void	AssignIntrinsicRanks (const std::vector< wxString > &aShownColumns, bool presorted=false)
	Store intrinsic ranks on all children of this node.

void	SortNodes (bool aUseScores)
	Sort child nodes quickly and recursively (IntrinsicRanks must have been set).

	LIB_TREE_NODE ()

virtual	~LIB_TREE_NODE ()

Static Public Member Functions
static bool	Compare (LIB_TREE_NODE const &aNode1, LIB_TREE_NODE const &aNode2, bool aUseScores)
	Compare two nodes.

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.

int	m_Score

bool	m_Pinned

wxString	m_Name

wxString	m_Desc

wxString	m_Footprint

int	m_PinCount

std::vector< SEARCH_TERM >	m_SearchTerms

std::map< wxString, wxString >	m_Fields
	List of weighted search terms.

LIB_ID	m_LibId

int	m_Unit

bool	m_IsRoot

bool	m_IsRecentlyUsedGroup

bool	m_IsAlreadyPlacedGroup

Protected Attributes
std::vector< SEARCH_TERM >	m_sourceSearchTerms

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
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 74 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 120 of file lib_tree_model.h.

Member Enumeration Documentation

◆ TYPE

enum class LIB_TREE_NODE::TYPE

strong

Enumerator
ROOT
LIBRARY
ITEM
UNIT
INVALID

Definition at line 111 of file lib_tree_model.h.

Constructor & Destructor Documentation

◆ LIB_TREE_NODE()

LIB_TREE_NODE::LIB_TREE_NODE ( )

◆ ~LIB_TREE_NODE()

virtual LIB_TREE_NODE::~LIB_TREE_NODE ( )

inlinevirtual

Definition at line 109 of file lib_tree_model.h.

Member Function Documentation

◆ AssignIntrinsicRanks()

void LIB_TREE_NODE::AssignIntrinsicRanks	(	const std::vector< wxString > &	aShownColumns,
		bool	presorted = false )

Store intrinsic ranks on all children of this node.

See m_IntrinsicRank member doc for more information.

Definition at line 46 of file lib_tree_model.cpp.

References LIB_TREE_NODE(), m_Children, and m_IntrinsicRank.

Referenced by LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

◆ Compare()

bool LIB_TREE_NODE::Compare	(	LIB_TREE_NODE const &	aNode1,
		LIB_TREE_NODE const &	aNode2,
		bool	aUseScores )

static

Compare two nodes.

Returns true if aNode1 < aNode2.

Definition at line 90 of file lib_tree_model.cpp.

References LIB_TREE_NODE(), m_IntrinsicRank, m_IsRecentlyUsedGroup, m_Name, m_Pinned, m_Score, and m_Type.

◆ RebuildSearchTerms()

void LIB_TREE_NODE::RebuildSearchTerms ( const std::vector< wxString > & aShownColumns )

Rebuild search terms from source search terms and shown fields.

Definition at line 34 of file lib_tree_model.cpp.

References alg::contains(), m_Fields, m_SearchTerms, m_sourceSearchTerms, and name.

◆ SortNodes()

void LIB_TREE_NODE::SortNodes ( bool aUseScores )

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

Definition at line 77 of file lib_tree_model.cpp.

References m_Children.

◆ UpdateScore()

virtual void LIB_TREE_NODE::UpdateScore	(	const std::vector< std::unique_ptr< EDA_COMBINED_MATCHER > > &	aMatchers,
		std::function< bool(LIB_TREE_NODE &aNode)> *	aFilter )

pure virtual

Update the score for this part.

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

Parameters

aMatcher an EDA_COMBINED_MATCHER initialized with the search term

Implemented in LIB_TREE_NODE_ITEM, LIB_TREE_NODE_LIBRARY, LIB_TREE_NODE_ROOT, and LIB_TREE_NODE_UNIT.

References LIB_TREE_NODE().

Member Data Documentation

◆ m_Children

◆ m_Desc

wxString LIB_TREE_NODE::m_Desc

Definition at line 137 of file lib_tree_model.h.

Referenced by FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_MODEL_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), LIB_TREE_NODE_LIBRARY::LIB_TREE_NODE_LIBRARY(), and LIB_TREE_NODE_ITEM::Update().

◆ m_Fields

std::map<wxString, wxString> LIB_TREE_NODE::m_Fields

List of weighted search terms.

Definition at line 142 of file lib_tree_model.h.

Referenced by LIB_TREE_MODEL_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), RebuildSearchTerms(), and LIB_TREE_NODE_ITEM::Update().

◆ m_Footprint

wxString LIB_TREE_NODE::m_Footprint

Definition at line 138 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and PANEL_SYMBOL_CHOOSER::onSymbolSelected().

◆ m_IntrinsicRank

int LIB_TREE_NODE::m_IntrinsicRank

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 131 of file lib_tree_model.h.

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

◆ m_IsAlreadyPlacedGroup

bool LIB_TREE_NODE::m_IsAlreadyPlacedGroup

Definition at line 149 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE(), and PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER().

◆ m_IsRecentlyUsedGroup

bool LIB_TREE_NODE::m_IsRecentlyUsedGroup

Definition at line 148 of file lib_tree_model.h.

Referenced by Compare(), LIB_TREE_NODE(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), and PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER().

◆ m_IsRoot

bool LIB_TREE_NODE::m_IsRoot

Definition at line 146 of file lib_tree_model.h.

Referenced by LIB_TREE_MODEL_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), LIB_TREE_NODE(), LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ m_LibId

LIB_ID LIB_TREE_NODE::m_LibId

See also: LIB_TREE_ITEMS::GetChooserFields

Definition at line 144 of file lib_tree_model.h.

◆ m_Name

wxString LIB_TREE_NODE::m_Name

Definition at line 136 of file lib_tree_model.h.

Referenced by Compare(), FP_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_MODEL_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), LIB_TREE_NODE_LIBRARY::LIB_TREE_NODE_LIBRARY(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), LIB_TREE_MODEL_ADAPTER::ShowResults(), LIB_TREE_NODE_ITEM::Update(), FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

◆ m_Parent

LIB_TREE_NODE* LIB_TREE_NODE::m_Parent

Definition at line 122 of file lib_tree_model.h.

Referenced by LIB_TREE::centerIfValid(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), LIB_TREE_MODEL_ADAPTER::GetParent(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_NODE(), LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), LIB_TREE_NODE_LIBRARY::LIB_TREE_NODE_LIBRARY(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), LIB_TREE_MODEL_ADAPTER::ShowResults(), and LIB_TREE_NODE_UNIT::UpdateScore().

◆ m_PinCount

int LIB_TREE_NODE::m_PinCount

Definition at line 139 of file lib_tree_model.h.

Referenced by FOOTPRINT_CHOOSER_FRAME::filterFootprint(), LIB_TREE_NODE(), and LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM().

◆ m_Pinned

bool LIB_TREE_NODE::m_Pinned

Definition at line 134 of file lib_tree_model.h.

Referenced by DESIGN_BLOCK_CONTROL::AddContextMenuItems(), Compare(), LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_MODEL_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_NODE(), LIB_TREE::onItemContextMenu(), DESIGN_BLOCK_CONTROL::PinLibrary(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), DESIGN_BLOCK_CONTROL::UnpinLibrary(), and LIB_TREE_MODEL_ADAPTER::UnpinLibrary().

◆ m_Score

int LIB_TREE_NODE::m_Score

Definition at line 133 of file lib_tree_model.h.

Referenced by Compare(), LIB_TREE_NODE(), LIB_TREE_MODEL_ADAPTER::ShowResults(), LIB_TREE_NODE_ITEM::UpdateScore(), LIB_TREE_NODE_LIBRARY::UpdateScore(), and LIB_TREE_NODE_UNIT::UpdateScore().

◆ m_SearchTerms

std::vector<SEARCH_TERM> LIB_TREE_NODE::m_SearchTerms

Definition at line 141 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE_LIBRARY::LIB_TREE_NODE_LIBRARY(), RebuildSearchTerms(), LIB_TREE_NODE_ITEM::UpdateScore(), and LIB_TREE_NODE_LIBRARY::UpdateScore().

◆ m_sourceSearchTerms

std::vector<SEARCH_TERM> LIB_TREE_NODE::m_sourceSearchTerms

protected

Definition at line 152 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), RebuildSearchTerms(), and LIB_TREE_NODE_ITEM::Update().

◆ m_Type

enum TYPE LIB_TREE_NODE::m_Type

Definition at line 124 of file lib_tree_model.h.

◆ m_Unit

int LIB_TREE_NODE::m_Unit

Definition at line 145 of file lib_tree_model.h.

Referenced by LIB_TREE_MODEL_ADAPTER::GetUnitFor(), LIB_TREE_NODE(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), PANEL_SYMBOL_CHOOSER::onSymbolSelected(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), and LIB_TREE_MODEL_ADAPTER::ShowResults().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes