#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

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_TERM >	GetSearchTerms () 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	GetUnitReference (int aUnit)
	For items with units, return an identifier for unit x.

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

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

Protected Member Functions
void	ensure_loaded ()

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

Protected Attributes
FOOTPRINT_LIST *	m_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.

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

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.

Member Function Documentation

◆ ensure_loaded()

void FOOTPRINT_INFO::ensure_loaded ( )

inlineprotected

Definition at line 130 of file footprint_info.h.

◆ 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 ( )

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 82 of file footprint_info.h.

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

inline

Definition at line 69 of file footprint_info.h.

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

◆ GetKeywords()

wxString FOOTPRINT_INFO::GetKeywords ( )

inline

Definition at line 88 of file footprint_info.h.

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

◆ GetLIB_ID()

LIB_ID FOOTPRINT_INFO::GetLIB_ID ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 77 of file footprint_info.h.

◆ GetLibNickname()

wxString FOOTPRINT_INFO::GetLibNickname ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 71 of file footprint_info.h.

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

◆ GetName()

wxString FOOTPRINT_INFO::GetName ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 73 of file footprint_info.h.

Referenced by GetSearchTerms().

◆ GetOrderNum()

int FOOTPRINT_INFO::GetOrderNum ( )

inline

Definition at line 108 of file footprint_info.h.

◆ GetPadCount()

unsigned FOOTPRINT_INFO::GetPadCount ( )

inline

Definition at line 96 of file footprint_info.h.

◆ GetPinCount()

int FOOTPRINT_INFO::GetPinCount ( )

inlineoverridevirtual

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.

◆ GetSearchTerms()

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

overridevirtual

Reimplemented from LIB_TREE_ITEM.

Definition at line 73 of file footprint_info.cpp.

References GetDesc(), GetKeywords(), 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 ( )

inline

Definition at line 102 of file footprint_info.h.

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

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

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

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 94 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

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 92 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()

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 137 of file footprint_info.h.

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

Member Data Documentation

◆ m_doc

wxString FOOTPRINT_INFO::m_doc

protected

Footprint description.

Definition at line 148 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 144 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 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_loaded

bool FOOTPRINT_INFO::m_loaded

protected

Definition at line 141 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 143 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 145 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 139 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 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_unique_pad_count

unsigned FOOTPRINT_INFO::m_unique_pad_count

protected

Number of unique pads.

Definition at line 147 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()

◆ GetDesc()

◆ GetFootprint()

◆ GetFootprintName()

◆ GetKeywords()

◆ GetLIB_ID()

◆ GetLibNickname()

◆ GetName()

◆ GetOrderNum()

◆ GetPadCount()

◆ GetPinCount()

◆ GetSearchTerms()

◆ GetSubUnitCount()

◆ GetUniquePadCount()

◆ 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