KiCad PCB EDA Suite: RESCUE_CACHE_CANDIDATE Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

#include <project_rescue.h>

Inheritance diagram for RESCUE_CACHE_CANDIDATE:

Public Member Functions
	RESCUE_CACHE_CANDIDATE (const wxString &aRequestedName, const wxString &aNewName, LIB_SYMBOL aCacheCandidate, LIB_SYMBOL aLibCandidate, int aUnit=0, int aBodyStyle=0)
	Create a RESCUE_CACHE_CANDIDATE.

	RESCUE_CACHE_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_CACHE_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_SYMBOL *	m_cache_candidate

Detailed Description

Definition at line 156 of file project_rescue.h.

Constructor & Destructor Documentation

◆ RESCUE_CACHE_CANDIDATE() [1/2]

RESCUE_CACHE_CANDIDATE::RESCUE_CACHE_CANDIDATE	(	const wxString &	aRequestedName,
		const wxString &	aNewName,
		LIB_SYMBOL *	aCacheCandidate,
		LIB_SYMBOL *	aLibCandidate,
		int	aUnit = 0,
		int	aBodyStyle = 0 )

inline

Create a RESCUE_CACHE_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 179 of file project_rescue.h.

References m_cache_candidate, and RESCUE_CANDIDATE::RESCUE_CANDIDATE().

Referenced by FindRescues().

◆ RESCUE_CACHE_CANDIDATE() [2/2]

RESCUE_CACHE_CANDIDATE::RESCUE_CACHE_CANDIDATE ( )

inline

Definition at line 186 of file project_rescue.h.

References m_cache_candidate, and RESCUE_CANDIDATE::RESCUE_CANDIDATE().

Referenced by FindRescues().

Member Function Documentation

◆ FindRescues()

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

static

Grab all possible RESCUE_CACHE_CANDIDATE objects into a vector.

Parameters

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

Definition at line 208 of file project_rescue.cpp.

References findSymbol(), LIB_SYMBOL::GetLibId(), RESCUER::GetPrj(), RESCUER::GetSymbols(), SCH_ITEM::GetUnit(), LIB_ID::IsValid(), name, LIB_SYMBOL::PinsConflictWith(), RESCUE_CACHE_CANDIDATE(), RESCUE_CACHE_CANDIDATE(), and PROJECT_SCH::SchLibs().

Referenced by LEGACY_RESCUER::FindCandidates().

◆ GetActionDescription()

wxString RESCUE_CACHE_CANDIDATE::GetActionDescription ( ) const

overridevirtual

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

Implements RESCUE_CANDIDATE.

Definition at line 267 of file project_rescue.cpp.

References _, m_cache_candidate, RESCUE_CANDIDATE::m_lib_candidate, RESCUE_CANDIDATE::m_new_name, and RESCUE_CANDIDATE::m_requested_name.

◆ 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_CACHE_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 191 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_CACHE_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 293 of file project_rescue.cpp.

References RESCUER::AddSymbol(), LIB_SYMBOL::Flatten(), RESCUER::GetSymbols(), RESCUER::LogRescue(), m_cache_candidate, RESCUE_CANDIDATE::m_lib_candidate, RESCUE_CANDIDATE::m_new_name, RESCUE_CANDIDATE::m_requested_name, and LIB_ID::SetLibItemName().

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_CACHE_CANDIDATE::m_cache_candidate

private

Definition at line 158 of file project_rescue.h.

Referenced by GetActionDescription(), GetCacheCandidate(), PerformAction(), RESCUE_CACHE_CANDIDATE(), and RESCUE_CACHE_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_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_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_CACHE_CANDIDATE
Generated on Sun Sep 21 2025 01:05:51 for KiCad PCB EDA Suite by 1.13.2