#include <footprint_info.h>

Inheritance diagram for FOOTPRINT_INFO:

Public Member Functions
virtual	~FOOTPRINT_INFO ()

const wxString &	GetFootprintName () const

wxString	GetLibNickname () const override

wxString	GetName () const override

LIB_ID	GetLibId () const override

wxString	GetDescription () override

wxString	GetKeywords ()

wxString	GetSearchText () override

unsigned	GetPadCount ()

unsigned	GetUniquePadCount ()

int	GetOrderNum ()

bool	InLibrary (const wxString &aLibrary) const
	Test if the FOOTPRINT_INFO object was loaded from aLibrary. More...

virtual void	GetChooserFields (std::map< wxString, wxString > &aColumnMap)
	Retrieves a key/value map of the fields on this item that should be exposed to the library browser/chooser for displaying in columns, searching, etc. More...

virtual bool	IsRoot () const
	For items having aliases, IsRoot() indicates the principal item. More...

virtual wxString	GetFootprint ()
	For items with footprint fields. More...

virtual int	GetUnitCount () const
	For items with units, return the number of units. More...

virtual wxString	GetUnitReference (int aUnit)
	For items with units, return an identifier for unit x. More...

virtual wxString	GetUnitDisplayName (int aUnit)
	For items with units, return a display name for unit x. More...

virtual bool	HasUnitDisplayName (int aUnit)
	For items with units, return true if a display name is set for x. More...

Protected Member Functions
void	ensure_loaded ()

virtual void	load ()
	lazily load stuff not filled in by constructor. This may throw IO_ERRORS. More...

Protected Attributes
FOOTPRINT_LIST *	m_owner
	provides access to FP_LIB_TABLE More...

bool	m_loaded

wxString	m_nickname
	library as known in FP_LIB_TABLE More...

wxString	m_fpname
	Module name. More...

int	m_num
	Order number in the display list. More...

unsigned	m_pad_count
	Number of pads. More...

unsigned	m_unique_pad_count
	Number of unique pads. More...

wxString	m_doc
	Footprint description. More...

wxString	m_keywords
	Footprint keywords. More...

Friends
bool	operator< (const FOOTPRINT_INFO &lhs, const FOOTPRINT_INFO &rhs)
	Less than comparison operator, intended for sorting FOOTPRINT_INFO objects. More...

Detailed Description

Definition at line 59 of file footprint_info.h.

Constructor & Destructor Documentation

◆ ~FOOTPRINT_INFO()

virtual FOOTPRINT_INFO::~FOOTPRINT_INFO ( )

inlinevirtual

Definition at line 62 of file footprint_info.h.

63 {

64 }

Member Function Documentation

◆ ensure_loaded()

void FOOTPRINT_INFO::ensure_loaded ( )

inlineprotected

Definition at line 135 of file footprint_info.h.

 {
 if( !m_loaded )
 load();
 }

◆ GetChooserFields()

virtual void LIB_TREE_ITEM::GetChooserFields ( std::map< wxString, wxString > & aColumnMap )

inlinevirtualinherited

Retrieves a key/value map of the fields on this item that should be exposed to the library browser/chooser for displaying in columns, searching, etc.

Reimplemented in LIB_SYMBOL.

Definition at line 56 of file lib_tree_item.h.

56{}

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

◆ GetDescription()

wxString FOOTPRINT_INFO::GetDescription ( )

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 80 of file footprint_info.h.

 {
 ensure_loaded();
 return m_doc;
 }

Referenced by CVPCB_MAINFRAME::DisplayStatus().

◆ GetFootprint()

virtual wxString LIB_TREE_ITEM::GetFootprint ( )

inlinevirtualinherited

For items with footprint fields.

Reimplemented in LIB_SYMBOL.

Definition at line 68 of file lib_tree_item.h.

68{ return wxEmptyString; }

Referenced by LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID().

◆ GetFootprintName()

const wxString & FOOTPRINT_INFO::GetFootprintName ( ) const

inline

Definition at line 69 of file footprint_info.h.

69{ return m_fpname; }

FOOTPRINT_INFO::m_fpname

wxString m_fpname

Module name.

Definition: footprint_info.h:149

Referenced by CVPCB_MAINFRAME::AutomaticFootprintMatching(), FOOTPRINT_FILTER::ITERATOR::FootprintFilterMatch(), and FOOTPRINT_FILTER::ITERATOR::increment().

