FOOTPRINT_USER_MATCH Struct Reference

One symbol that uses a footprint, and the reason it matched. More...

#include <symbol_library_query.h>

Public Attributes
LIB_ID	m_Symbol
	The "library:symbol" name of the matching symbol.
int	m_PinCount = 0
	The number of pins of the matching symbol.
bool	m_IsDerived = false
	True when the symbol is derived from another symbol rather than being a root symbol.
wxString	m_MatchedFilter
	The footprint filter that selected the footprint, empty when the match did not come from a filter.
bool	m_MatchesFootprintField = false
	True when the symbol's footprint field names the footprint.
std::vector< wxString >	m_MatchedPinMaps
	The names of the symbol's pin maps that are bound to the footprint, in the order they were found; empty when none is.

Detailed Description

One symbol that uses a footprint, and the reason it matched.

Definition at line 63 of file symbol_library_query.h.

Member Data Documentation

m_IsDerived

bool FOOTPRINT_USER_MATCH::m_IsDerived = false

True when the symbol is derived from another symbol rather than being a root symbol.

Definition at line 72 of file symbol_library_query.h.

Referenced by FOOTPRINT_USERS_RESULT::FromJsonStr(), and SCH::symbolUsesFootprint().

m_MatchedFilter

wxString FOOTPRINT_USER_MATCH::m_MatchedFilter

The footprint filter that selected the footprint, empty when the match did not come from a filter.

Definition at line 76 of file symbol_library_query.h.

Referenced by FOOTPRINT_USERS_RESULT::FromJsonStr(), and HandleJobConfig().

m_MatchedPinMaps

std::vector<wxString> FOOTPRINT_USER_MATCH::m_MatchedPinMaps

The names of the symbol's pin maps that are bound to the footprint, in the order they were found; empty when none is.

Definition at line 83 of file symbol_library_query.h.

Referenced by FOOTPRINT_USERS_RESULT::FromJsonStr(), and SCH::symbolPinMapsBindFootprint().

m_MatchesFootprintField

bool FOOTPRINT_USER_MATCH::m_MatchesFootprintField = false

True when the symbol's footprint field names the footprint.

Definition at line 79 of file symbol_library_query.h.

Referenced by FOOTPRINT_USERS_RESULT::FromJsonStr(), and SCH::symbolFootprintFieldNamesFootprint().

m_PinCount

int FOOTPRINT_USER_MATCH::m_PinCount = 0

The number of pins of the matching symbol.

Definition at line 69 of file symbol_library_query.h.

Referenced by FOOTPRINT_USERS_RESULT::FromJsonStr(), and SCH::symbolUsesFootprint().

m_Symbol

LIB_ID FOOTPRINT_USER_MATCH::m_Symbol

The "library:symbol" name of the matching symbol.

Definition at line 66 of file symbol_library_query.h.

Referenced by FOOTPRINT_USERS_RESULT::FromJsonStr(), DIALOG_FOOTPRINT_USERS::showUsers(), and SCH::symbolUsesFootprint().

---

The documentation for this struct was generated from the following file:

• symbol_library_query.h