KiCad PCB EDA Suite: RESCUE_SYMBOL_LIB_TABLE_CANDIDATE Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

#include <project_rescue.h>

Inheritance diagram for RESCUE_SYMBOL_LIB_TABLE_CANDIDATE:

Public Member Functions
	RESCUE_SYMBOL_LIB_TABLE_CANDIDATE (const LIB_ID &aRequestedId, const LIB_ID &aNewId, LIB_SYMBOL aCacheCandidate, LIB_SYMBOL aLibCandidate, int aUnit=0, int aBodyStyle=0)
	Create RESCUE_CANDIDATE.

	RESCUE_SYMBOL_LIB_TABLE_CANDIDATE ()

virtual LIB_SYMBOL *	GetCacheCandidate () const override
	Get the part that can be loaded from the project cache, if possible, or else NULL.

virtual wxString	GetActionDescription () const override
	Get a description of the action proposed, for displaying in the UI.

virtual bool	PerformAction (RESCUER *aRescuer) override
	Perform the actual rescue action.

virtual wxString	GetRequestedName () const
	Get the name that was originally requested in the schematic.

virtual wxString	GetNewName () const
	Get the name we're proposing changing it to.

virtual LIB_SYMBOL *	GetLibCandidate () const
	Get the part the would be loaded from the libraries, if possible, or else NULL.

int	GetUnit () const

int	GetBodyStyle () const

Static Public Member Functions
static void	FindRescues (RESCUER &aRescuer, boost::ptr_vector< RESCUE_CANDIDATE > &aCandidates)
	Grab all possible RESCUE_SYMBOL_LIB_TABLE_CANDIDATE objects into a vector.

Protected Attributes
wxString	m_requested_name

wxString	m_new_name

LIB_SYMBOL *	m_lib_candidate

int	m_unit

int	m_bodyStyle

Private Attributes
LIB_ID	m_requested_id

LIB_ID	m_new_id

LIB_SYMBOL *	m_cache_candidate

Detailed Description

Definition at line 199 of file project_rescue.h.

Constructor & Destructor Documentation

◆ RESCUE_SYMBOL_LIB_TABLE_CANDIDATE() [1/2]

RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::RESCUE_SYMBOL_LIB_TABLE_CANDIDATE	(	const LIB_ID &	aRequestedId,
		const LIB_ID &	aNewId,
		LIB_SYMBOL *	aCacheCandidate,
		LIB_SYMBOL *	aLibCandidate,
		int	aUnit = 0,
		int	aBodyStyle = 0 )

Create RESCUE_CANDIDATE.

Parameters

aRequestedName	is the name the schematic asks for.
aNewName	is the name we want to change it to.
aCacheCandidate	is the part from the cache.
aLibCandidate	is the part that would be loaded from the library.
aUnit	is the unit of the rescued symbol.
aBodyStyle	is the body style of the rescued symbol.

Definition at line 322 of file project_rescue.cpp.

References Format(), m_cache_candidate, m_new_id, m_requested_id, and RESCUE_CANDIDATE::RESCUE_CANDIDATE().

Referenced by FindRescues().

◆ RESCUE_SYMBOL_LIB_TABLE_CANDIDATE() [2/2]

RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::RESCUE_SYMBOL_LIB_TABLE_CANDIDATE ( )

Definition at line 334 of file project_rescue.cpp.

References m_cache_candidate, m_new_id, m_requested_id, and RESCUE_CANDIDATE::RESCUE_CANDIDATE().

Referenced by FindRescues().

Member Function Documentation

◆ FindRescues()

void RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues	(	RESCUER &	aRescuer,
		boost::ptr_vector< RESCUE_CANDIDATE > &	aCandidates )

static

Grab all possible RESCUE_SYMBOL_LIB_TABLE_CANDIDATE objects into a vector.

Parameters

aRescuer	is the working RESCUER instance.
aCandidates	is the vector the will hold the candidates.

Definition at line 342 of file project_rescue.cpp.

