KiCad PCB EDA Suite
Loading...
Searching...
No Matches
FOOTPRINT_INFO_IMPL Class Reference

#include <footprint_info_impl.h>

Inheritance diagram for FOOTPRINT_INFO_IMPL:
FOOTPRINT_INFO LIB_TREE_ITEM

Public Member Functions

 FOOTPRINT_INFO_IMPL (FOOTPRINT_LIST *aOwner, const wxString &aNickname, const wxString &aFootprintName)
 
 FOOTPRINT_INFO_IMPL (const wxString &aNickname, const wxString &aFootprintName, const wxString &aDescription, const wxString &aKeywords, int aOrderNum, unsigned int aPadCount, unsigned int aUniquePadCount)
 
 FOOTPRINT_INFO_IMPL (const wxString &aNickname, const wxString &aFootprintName)
 
const wxString & GetFootprintName () const
 
wxString GetLibNickname () const override
 
wxString GetName () const override
 
int GetPinCount () override
 The pin count for symbols or the unique pad count for footprints.
 
LIB_ID GetLIB_ID () const override
 
wxString GetDesc () override
 
wxString GetKeywords ()
 
std::vector< SEARCH_TERMGetSearchTerms () override
 
unsigned GetPadCount ()
 
unsigned GetUniquePadCount ()
 
int GetOrderNum ()
 
bool InLibrary (const wxString &aLibrary) const
 Test if the FOOTPRINT_INFO object was loaded from aLibrary.
 
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.
 
virtual bool IsRoot () const
 For items having aliases, IsRoot() indicates the principal item.
 
virtual wxString GetFootprint ()
 For items with footprint fields.
 
virtual int GetSubUnitCount () const
 For items with units, return the number of units.
 
virtual wxString GetUnitName (int aUnit) const
 For items with units, return an identifier for unit x.
 

Protected Member Functions

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

Protected Attributes

FOOTPRINT_LISTm_owner
 provides access to FP_LIB_TABLE
 
bool m_loaded
 
wxString m_nickname
 library as known in FP_LIB_TABLE
 
wxString m_fpname
 Module name.
 
int m_num
 Order number in the display list.
 
unsigned m_pad_count
 Number of pads.
 
unsigned m_unique_pad_count
 Number of unique pads.
 
wxString m_doc
 Footprint description.
 
wxString m_keywords
 Footprint keywords.
 

Detailed Description

Definition at line 34 of file footprint_info_impl.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_INFO_IMPL() [1/3]

FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL ( FOOTPRINT_LIST * aOwner,
const wxString & aNickname,
const wxString & aFootprintName )
inline

◆ FOOTPRINT_INFO_IMPL() [2/3]

FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL ( const wxString & aNickname,
const wxString & aFootprintName,
const wxString & aDescription,
const wxString & aKeywords,
int aOrderNum,
unsigned int aPadCount,
unsigned int aUniquePadCount )
inline

◆ FOOTPRINT_INFO_IMPL() [3/3]

FOOTPRINT_INFO_IMPL::FOOTPRINT_INFO_IMPL ( const wxString & aNickname,
const wxString & aFootprintName )
inline

Member Function Documentation

◆ ensure_loaded()

void FOOTPRINT_INFO::ensure_loaded ( )
inlineprotectedinherited

Definition at line 130 of file footprint_info.h.

References load(), and m_loaded.

Referenced by GetDesc(), GetKeywords(), GetOrderNum(), GetPadCount(), and GetUniquePadCount().

◆ 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 57 of file lib_tree_item.h.

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

◆ GetDesc()

wxString FOOTPRINT_INFO::GetDesc ( )
inlineoverridevirtualinherited

Implements LIB_TREE_ITEM.

Definition at line 82 of file footprint_info.h.

References ensure_loaded(), and m_doc.

Referenced by CVPCB_MAINFRAME::DisplayStatus(), and GetSearchTerms().

◆ GetFootprint()

virtual wxString LIB_TREE_ITEM::GetFootprint ( )
inlinevirtualinherited

