FOOTPRINT_USERS_RESULT Struct Reference

The outcome of a footprint users query, and the JSON encoding used to move it across the Eeschema kiface. More...

#include <symbol_library_query.h>

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

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

Public Attributes
bool	m_Success = false
	False if the query could not be performed, in which case Matches is empty.
std::vector< FOOTPRINT_USER_MATCH >	m_Matches
	The matching symbols, in the order the libraries were searched.
bool	m_IsLimited = false
	True if the result set is limited by the maximum number of results.

Detailed Description

The outcome of a footprint users query, and the JSON encoding used to move it across the Eeschema kiface.

Definition at line 89 of file symbol_library_query.h.

Member Function Documentation

FromJsonStr()

FOOTPRINT_USERS_RESULT FOOTPRINT_USERS_RESULT::FromJsonStr ( const wxString & aJson )

static

Parse the JSON object written by ToJsonStr().

Definition at line 29 of file symbol_library_query.cpp.

References FOOTPRINT_USER_MATCH::m_IsDerived, FOOTPRINT_USER_MATCH::m_MatchedFilter, FOOTPRINT_USER_MATCH::m_MatchedPinMaps, FOOTPRINT_USER_MATCH::m_MatchesFootprintField, FOOTPRINT_USER_MATCH::m_PinCount, FOOTPRINT_USER_MATCH::m_Symbol, LIB_ID::Parse(), and result.

Referenced by QueryFootprintUsers().

ToJsonStr()

wxString FOOTPRINT_USERS_RESULT::ToJsonStr

(

)

const

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

Definition at line 99 of file symbol_library_query.cpp.

References m_IsLimited, m_Matches, and m_Success.

Member Data Documentation

m_IsLimited

bool FOOTPRINT_USERS_RESULT::m_IsLimited = false

True if the result set is limited by the maximum number of results.

Definition at line 98 of file symbol_library_query.h.

Referenced by DIALOG_FOOTPRINT_USERS::showUsers(), and ToJsonStr().

m_Matches

std::vector<FOOTPRINT_USER_MATCH> FOOTPRINT_USERS_RESULT::m_Matches

The matching symbols, in the order the libraries were searched.

Definition at line 95 of file symbol_library_query.h.

Referenced by DIALOG_FOOTPRINT_USERS::showUsers(), and ToJsonStr().

m_Success

bool FOOTPRINT_USERS_RESULT::m_Success = false

False if the query could not be performed, in which case Matches is empty.

Definition at line 92 of file symbol_library_query.h.

Referenced by DIALOG_FOOTPRINT_USERS::showUsers(), and ToJsonStr().

---

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

• symbol_library_query.h
• symbol_library_query.cpp