#include <lib_tree_model.h>

Inheritance diagram for LIB_TREE_NODE_ITEM:

Public Types
enum	TYPE { ROOT , LIBRARY , ITEM , UNIT , INVALID }

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

Public Member Functions
	LIB_TREE_NODE_ITEM (LIB_TREE_NODE_ITEM const &_)=delete
	The addresses of CMP_TREE_NODEs are used as unique IDs for the wxDataViewModel, so don't let them be copied around.

void	operator= (LIB_TREE_NODE_ITEM const &_)=delete

	LIB_TREE_NODE_ITEM (LIB_TREE_NODE aParent, LIB_TREE_ITEM aItem)
	Construct a LIB_ID node.

void	Update (LIB_TREE_ITEM *aItem)
	Update the node using data from a LIB_ALIAS object.

void	UpdateScore (EDA_COMBINED_MATCHER aMatcher, const wxString &aLib, std::function< bool(LIB_TREE_NODE &aNode)> aFilter) override
	Perform the actual search.

virtual void	ResetScore ()
	Initialize scores recursively.

virtual void	ForceScore (int aScore)

void	AssignIntrinsicRanks (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).

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

Protected Member Functions
LIB_TREE_NODE_UNIT &	AddUnit (LIB_TREE_ITEM *aItem, int aUnit)
	Add a new unit to the component and return it.

Detailed Description

Node type: LIB_ID.

Definition at line 186 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 123 of file lib_tree_model.h.

Member Enumeration Documentation

◆ TYPE

enum LIB_TREE_NODE::TYPE

inherited

Enumerator
ROOT
LIBRARY
ITEM
UNIT
INVALID

Definition at line 114 of file lib_tree_model.h.

Constructor & Destructor Documentation

◆ LIB_TREE_NODE_ITEM() [1/2]

LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM ( LIB_TREE_NODE_ITEM 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_ITEM() [2/2]

LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM	(	LIB_TREE_NODE *	aParent,
		LIB_TREE_ITEM *	aItem
	)

Construct a LIB_ID node.

All fields will be populated from the LIB_ALIAS, including children (unit nodes will be generated automatically). This does not keep the pointer to the #LIB_ALIAS object because at any time, a #LIB_ALIAS can be remove from a library which will result in an invalid pointer. The alias must be resolved at the time of use. Anything else is a bug.

Parameters

aParent	parent node, should be a CMP_TREE_NODE_LIB
aItem	LIB_COMPONENT to populate the node.

Definition at line 187 of file lib_tree_model.cpp.

Member Function Documentation

◆ AddUnit()

LIB_TREE_NODE_UNIT & LIB_TREE_NODE_ITEM::AddUnit	(	LIB_TREE_ITEM *	aItem,
		int	aUnit
	)

protected

Add a new unit to the component and return it.

This should not be used directly, as the constructor adds all units.

Definition at line 214 of file lib_tree_model.cpp.

References LIB_TREE_NODE::m_Children.

Referenced by LIB_TREE_NODE_ITEM(), and Update().

◆ 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 42 of file lib_tree_model.cpp.

References LIB_TREE_NODE::m_Children, and LIB_TREE_NODE::m_IntrinsicRank.

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

◆ Compare()

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

staticinherited

Compare two nodes.

Returns true if aNode1 < aNode2.

Definition at line 83 of file lib_tree_model.cpp.

References LIB_TREE_NODE::m_IntrinsicRank, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_Pinned, LIB_TREE_NODE::m_Score, and LIB_TREE_NODE::m_Type.

◆ ForceScore()

virtual void LIB_TREE_NODE::ForceScore ( int aScore )

inlinevirtualinherited

Definition at line 92 of file lib_tree_model.h.

References LIB_TREE_NODE::m_Score.

◆ operator=()

void LIB_TREE_NODE_ITEM::operator= ( LIB_TREE_NODE_ITEM const & _ )

delete

◆ ResetScore()

void LIB_TREE_NODE::ResetScore ( )

virtualinherited

Initialize scores recursively.

Definition at line 33 of file lib_tree_model.cpp.

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

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ SortNodes()

void LIB_TREE_NODE::SortNodes ( bool aUseScores )

inherited

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

Definition at line 70 of file lib_tree_model.cpp.

References LIB_TREE_NODE::m_Children.

Referenced by LIB_TREE_MODEL_ADAPTER::resortTree(), and LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ Update()

void LIB_TREE_NODE_ITEM::Update ( LIB_TREE_ITEM * aItem )

Update the node using data from a LIB_ALIAS object.

Definition at line 222 of file lib_tree_model.cpp.

References AddUnit(), LIB_TREE_ITEM::GetChooserFields(), LIB_TREE_ITEM::GetDesc(), LIB_TREE_ITEM::GetLIB_ID(), LIB_ID::GetLibNickname(), LIB_TREE_ITEM::GetName(), LIB_TREE_ITEM::GetSearchTerms(), LIB_TREE_ITEM::GetSubUnitCount(), LIB_TREE_ITEM::IsRoot(), LIB_TREE_NODE::m_Children, LIB_TREE_NODE::m_Desc, LIB_TREE_NODE::m_Fields, LIB_TREE_NODE::m_IsRoot, LIB_TREE_NODE::m_LibId, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_SearchTerms, LIB_ID::SetLibItemName(), and LIB_ID::SetLibNickname().

◆ UpdateScore()

void LIB_TREE_NODE_ITEM::UpdateScore	(	EDA_COMBINED_MATCHER *	aMatcher,
		const wxString &	aLib,
		std::function< bool(LIB_TREE_NODE &aNode)> *	aFilter
	)

overridevirtual

Perform the actual search.

Implements LIB_TREE_NODE.

Definition at line 242 of file lib_tree_model.cpp.

References LIB_TREE_NODE::m_Children, LIB_TREE_NODE::m_Score, LIB_TREE_NODE::m_SearchTerms, and EDA_COMBINED_MATCHER::ScoreTerms().

Member Data Documentation

◆ m_Children

PTR_VECTOR LIB_TREE_NODE::m_Children

inherited

Definition at line 126 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE_LIBRARY::AddItem(), LIB_TREE_NODE_ROOT::AddLib(), AddUnit(), LIB_TREE_NODE::AssignIntrinsicRanks(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary(), FP_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary(), LIB_TREE_MODEL_ADAPTER::FindItem(), LIB_TREE_MODEL_ADAPTER::GetChildren(), LIB_TREE_MODEL_ADAPTER::GetItemCount(), LIB_TREE_MODEL_ADAPTER::GetLibrariesCount(), LIB_TREE_MODEL_ADAPTER::IsContainer(), recursiveDescent(), LIB_TREE_NODE::ResetScore(), LIB_TREE_MODEL_ADAPTER::ShowResults(), LIB_TREE_NODE::SortNodes(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), Update(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary(), FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary(), UpdateScore(), LIB_TREE_NODE_LIBRARY::UpdateScore(), LIB_TREE_NODE_ROOT::UpdateScore(), and LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ m_Desc

wxString LIB_TREE_NODE::m_Desc

inherited

Definition at line 140 of file lib_tree_model.h.

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

◆ m_Fields

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

inherited

List of weighted search terms.

Definition at line 145 of file lib_tree_model.h.

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

◆ m_Footprint

wxString LIB_TREE_NODE::m_Footprint

inherited

Definition at line 141 of file lib_tree_model.h.

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

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

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

◆ m_IsRoot

bool LIB_TREE_NODE::m_IsRoot

inherited

Definition at line 149 of file lib_tree_model.h.

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

◆ m_LibId

LIB_ID LIB_TREE_NODE::m_LibId

inherited

See also: LIB_TREE_ITEMS::GetChooserFields

Definition at line 147 of file lib_tree_model.h.

◆ m_Name

wxString LIB_TREE_NODE::m_Name

inherited

Definition at line 139 of file lib_tree_model.h.

◆ m_Parent

LIB_TREE_NODE* LIB_TREE_NODE::m_Parent

inherited

Definition at line 125 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_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

inherited

Definition at line 142 of file lib_tree_model.h.

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

◆ m_Pinned

bool LIB_TREE_NODE::m_Pinned

inherited

Definition at line 137 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE::Compare(), LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode(), LIB_TREE_MODEL_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_EDITOR_CONTROL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), LIB_TREE::onItemContextMenu(), SYMBOL_EDITOR_CONTROL::PinLibrary(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), FOOTPRINT_EDITOR_CONTROL::UnpinLibrary(), and LIB_TREE_MODEL_ADAPTER::UnpinLibrary().

◆ m_Score

int LIB_TREE_NODE::m_Score

inherited

Definition at line 136 of file lib_tree_model.h.

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

◆ m_SearchTerms

std::vector<SEARCH_TERM> LIB_TREE_NODE::m_SearchTerms

inherited

Definition at line 144 of file lib_tree_model.h.

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

◆ m_Type

enum TYPE LIB_TREE_NODE::m_Type

inherited

Definition at line 127 of file lib_tree_model.h.

◆ m_Unit

int LIB_TREE_NODE::m_Unit

inherited

Definition at line 148 of file lib_tree_model.h.

Referenced by LIB_TREE_MODEL_ADAPTER::GetUnitFor(), 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 Member Functions

Detailed Description

Member Typedef Documentation

◆ PTR_VECTOR

Member Enumeration Documentation

◆ TYPE

Constructor & Destructor Documentation

◆ LIB_TREE_NODE_ITEM() [1/2]

◆ LIB_TREE_NODE_ITEM() [2/2]

Member Function Documentation

◆ AddUnit()

◆ AssignIntrinsicRanks()

◆ Compare()

◆ ForceScore()

◆ operator=()

◆ ResetScore()

◆ SortNodes()

◆ Update()

◆ UpdateScore()

Member Data Documentation

◆ m_Children

◆ m_Desc

◆ m_Fields

◆ m_Footprint

◆ m_IntrinsicRank

◆ m_IsRoot

◆ m_LibId

◆ m_Name

◆ m_Parent

◆ m_PinCount

◆ m_Pinned

◆ m_Score

◆ m_SearchTerms

◆ m_Type

◆ m_Unit