Node type: unit of component. More...

#include <lib_tree_model.h>

Inheritance diagram for LIB_TREE_NODE_UNIT:

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, const wxString &aLib) 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 bool	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

Node type: unit of component.

Definition at line 150 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 115 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 111 of file lib_tree_model.h.

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

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

aParent	parent node, should be a CMP_TREE_NODE_ALIAS
aItem	parent item
aUnit	unit number

Definition at line 150 of file lib_tree_model.cpp.

{
 static void* locale = nullptr;
 static wxString namePrefix;
 
 // Fetching translations can take a surprising amount of time when loading libraries,
 // so only do it when necessary.
 if( Pgm().GetLocale() != locale )
 {
 namePrefix = _( "Unit" );
 locale = Pgm().GetLocale();
 }
 
 m_Parent = aParent;
 m_Type = UNIT;
 
 m_Unit = aUnit;
 m_LibId = aParent->m_LibId;
 
 m_Name = namePrefix + " " + aItem->GetUnitReference( aUnit );
 
 if( aItem->HasUnitDisplayName( aUnit ) )
 {
 m_Desc = aItem->GetUnitDisplayName( aUnit );
 }
 else
 {
 m_Desc = wxEmptyString;
 }
 
 m_MatchName = wxEmptyString;
 
 m_IntrinsicRank = -aUnit;
}

References _, LIB_TREE_ITEM::GetUnitDisplayName(), LIB_TREE_ITEM::GetUnitReference(), LIB_TREE_ITEM::HasUnitDisplayName(), 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.

{
 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 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
	)

staticinherited

Compare two nodes.

Returns true if aNode1 < aNode2.

Definition at line 103 of file lib_tree_model.cpp.

{
 if( aNode1.m_Type != aNode2.m_Type )
 return aNode1.m_Type < aNode2.m_Type;
 
 // Recently used sorts at top
 if( aNode1.m_Name.StartsWith( wxT( "-- " ) ) )
 {
 if( aNode2.m_Name.StartsWith( wxT( "-- " ) ) )
 {
 return aNode1.m_IntrinsicRank > aNode2.m_IntrinsicRank;
 }
 else
 {
 return true;
 }
 }
 else if( aNode2.m_Name.StartsWith( wxT( "-- " ) ) )
 {
 return false;
 }
 
 // Pinned nodes go next
 if( aNode1.m_Pinned && !aNode2.m_Pinned )
 return true;
 else if( aNode2.m_Pinned && !aNode1.m_Pinned )
 return false;
 
 if( aNode1.m_IntrinsicRank != aNode2.m_IntrinsicRank )
 return aNode1.m_IntrinsicRank > aNode2.m_IntrinsicRank;
 
 return reinterpret_cast<const void*>( &aNode1 ) < reinterpret_cast<const void*>( &aNode2 );
}

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

◆ 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.

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

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.

{
 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 );
 } );
 
 for( std::unique_ptr<LIB_TREE_NODE>& node: m_Children )
 node->SortNodes();
}

References LIB_TREE_NODE::m_Children.

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

◆ UpdateScore()

virtual void LIB_TREE_NODE_UNIT::UpdateScore	(	EDA_COMBINED_MATCHER &	aMatcher,
		const wxString &	aLib
	)

inlineoverridevirtual

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

Implements LIB_TREE_NODE.

Definition at line 176 of file lib_tree_model.h.

176{}

Member Data Documentation

◆ m_Children

PTR_VECTOR LIB_TREE_NODE::m_Children

inherited

Definition at line 118 of file lib_tree_model.h.

◆ m_Desc

wxString LIB_TREE_NODE::m_Desc

inherited

Definition at line 132 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_LIB::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_UNIT(), and LIB_TREE_NODE_LIB_ID::Update().

◆ m_Fields

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

inherited

See also: LIB_TREE_ITEMS::GetChooserFields

Definition at line 139 of file lib_tree_model.h.

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

◆ m_Footprint

wxString LIB_TREE_NODE::m_Footprint

inherited

Definition at line 133 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), and DIALOG_CHOOSE_SYMBOL::OnComponentPreselected().

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

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

◆ m_IsRoot

bool LIB_TREE_NODE::m_IsRoot

inherited

Definition at line 143 of file lib_tree_model.h.

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

◆ m_LibId

LIB_ID LIB_TREE_NODE::m_LibId

inherited

Definition at line 141 of file lib_tree_model.h.