For items with footprint fields.

Reimplemented in LIB_SYMBOL.

Definition at line 69 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM().

◆ GetFootprintName()

const wxString & FOOTPRINT_INFO::GetFootprintName ( ) const
inlineinherited

◆ GetKeywords()

wxString FOOTPRINT_INFO::GetKeywords ( )
inlineinherited

Definition at line 88 of file footprint_info.h.

References ensure_loaded(), and m_keywords.

Referenced by CVPCB_MAINFRAME::DisplayStatus(), and GetSearchTerms().

◆ GetLIB_ID()

LIB_ID FOOTPRINT_INFO::GetLIB_ID ( ) const
inlineoverridevirtualinherited

Implements LIB_TREE_ITEM.

Definition at line 77 of file footprint_info.h.

References m_fpname, and m_nickname.

Referenced by GetSearchTerms().

◆ GetLibNickname()

wxString FOOTPRINT_INFO::GetLibNickname ( ) const
inlineoverridevirtualinherited

◆ GetName()

wxString FOOTPRINT_INFO::GetName ( ) const
inlineoverridevirtualinherited

Implements LIB_TREE_ITEM.

Definition at line 73 of file footprint_info.h.

References m_fpname.

Referenced by GetSearchTerms().

◆ GetOrderNum()

int FOOTPRINT_INFO::GetOrderNum ( )
inlineinherited

Definition at line 108 of file footprint_info.h.

References ensure_loaded(), and m_num.

◆ GetPadCount()

unsigned FOOTPRINT_INFO::GetPadCount ( )
inlineinherited

Definition at line 96 of file footprint_info.h.

References ensure_loaded(), and m_pad_count.

◆ GetPinCount()

int FOOTPRINT_INFO::GetPinCount ( )
inlineoverridevirtualinherited

The pin count for symbols or the unique pad count for footprints.

Reimplemented from LIB_TREE_ITEM.

Definition at line 75 of file footprint_info.h.

References GetUniquePadCount().

◆ GetSearchTerms()

std::vector< SEARCH_TERM > FOOTPRINT_INFO::GetSearchTerms ( )
overridevirtualinherited

Reimplemented from LIB_TREE_ITEM.

Definition at line 73 of file footprint_info.cpp.

References Format(), GetDesc(), GetKeywords(), GetLIB_ID(), GetLibNickname(), and GetName().

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

◆ GetSubUnitCount()

virtual int LIB_TREE_ITEM::GetSubUnitCount ( ) const
inlinevirtualinherited

For items with units, return the number of units.

Reimplemented in LIB_SYMBOL.

Definition at line 79 of file lib_tree_item.h.

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

◆ GetUniquePadCount()

unsigned FOOTPRINT_INFO::GetUniquePadCount ( )
inlineinherited

Definition at line 102 of file footprint_info.h.

References ensure_loaded(), and m_unique_pad_count.

Referenced by GetPinCount(), and FOOTPRINT_FILTER::ITERATOR::PinCountMatch().

◆ GetUnitName()

virtual wxString LIB_TREE_ITEM::GetUnitName ( int aUnit) const
inlinevirtualinherited

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

Reimplemented in LIB_SYMBOL.

Definition at line 84 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

◆ InLibrary()

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

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 94 of file footprint_info.cpp.

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 64 of file lib_tree_item.h.

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

◆ load()

Member Data Documentation

◆ m_doc

wxString FOOTPRINT_INFO::m_doc
protectedinherited

◆ m_fpname

◆ m_keywords

wxString FOOTPRINT_INFO::m_keywords
protectedinherited

◆ m_loaded

◆ m_nickname

◆ m_num

int FOOTPRINT_INFO::m_num
protectedinherited

Order number in the display list.

Definition at line 145 of file footprint_info.h.

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

◆ m_owner

◆ m_pad_count

unsigned FOOTPRINT_INFO::m_pad_count
protectedinherited

◆ m_unique_pad_count

unsigned FOOTPRINT_INFO::m_unique_pad_count
protectedinherited

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