KiCad PCB EDA Suite
FOOTPRINT_INFO Class Reference

#include <footprint_info.h>

Inheritance diagram for FOOTPRINT_INFO:
LIB_TREE_ITEM FOOTPRINT_INFO_IMPL

Public Member Functions

virtual ~FOOTPRINT_INFO ()
 
const wxString & GetFootprintName () const
 
wxString GetLibNickname () const override
 
const wxString & GetName () const override
 
LIB_ID GetLibId () const override
 
const wxString & GetDescription () override
 
const 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 bool IsRoot () const
 For items having aliases, IsRoot() indicates the principal item. More...
 
virtual int GetUnitCount ()
 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...
 

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_LISTm_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 &item1, const FOOTPRINT_INFO &item2)
 FOOTPRINT object list sort function. More...
 

Detailed Description

Definition at line 63 of file footprint_info.h.

Constructor & Destructor Documentation

virtual FOOTPRINT_INFO::~FOOTPRINT_INFO ( )
inlinevirtual

Definition at line 68 of file footprint_info.h.

69  {
70  }

Member Function Documentation

void FOOTPRINT_INFO::ensure_loaded ( )
inlineprotected

Definition at line 145 of file footprint_info.h.

146  {
147  if( !m_loaded )
148  load();
149  }
virtual void load()
lazily load stuff not filled in by constructor. This may throw IO_ERRORS.
const wxString& FOOTPRINT_INFO::GetDescription ( )
inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 95 of file footprint_info.h.

Referenced by CVPCB_MAINFRAME::DisplayStatus().

96  {
97  ensure_loaded();
98  return m_doc;
99  }
wxString m_doc
Footprint description.
const wxString& FOOTPRINT_INFO::GetFootprintName ( ) const
inline

Definition at line 75 of file footprint_info.h.

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

76  {
77  return m_fpname;
78  }
wxString m_fpname
Module name.
const wxString& FOOTPRINT_INFO::GetKeywords ( )
inline

Definition at line 101 of file footprint_info.h.

Referenced by CVPCB_MAINFRAME::DisplayStatus().

102  {
103  ensure_loaded();
104  return m_keywords;
105  }
wxString m_keywords
Footprint keywords.
LIB_ID FOOTPRINT_INFO::GetLibId ( ) const
inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 90 of file footprint_info.h.

91  {
92  return LIB_ID( m_nickname, m_fpname );
93  }
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
wxString m_fpname
Module name.
wxString m_nickname
library as known in FP_LIB_TABLE
wxString FOOTPRINT_INFO::GetLibNickname ( ) const
inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 80 of file footprint_info.h.

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

81  {
82  return m_nickname;
83  }
wxString m_nickname
library as known in FP_LIB_TABLE
const wxString& FOOTPRINT_INFO::GetName ( void  ) const
inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 85 of file footprint_info.h.

Referenced by FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

86  {
87  return m_fpname;
88  }
wxString m_fpname
Module name.
int FOOTPRINT_INFO::GetOrderNum ( )
inline

Definition at line 128 of file footprint_info.h.

129  {
130  ensure_loaded();
131  return m_num;
132  }
int m_num
Order number in the display list.
unsigned FOOTPRINT_INFO::GetPadCount ( )
inline

Definition at line 116 of file footprint_info.h.

117  {
118  ensure_loaded();
119  return m_pad_count;
120  }
unsigned m_pad_count
Number of pads.
wxString FOOTPRINT_INFO::GetSearchText ( )
inlineoverridevirtual

Reimplemented from LIB_TREE_ITEM.

Definition at line 107 of file footprint_info.h.

References LIB_TREE_ITEM::GetDescription().

108  {
109  // Matches are scored by offset from front of string, so inclusion of this spacer
110  // discounts matches found after it.
111  static const wxString discount( wxT( " " ) );
112 
113  return GetKeywords() + discount + GetDescription();
114  }
const wxString & GetDescription() override
const wxString & GetKeywords()
unsigned FOOTPRINT_INFO::GetUniquePadCount ( )
inline

Definition at line 122 of file footprint_info.h.

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

123  {
124  ensure_loaded();
125  return m_unique_pad_count;
126  }
unsigned m_unique_pad_count
Number of unique pads.
virtual int LIB_TREE_ITEM::GetUnitCount ( void  )
inlinevirtualinherited

For items with units, return the number of units.

Reimplemented in LIB_ALIAS.

Definition at line 59 of file lib_tree_item.h.

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

59 { return 0; }
virtual wxString LIB_TREE_ITEM::GetUnitReference ( int  aUnit)
inlinevirtualinherited

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

Reimplemented in LIB_ALIAS.

Definition at line 64 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

64 { return wxEmptyString; }
bool FOOTPRINT_INFO::InLibrary ( const wxString &  aLibrary) const

Test if the FOOTPRINT_INFO object was loaded from aLibrary.

Parameters
aLibraryis the nickname of the library to test.
Returns
true if the FOOTPRINT_INFO object was loaded from aLibrary. Otherwise false.

Definition at line 78 of file footprint_info.cpp.

79 {
80  return aLibrary == m_nickname;
81 }
wxString m_nickname
library as known in FP_LIB_TABLE
virtual bool LIB_TREE_ITEM::IsRoot ( ) const
inlinevirtualinherited

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

Reimplemented in LIB_ALIAS.

Definition at line 54 of file lib_tree_item.h.

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

54 { return true; }
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 152 of file footprint_info.h.

152 { };

Friends And Related Function Documentation

bool operator< ( const FOOTPRINT_INFO item1,
const FOOTPRINT_INFO item2 
)
friend

FOOTPRINT object list sort function.

Definition at line 169 of file footprint_info.h.

170 {
171  int retv = StrNumCmp( item1.m_nickname, item2.m_nickname, INT_MAX, true );
172 
173  if( retv != 0 )
174  return retv < 0;
175 
176  return StrNumCmp( item1.m_fpname, item2.m_fpname, INT_MAX, true ) < 0;
177 }
wxString m_fpname
Module name.
int StrNumCmp(const wxString &aString1, const wxString &aString2, int aLength, bool aIgnoreCase)
Function StrNumCmp is a routine compatible with qsort() to sort by alphabetical order.
Definition: string.cpp:315
wxString m_nickname
library as known in FP_LIB_TABLE

Member Data Documentation

wxString FOOTPRINT_INFO::m_doc
protected

Footprint description.

Definition at line 163 of file footprint_info.h.

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

wxString FOOTPRINT_INFO::m_fpname
protected

Module name.

Definition at line 159 of file footprint_info.h.

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

wxString FOOTPRINT_INFO::m_keywords
protected

Footprint keywords.

Definition at line 164 of file footprint_info.h.

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

bool FOOTPRINT_INFO::m_loaded
protected
wxString FOOTPRINT_INFO::m_nickname
protected

library as known in FP_LIB_TABLE

Definition at line 158 of file footprint_info.h.

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

int FOOTPRINT_INFO::m_num
protected

Order number in the display list.

Definition at line 160 of file footprint_info.h.

Referenced by FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL().

FOOTPRINT_LIST* FOOTPRINT_INFO::m_owner
protected

provides access to FP_LIB_TABLE

Definition at line 152 of file footprint_info.h.

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

unsigned FOOTPRINT_INFO::m_pad_count
protected

Number of pads.

Definition at line 161 of file footprint_info.h.

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

unsigned FOOTPRINT_INFO::m_unique_pad_count
protected

Number of unique pads.

Definition at line 162 of file footprint_info.h.

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


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