Back annotation algorithm class used to receive, check, and apply a NETLIST from Pcbnew. More...

#include <backannotate.h>

Classes
struct	PCB_FP_DATA
	Container for Pcbnew footprint data.Map to hold NETLIST footprints data. More...

Public Types
using	PCB_FOOTPRINTS_MAP = std::map< wxString, std::shared_ptr< PCB_FP_DATA > >

using	CHANGELIST_ITEM = std::pair< SCH_REFERENCE, std::shared_ptr< PCB_FP_DATA > >

Public Member Functions
	BACK_ANNOTATE (SCH_EDIT_FRAME *aFrame, REPORTER &aReporter, bool aRelinkFootprints, bool aProcessFootprints, bool aProcessValues, bool aProcessReferences, bool aProcessNetNames, bool aProcessAttributes, bool aDryRun)

	~BACK_ANNOTATE ()

bool	FetchNetlistFromPCB (std::string &aNetlist)
	Get netlist from the Pcbnew. More...

void	PushNewLinksToPCB ()

bool	BackAnnotateSymbols (const std::string &aNetlist)
	Run back annotation algorithm. More...

Private Member Functions
void	getPcbModulesFromString (const std::string &aPayload)
	Parse netlist sent over KiWay express mail interface and fill m_pcbModules. More...

void	getChangeList ()

void	checkForUnusedSymbols ()
	Check if some symbols are not represented in PCB footprints and vice versa. More...

void	applyChangelist ()
	Apply changelist to the schematic. More...

void	processNetNameChange (const wxString &aRef, SCH_PIN aPin, const SCH_CONNECTION aConnection, const wxString &aOldName, const wxString &aNewName)

Private Attributes
REPORTER &	m_reporter

bool	m_matchByReference

bool	m_processFootprints

bool	m_processValues

bool	m_processReferences

bool	m_processNetNames

bool	m_processAttributes

bool	m_dryRun

PCB_FOOTPRINTS_MAP	m_pcbFootprints

SCH_REFERENCE_LIST	m_refs

SCH_MULTI_UNIT_REFERENCE_MAP	m_multiUnitsRefs

std::deque< CHANGELIST_ITEM >	m_changelist

SCH_EDIT_FRAME *	m_frame

int	m_changesCount

bool	m_appendUndo

Detailed Description

Back annotation algorithm class used to receive, check, and apply a NETLIST from Pcbnew.

The following checks are made:

Schematic symbol exists, but linked Pcbnew footprint missing.
Pcbnew footprint exists but no schematic symbol connected to.
Pcbnew footprint is standalone.
Schematic sheet is reused one or more times and user trying to change footprint or value only for few of them.
Schematic symbols share same path.
More than one Pcbnew footprint linked to same path.

Definition at line 55 of file backannotate.h.

Member Typedef Documentation

◆ CHANGELIST_ITEM

using BACK_ANNOTATE::CHANGELIST_ITEM = std::pair<SCH_REFERENCE, std::shared_ptr<PCB_FP_DATA> >

Definition at line 85 of file backannotate.h.

◆ PCB_FOOTPRINTS_MAP

using BACK_ANNOTATE::PCB_FOOTPRINTS_MAP = std::map<wxString, std::shared_ptr<PCB_FP_DATA> >

Definition at line 83 of file backannotate.h.

Constructor & Destructor Documentation

◆ BACK_ANNOTATE()

BACK_ANNOTATE::BACK_ANNOTATE	(	SCH_EDIT_FRAME *	aFrame,
		REPORTER &	aReporter,
		bool	aRelinkFootprints,
		bool	aProcessFootprints,
		bool	aProcessValues,
		bool	aProcessReferences,
		bool	aProcessNetNames,
		bool	aProcessAttributes,
		bool	aDryRun
	)

Definition at line 43 of file backannotate.cpp.

◆ ~BACK_ANNOTATE()

BACK_ANNOTATE::~BACK_ANNOTATE ( )

Definition at line 62 of file backannotate.cpp.

Member Function Documentation

◆ applyChangelist()

void BACK_ANNOTATE::applyChangelist ( )

private

Apply changelist to the schematic.

Definition at line 337 of file backannotate.cpp.