◆ GetKeywords()

wxString FOOTPRINT_INFO::GetKeywords ( )

inline

Definition at line 86 of file footprint_info.h.

 {
 ensure_loaded();
 return m_keywords;
 }

Referenced by CVPCB_MAINFRAME::DisplayStatus().

◆ GetLibId()

LIB_ID FOOTPRINT_INFO::GetLibId ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 75 of file footprint_info.h.

 {
 return LIB_ID( m_nickname, m_fpname );
 }

◆ GetLibNickname()

wxString FOOTPRINT_INFO::GetLibNickname ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 71 of file footprint_info.h.

71{ return m_nickname; }

Referenced by CVPCB_MAINFRAME::DisplayStatus(), FOOTPRINT_FILTER::ITERATOR::FootprintFilterMatch(), FOOTPRINT_FILTER::ITERATOR::increment(), and DISPLAY_FOOTPRINTS_FRAME::InitDisplay().

◆ GetName()

wxString FOOTPRINT_INFO::GetName ( void ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 73 of file footprint_info.h.

73{ return m_fpname; }

◆ GetOrderNum()

int FOOTPRINT_INFO::GetOrderNum ( )

inline

Definition at line 113 of file footprint_info.h.

 {
 ensure_loaded();
 return m_num;
 }

◆ GetPadCount()

unsigned FOOTPRINT_INFO::GetPadCount ( )

inline

Definition at line 101 of file footprint_info.h.

 {
 ensure_loaded();
 return m_pad_count;
 }

◆ GetSearchText()

wxString FOOTPRINT_INFO::GetSearchText ( )

inlineoverridevirtual

Reimplemented from LIB_TREE_ITEM.

Definition at line 92 of file footprint_info.h.

 {
 // Matches are scored by offset from front of string, so inclusion of this spacer
 // discounts matches found after it.
 static const wxString discount( wxT( " " ) );
 
 return GetKeywords() + discount + GetDescription();
 }

References LIB_TREE_ITEM::GetDescription().

Referenced by FOOTPRINT_FILTER::ITERATOR::increment().

◆ GetUniquePadCount()

unsigned FOOTPRINT_INFO::GetUniquePadCount ( )

inline

Definition at line 107 of file footprint_info.h.

 {
 ensure_loaded();
 return m_unique_pad_count;
 }

Referenced by FOOTPRINT_FILTER::ITERATOR::PinCountMatch().

◆ GetUnitCount()

virtual int LIB_TREE_ITEM::GetUnitCount ( void ) const

inlinevirtualinherited

For items with units, return the number of units.

Reimplemented in LIB_SYMBOL.

Definition at line 73 of file lib_tree_item.h.

73{ return 0; }

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

◆ GetUnitDisplayName()

virtual wxString LIB_TREE_ITEM::GetUnitDisplayName ( int aUnit )

inlinevirtualinherited

For items with units, return a display name for unit x.

Reimplemented in LIB_SYMBOL.

Definition at line 83 of file lib_tree_item.h.

83{ return wxEmptyString; }

Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

◆ GetUnitReference()

virtual wxString LIB_TREE_ITEM::GetUnitReference ( int aUnit )

inlinevirtualinherited

For items with units, return an identifier for unit x.

Reimplemented in LIB_SYMBOL.

Definition at line 78 of file lib_tree_item.h.

78{ return wxEmptyString; }

Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

◆ HasUnitDisplayName()

virtual bool LIB_TREE_ITEM::HasUnitDisplayName ( int aUnit )

inlinevirtualinherited

For items with units, return true if a display name is set for x.

Reimplemented in LIB_SYMBOL.

Definition at line 88 of file lib_tree_item.h.

88{ return false; }

Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

◆ InLibrary()

bool FOOTPRINT_INFO::InLibrary ( const wxString & aLibrary ) const

Test if the FOOTPRINT_INFO object was loaded from aLibrary.

Parameters

aLibrary is the nickname of the library to test.

Returns: true if the FOOTPRINT_INFO object was loaded from aLibrary. Otherwise false.

Definition at line 72 of file footprint_info.cpp.

{
 return aLibrary == m_nickname;
}

References m_nickname.

Referenced by FOOTPRINT_FILTER::ITERATOR::increment().

◆ IsRoot()

virtual bool LIB_TREE_ITEM::IsRoot ( ) const

inlinevirtualinherited

For items having aliases, IsRoot() indicates the principal item.

Reimplemented in LIB_SYMBOL.

Definition at line 63 of file lib_tree_item.h.

63{ return true; }

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

◆ load()

virtual void FOOTPRINT_INFO::load ( )

inlineprotectedvirtual

lazily load stuff not filled in by constructor. This may throw IO_ERRORS.

Reimplemented in FOOTPRINT_INFO_IMPL.

Definition at line 142 of file footprint_info.h.

142{ };

Friends And Related Function Documentation

◆ operator<

bool operator<	(	const FOOTPRINT_INFO &	lhs,
		const FOOTPRINT_INFO &	rhs
	)

friend

Less than comparison operator, intended for sorting FOOTPRINT_INFO objects.

Definition at line 78 of file footprint_info.cpp.

{
 int retv = StrNumCmp( lhs.m_nickname, rhs.m_nickname, false );
 
 if( retv != 0 )
 return retv < 0;
 
 // Technically footprint names are not case sensitive because the file name is used
 // as the footprint name. On windows this would be problematic because windows does
 // not support case sensitive file names by default. This should not cause any issues
 // and allow for a future change to use the name defined in the footprint file.
 return StrNumCmp( lhs.m_fpname, rhs.m_fpname, false ) < 0;
}

Member Data Documentation

◆ m_doc

wxString FOOTPRINT_INFO::m_doc

protected

Footprint description.

Definition at line 153 of file footprint_info.h.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL(), and FOOTPRINT_INFO_IMPL::load().

◆ m_fpname

wxString FOOTPRINT_INFO::m_fpname

protected

Module name.

Definition at line 149 of file footprint_info.h.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL(), and FOOTPRINT_INFO_IMPL::load().

◆ m_keywords

wxString FOOTPRINT_INFO::m_keywords

protected

Footprint keywords.

Definition at line 154 of file footprint_info.h.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL(), and FOOTPRINT_INFO_IMPL::load().

◆ m_loaded

bool FOOTPRINT_INFO::m_loaded

protected

Definition at line 146 of file footprint_info.h.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL(), and FOOTPRINT_INFO_IMPL::load().

◆ m_nickname

wxString FOOTPRINT_INFO::m_nickname

protected

library as known in FP_LIB_TABLE

Definition at line 148 of file footprint_info.h.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL(), InLibrary(), and FOOTPRINT_INFO_IMPL::load().

◆ m_num

int FOOTPRINT_INFO::m_num

protected

Order number in the display list.

Definition at line 150 of file footprint_info.h.

Referenced by FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL().

◆ m_owner

FOOTPRINT_LIST* FOOTPRINT_INFO::m_owner

protected

provides access to FP_LIB_TABLE

Definition at line 144 of file footprint_info.h.

Referenced by FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL(), and FOOTPRINT_INFO_IMPL::load().

◆ m_pad_count

unsigned FOOTPRINT_INFO::m_pad_count

protected

Number of pads.

Definition at line 151 of file footprint_info.h.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL(), and FOOTPRINT_INFO_IMPL::load().

◆ m_unique_pad_count

unsigned FOOTPRINT_INFO::m_unique_pad_count

protected

Number of unique pads.

Definition at line 152 of file footprint_info.h.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL(), and FOOTPRINT_INFO_IMPL::load().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~FOOTPRINT_INFO()

Member Function Documentation

◆ ensure_loaded()

◆ GetChooserFields()

◆ GetDescription()

◆ GetFootprint()

◆ GetFootprintName()

◆ GetKeywords()

◆ GetLibId()

◆ GetLibNickname()

◆ GetName()

◆ GetOrderNum()

◆ GetPadCount()

◆ GetSearchText()

◆ GetUniquePadCount()

◆ GetUnitCount()

◆ GetUnitDisplayName()

◆ GetUnitReference()

◆ HasUnitDisplayName()

◆ InLibrary()

◆ IsRoot()

◆ load()

Friends And Related Function Documentation

◆ operator<

Member Data Documentation

◆ m_doc

◆ m_fpname

◆ m_keywords

◆ m_loaded

◆ m_nickname

◆ m_num

◆ m_owner

◆ m_pad_count

◆ m_unique_pad_count