FOOTPRINT_USERS_QUERY Struct Reference

All the information needed to query the symbol libraries for the symbols using a footprint. More...

#include <symbol_library_query.h>

Public Member Functions
wxString	ToJsonStr () const
	Serialise to the JSON object that carries a query over the Eeschema kiface.

Static Public Member Functions
static FOOTPRINT_USERS_QUERY	FromJsonStr (const wxString &aJson)
	Parse the JSON object written by ToJsonStr().

Public Attributes
LIB_ID	m_Footprint
	The footprint to find the users of.
bool	m_MatchFilters = true
	When true, symbols whose footprint filters select the footprint are returned.
bool	m_MatchFootprintField = true
	When true, symbols whose footprint field names the footprint are returned.
bool	m_MatchPinMaps = true
	When true, symbols whose pin maps are bound to the footprint are returned.
int	m_MaxResults = 400
	Limits the number of returned symbols; zero means no limit.

Detailed Description

All the information needed to query the symbol libraries for the symbols using a footprint.

Definition at line 34 of file symbol_library_query.h.

Member Function Documentation

FromJsonStr()

FOOTPRINT_USERS_QUERY FOOTPRINT_USERS_QUERY::FromJsonStr ( const wxString & aJson )

static

Parse the JSON object written by ToJsonStr().

Definition at line 137 of file symbol_library_query.cpp.

References m_Footprint, m_MatchFilters, m_MatchFootprintField, m_MatchPinMaps, m_MaxResults, and LIB_ID::Parse().

Referenced by SCH::filterFootprintUsers().

ToJsonStr()

wxString FOOTPRINT_USERS_QUERY::ToJsonStr

(

)

const

Serialise to the JSON object that carries a query over the Eeschema kiface.

Definition at line 167 of file symbol_library_query.cpp.

References m_Footprint, m_MatchFilters, m_MatchFootprintField, m_MatchPinMaps, and m_MaxResults.

Referenced by QueryFootprintUsers().

Member Data Documentation

m_Footprint

LIB_ID FOOTPRINT_USERS_QUERY::m_Footprint

The footprint to find the users of.

A footprint with no library nickname still matches references that name it without one.

Definition at line 38 of file symbol_library_query.h.

Referenced by SCH::filterFootprintUsers(), FromJsonStr(), ToJsonStr(), and DIALOG_FOOTPRINT_USERS::updateUsers().

m_MatchFilters

bool FOOTPRINT_USERS_QUERY::m_MatchFilters = true

When true, symbols whose footprint filters select the footprint are returned.

Definition at line 41 of file symbol_library_query.h.

Referenced by SCH::filterFootprintUsers(), FromJsonStr(), ToJsonStr(), and DIALOG_FOOTPRINT_USERS::updateUsers().

m_MatchFootprintField

bool FOOTPRINT_USERS_QUERY::m_MatchFootprintField = true

When true, symbols whose footprint field names the footprint are returned.

Definition at line 44 of file symbol_library_query.h.

Referenced by SCH::filterFootprintUsers(), FromJsonStr(), ToJsonStr(), and DIALOG_FOOTPRINT_USERS::updateUsers().

m_MatchPinMaps

bool FOOTPRINT_USERS_QUERY::m_MatchPinMaps = true

When true, symbols whose pin maps are bound to the footprint are returned.

Definition at line 47 of file symbol_library_query.h.

Referenced by SCH::filterFootprintUsers(), FromJsonStr(), ToJsonStr(), and DIALOG_FOOTPRINT_USERS::updateUsers().

m_MaxResults

int FOOTPRINT_USERS_QUERY::m_MaxResults = 400

Limits the number of returned symbols; zero means no limit.

Definition at line 50 of file symbol_library_query.h.

Referenced by SCH::filterFootprintUsers(), FromJsonStr(), ToJsonStr(), and DIALOG_FOOTPRINT_USERS::updateUsers().

---

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

• symbol_library_query.h
• symbol_library_query.cpp