References CTX_LIBID, EscapeString(), findSymbol(), LIB_ID::Format(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), RESCUER::GetPrj(), GetRescueLibraryFileName(), LIB_SYMBOL::GetRootSymbol(), RESCUER::GetSymbols(), SCH_ITEM::GetUnit(), LIB_ID::HasIllegalChars(), LIB_SYMBOL::IsDerived(), name, LIB_SYMBOL::PinsConflictWith(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE(), RESCUER::Schematic(), SchGetLibSymbol(), PROJECT_SCH::SchLibs(), PROJECT_SCH::SchSymbolLibTable(), and UTF8::wx_str().

Referenced by SYMBOL_LIB_TABLE_RESCUER::FindCandidates().

◆ GetActionDescription()

wxString RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::GetActionDescription ( ) const

overridevirtual

Get a description of the action proposed, for displaying in the UI.

Implements RESCUE_CANDIDATE.

Definition at line 440 of file project_rescue.cpp.

References _, m_cache_candidate, RESCUE_CANDIDATE::m_lib_candidate, m_new_id, m_requested_id, and UnescapeString().

◆ GetBodyStyle()

int RESCUE_CANDIDATE::GetBodyStyle ( ) const

inlineinherited

Definition at line 100 of file project_rescue.h.

References m_bodyStyle.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

◆ GetCacheCandidate()

virtual LIB_SYMBOL * RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::GetCacheCandidate ( ) const

inlineoverridevirtual

Get the part that can be loaded from the project cache, if possible, or else NULL.

Reimplemented from RESCUE_CANDIDATE.

Definition at line 226 of file project_rescue.h.

References m_cache_candidate.

◆ GetLibCandidate()

virtual LIB_SYMBOL * RESCUE_CANDIDATE::GetLibCandidate ( ) const

inlinevirtualinherited

Get the part the would be loaded from the libraries, if possible, or else NULL.

Definition at line 97 of file project_rescue.h.

References m_lib_candidate.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

◆ GetNewName()

virtual wxString RESCUE_CANDIDATE::GetNewName ( ) const

inlinevirtualinherited

Get the name we're proposing changing it to.

Definition at line 85 of file project_rescue.h.

References m_new_name.

◆ GetRequestedName()

virtual wxString RESCUE_CANDIDATE::GetRequestedName ( ) const

inlinevirtualinherited

Get the name that was originally requested in the schematic.

Definition at line 80 of file project_rescue.h.

References m_requested_name.

Referenced by DIALOG_RESCUE_EACH::PopulateConflictList(), and DIALOG_RESCUE_EACH::PopulateInstanceList().

◆ GetUnit()

int RESCUE_CANDIDATE::GetUnit ( ) const

inlineinherited

Definition at line 99 of file project_rescue.h.

References m_unit.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

◆ PerformAction()

bool RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction ( RESCUER * aRescuer )

overridevirtual

Perform the actual rescue action.

If successful, this must log the rescue using RESCUER::LogRescue to allow it to be reversed.

Returns: True on success.

Implements RESCUE_CANDIDATE.

Definition at line 466 of file project_rescue.cpp.

References RESCUER::AddSymbol(), LIB_SYMBOL::Flatten(), RESCUER::GetSymbols(), RESCUER::LogRescue(), m_cache_candidate, RESCUE_CANDIDATE::m_lib_candidate, m_new_id, and m_requested_id.

Member Data Documentation

◆ m_bodyStyle

int RESCUE_CANDIDATE::m_bodyStyle

protectedinherited

Definition at line 119 of file project_rescue.h.

Referenced by GetBodyStyle(), and RESCUE_CANDIDATE().

◆ m_cache_candidate

LIB_SYMBOL* RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::m_cache_candidate

private

Definition at line 235 of file project_rescue.h.

Referenced by GetActionDescription(), GetCacheCandidate(), PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE().

◆ m_lib_candidate

LIB_SYMBOL* RESCUE_CANDIDATE::m_lib_candidate

protectedinherited

Definition at line 117 of file project_rescue.h.

Referenced by RESCUE_CACHE_CANDIDATE::GetActionDescription(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::GetActionDescription(), GetLibCandidate(), RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_CASE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), and RESCUE_CANDIDATE().

◆ m_new_id

LIB_ID RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::m_new_id

private

Definition at line 234 of file project_rescue.h.

Referenced by GetActionDescription(), PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE().

◆ m_new_name

wxString RESCUE_CANDIDATE::m_new_name

protectedinherited

Definition at line 116 of file project_rescue.h.

Referenced by RESCUE_CACHE_CANDIDATE::GetActionDescription(), RESCUE_CASE_CANDIDATE::GetActionDescription(), GetNewName(), RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_CASE_CANDIDATE::PerformAction(), and RESCUE_CANDIDATE().

◆ m_requested_id

LIB_ID RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::m_requested_id

private

Definition at line 233 of file project_rescue.h.

Referenced by GetActionDescription(), PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE().

◆ m_requested_name

wxString RESCUE_CANDIDATE::m_requested_name

protectedinherited

Definition at line 115 of file project_rescue.h.

Referenced by RESCUE_CACHE_CANDIDATE::GetActionDescription(), RESCUE_CASE_CANDIDATE::GetActionDescription(), GetRequestedName(), RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_CASE_CANDIDATE::PerformAction(), and RESCUE_CANDIDATE().

◆ m_unit

int RESCUE_CANDIDATE::m_unit

protectedinherited

Definition at line 118 of file project_rescue.h.

Referenced by GetUnit(), and RESCUE_CANDIDATE().

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

RESCUE_SYMBOL_LIB_TABLE_CANDIDATE
Generated on Sun Sep 21 2025 01:05:51 for KiCad PCB EDA Suite by 1.13.2