link_imported_footprints.h File Reference

#include <map>
#include <wx/string.h>

Go to the source code of this file.

Functions
int	LinkImportedFootprints (SCHEMATIC &aSchematic, const std::map< wxString, wxString > &aFootprintsByRef, REPORTER &aReporter)
	Point the Footprint field of each symbol at the footprint with the same reference on the imported board.

Function Documentation

LinkImportedFootprints()

int LinkImportedFootprints	(	SCHEMATIC &	aSchematic,
		const std::map< wxString, wxString > &	aFootprintsByRef,
		REPORTER &	aReporter )

Point the Footprint field of each symbol at the footprint with the same reference on the imported board.

An empty field is filled. A field that holds a value is only changed when it is in the same library as the board's footprint, which is how the import cache renames a footprint, and a footprint with no name is never used. Shared by the project manager's import and the kicad-cli import job.

Parameters

[in]	aSchematic	is the imported schematic whose symbols are updated.
[in]	aFootprintsByRef	maps a board reference to the full LIB_ID of its footprint.
[in]	aReporter	receives a count of the symbols linked.

Returns

the number of symbols linked.

Definition at line 32 of file link_imported_footprints.cpp.

References _, FOOTPRINT, SCH_SYMBOL::GetField(), LIB_ID::GetLibNickname(), SCH_SYMBOL::GetRef(), SCH_FIELD::GetText(), SCHEMATIC::Hierarchy(), SCH_SCREEN::Items(), EE_RTREE::OfType(), LIB_ID::Parse(), path, REPORTER::Report(), RPT_SEVERITY_INFO, and SCH_SYMBOL_T.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and SCH_EDIT_FRAME::KiwayMailIn().