Referenced by LIB_TREE_MODEL_ADAPTER::GetAliasFor(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_NODE_LIB::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_UNIT(), DIALOG_CHOOSE_SYMBOL::OnComponentPreselected(), SYMBOL_EDITOR_CONTROL::PinLibrary(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), LIB_TREE_MODEL_ADAPTER::ShowPreselect(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), FOOTPRINT_EDITOR_CONTROL::UnpinLibrary(), LIB_TREE_MODEL_ADAPTER::UnpinLibrary(), and LIB_TREE_NODE_LIB_ID::Update().

◆ m_MatchName

wxString LIB_TREE_NODE::m_MatchName

inherited

Definition at line 134 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE_LIB::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_UNIT(), LIB_TREE_NODE_LIB_ID::Update(), LIB_TREE_NODE_LIB_ID::UpdateScore(), and LIB_TREE_NODE_LIB::UpdateScore().

◆ m_Name

wxString LIB_TREE_NODE::m_Name

inherited

Definition at line 131 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE::Compare(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary(), FP_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), LIB_TREE_MODEL_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_NODE_LIB::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_UNIT(), LIB_TREE_NODE_LIB_ID::Update(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary(), and FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

◆ m_Normalized

bool LIB_TREE_NODE::m_Normalized

inherited

Definition at line 136 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_LIB_ID::Update(), and LIB_TREE_NODE_LIB_ID::UpdateScore().

◆ m_Parent

LIB_TREE_NODE* LIB_TREE_NODE::m_Parent

inherited

Definition at line 117 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::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_UNIT(), LIB_TREE_MODEL_ADAPTER::ShowPreselect(), LIB_TREE_MODEL_ADAPTER::ShowSingleLibrary(), and LIB_TREE_NODE_LIB_ID::UpdateScore().

◆ m_Pinned

bool LIB_TREE_NODE::m_Pinned

inherited

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

Referenced by LIB_TREE_NODE::ResetScore(), LIB_TREE_MODEL_ADAPTER::ShowResults(), LIB_TREE_NODE_LIB_ID::UpdateScore(), and LIB_TREE_NODE_LIB::UpdateScore().

◆ m_SearchText

wxString LIB_TREE_NODE::m_SearchText

inherited

Definition at line 135 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_LIB_ID::Update(), and LIB_TREE_NODE_LIB_ID::UpdateScore().

◆ m_Type

enum TYPE LIB_TREE_NODE::m_Type

inherited

Definition at line 119 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE::Compare(), LIB_TREE_MODEL_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), LIB_TREE_MODEL_ADAPTER::GetChildren(), LIB_TREE_MODEL_ADAPTER::GetParent(), LIB_TREE_MODEL_ADAPTER::GetTypeFor(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_EDITOR_CONTROL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::IsContainer(), FP_TREE_SYNCHRONIZING_ADAPTER::IsContainer(), LIB_TREE_NODE_LIB::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_ROOT::LIB_TREE_NODE_ROOT(), LIB_TREE_NODE_UNIT(), LIB_TREE::onItemContextMenu(), LIB_TREE_MODEL_ADAPTER::ShowPreselect(), LIB_TREE_MODEL_ADAPTER::ShowResults(), and LIB_TREE_MODEL_ADAPTER::ShowSingleLibrary().

◆ m_Unit

int LIB_TREE_NODE::m_Unit

inherited

Definition at line 142 of file lib_tree_model.h.

Referenced by LIB_TREE_MODEL_ADAPTER::GetUnitFor(), LIB_TREE_NODE_UNIT(), DIALOG_CHOOSE_SYMBOL::OnComponentPreselected(), and LIB_TREE_MODEL_ADAPTER::ShowPreselect().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ PTR_VECTOR

Member Enumeration Documentation

◆ TYPE

Constructor & Destructor Documentation

◆ LIB_TREE_NODE_UNIT() [1/2]

◆ LIB_TREE_NODE_UNIT() [2/2]

Member Function Documentation

◆ AssignIntrinsicRanks()

◆ Compare()

◆ operator=()

◆ ResetScore()

◆ SortNodes()

◆ UpdateScore()

Member Data Documentation

◆ m_Children

◆ m_Desc

◆ m_Fields

◆ m_Footprint

◆ m_IntrinsicRank

◆ m_IsRoot

◆ m_LibId

◆ m_MatchName

◆ m_Name

◆ m_Normalized

◆ m_Parent

◆ m_Pinned

◆ m_Score

◆ m_SearchText

◆ m_Type

◆ m_Unit