References _, SCH_SYMBOL::GetDNP(), EDA_ITEM::GetFlags(), SCH_REFERENCE::GetFootprint(), SCH_SYMBOL::GetIncludeInBom(), SCH_SYMBOL::GetPin(), SCH_REFERENCE::GetRef(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), SCH_REFERENCE::GetValue(), SCH_SHEET_PATH::LastScreen(), m_appendUndo, m_changelist, m_changesCount, BACK_ANNOTATE::PCB_FP_DATA::m_DNP, m_dryRun, BACK_ANNOTATE::PCB_FP_DATA::m_excludeFromBOM, BACK_ANNOTATE::PCB_FP_DATA::m_footprint, m_frame, BACK_ANNOTATE::PCB_FP_DATA::m_pinMap, m_processAttributes, m_processFootprints, m_processNetNames, m_processReferences, m_processValues, BACK_ANNOTATE::PCB_FP_DATA::m_ref, m_reporter, BACK_ANNOTATE::PCB_FP_DATA::m_value, SCH_CONNECTION::Name(), NO_CLEANUP, pin, processNetNameChange(), SCH_EDIT_FRAME::RecalculateConnections(), REPORTER::ReportHead(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_SYMBOL::SetDNP(), SCH_SYMBOL::SetFootprintFieldText(), SCH_SYMBOL::SetIncludeInBom(), SCH_SYMBOL::SetRef(), SCH_SYMBOL::SetValueFieldText(), SKIP_STRUCT, and SCH_EDIT_FRAME::UpdateNetHighlightStatus().

Referenced by BackAnnotateSymbols().

◆ BackAnnotateSymbols()

bool BACK_ANNOTATE::BackAnnotateSymbols ( const std::string & aNetlist )

Run back annotation algorithm.

If any errors, back annotation doesn't run.

Parameters

aNetlist is the netlist to use for back annotation.

Returns: true if back annotation completed success.

Definition at line 67 of file backannotate.cpp.

References _, applyChangelist(), checkForUnusedSymbols(), getChangeList(), SCH_SHEET_LIST::GetMultiUnitSymbols(), getPcbModulesFromString(), SCHEMATIC::GetSheets(), SCH_SHEET_LIST::GetSymbols(), m_appendUndo, m_changesCount, m_frame, m_matchByReference, m_multiUnitsRefs, m_processAttributes, m_processFootprints, m_processNetNames, m_processReferences, m_processValues, m_refs, m_reporter, REPORTER::ReportTail(), RPT_SEVERITY_ERROR, and SCH_EDIT_FRAME::Schematic().

Referenced by DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), and DIALOG_UPDATE_FROM_PCB::updateData().

◆ checkForUnusedSymbols()

void BACK_ANNOTATE::checkForUnusedSymbols ( )

private

Check if some symbols are not represented in PCB footprints and vice versa.

m_refs must be sorted by path.

Definition at line 294 of file backannotate.cpp.

References _, SCH_REFERENCE_LIST::GetCount(), SCH_SYMBOL::GetIncludeOnBoard(), SCH_REFERENCE::GetSymbol(), m_changelist, m_frame, m_matchByReference, m_refs, m_reporter, SCH_EDIT_FRAME::ReadyToNetlist(), REPORTER::ReportTail(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, and SCH_REFERENCE_LIST::SortByTimeStamp().

Referenced by BackAnnotateSymbols().

◆ FetchNetlistFromPCB()

bool BACK_ANNOTATE::FetchNetlistFromPCB ( std::string & aNetlist )

Get netlist from the Pcbnew.

Parameters

aNetlist is the netlist for the board editor.

Returns: true if success.

Definition at line 95 of file backannotate.cpp.

References _, DisplayErrorMessage(), KIWAY::ExpressMail(), FRAME_PCB_EDITOR, PROJECT::GetProjectFullName(), Kiface(), KIWAY_HOLDER::Kiway(), m_frame, MAIL_PCB_GET_NETLIST, KIWAY_PLAYER::OpenProjectFiles(), PcbFileExtension, KIWAY::Player(), and KIWAY_HOLDER::Prj().

Referenced by DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), and DIALOG_UPDATE_FROM_PCB::updateData().

◆ getChangeList()

void BACK_ANNOTATE::getChangeList ( )

private

Definition at line 237 of file backannotate.cpp.

References _, SCH_REFERENCE_LIST::FindRef(), SCH_REFERENCE_LIST::FindRefByFullPath(), SCH_REFERENCE_LIST::GetCount(), m_changelist, m_matchByReference, m_multiUnitsRefs, m_pcbFootprints, m_refs, m_reporter, REPORTER::ReportTail(), RPT_SEVERITY_ERROR, and SKIP_STRUCT.

Referenced by BackAnnotateSymbols().

◆ getPcbModulesFromString()

void BACK_ANNOTATE::getPcbModulesFromString ( const std::string & aPayload )

private

Parse netlist sent over KiWay express mail interface and fill m_pcbModules.

Parameters

aPayload is the netlist from Pcbnew.

Returns: number of errors during parsing. Create changelist.

Definition at line 130 of file backannotate.cpp.

References _, FROM_UTF8(), m_matchByReference, m_pcbFootprints, m_reporter, name, path, REPORTER::ReportHead(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, and Scan().

Referenced by BackAnnotateSymbols().

◆ processNetNameChange()

void BACK_ANNOTATE::processNetNameChange	(	const wxString &	aRef,
		SCH_PIN *	aPin,
		const SCH_CONNECTION *	aConnection,
		const wxString &	aOldName,
		const wxString &	aNewName
	)