KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
RESCUE_CASE_CANDIDATE Class Reference

#include <project_rescue.h>

Inheritance diagram for RESCUE_CASE_CANDIDATE:
RESCUE_CANDIDATE

Public Member Functions

 RESCUE_CASE_CANDIDATE (const wxString &aRequestedName, const wxString &aNewName, LIB_SYMBOL *aLibCandidate, int aUnit=0, int aConvert=0)
 Create a RESCUE_CANDIDATE.
 
 RESCUE_CASE_CANDIDATE ()
 
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 * GetCacheCandidate () const
 Get the part that can be loaded from the project cache, if possible, or else NULL.
 
virtual LIB_SYMBOL * GetLibCandidate () const
 Get the part the would be loaded from the libraries, if possible, or else NULL.
 
int GetUnit () const
 
int GetConvert () const
 

Static Public Member Functions

static void FindRescues (RESCUER &aRescuer, boost::ptr_vector< RESCUE_CANDIDATE > &aCandidates)
 Grab all possible RESCUE_CASE_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_convert
 

Detailed Description

Definition at line 115 of file project_rescue.h.

Constructor & Destructor Documentation

◆ RESCUE_CASE_CANDIDATE() [1/2]

RESCUE_CASE_CANDIDATE::RESCUE_CASE_CANDIDATE ( const wxString &  aRequestedName,
const wxString &  aNewName,
LIB_SYMBOL *  aLibCandidate,
int  aUnit = 0,
int  aConvert = 0 
)

Create a RESCUE_CANDIDATE.

Parameters
aRequestedNameus the name the schematic asks for.
aNewNameis the name we want to change it to.
aLibCandidateis the part that will give us.
aUnitis the unit of the rescued symbol.
aConvertis the body style of the rescued symbol.

Definition at line 124 of file project_rescue.cpp.

References RESCUE_CANDIDATE::m_convert, RESCUE_CANDIDATE::m_lib_candidate, RESCUE_CANDIDATE::m_new_name, RESCUE_CANDIDATE::m_requested_name, and RESCUE_CANDIDATE::m_unit.

◆ RESCUE_CASE_CANDIDATE() [2/2]

RESCUE_CASE_CANDIDATE::RESCUE_CASE_CANDIDATE ( )
inline

Definition at line 138 of file project_rescue.h.

References RESCUE_CANDIDATE::m_lib_candidate.

Referenced by FindRescues().

Member Function Documentation

◆ FindRescues()

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

Grab all possible RESCUE_CASE_CANDIDATE objects into a vector.

Parameters
aRescueris the working RESCUER instance.
aCandidatesis the vector the will hold the candidates.

Definition at line 138 of file project_rescue.cpp.

References SYMBOL_LIBS::FindLibraryNearEntries(), SYMBOL_LIBS::FindLibSymbol(), LIB_SYMBOL::GetLibId(), RESCUER::GetPrj(), RESCUER::GetSymbols(), LIB_ID::GetUniStringLibItemName(), RESCUE_CASE_CANDIDATE(), and PROJECT_SCH::SchLibs().

Referenced by LEGACY_RESCUER::FindCandidates().

◆ GetActionDescription()

wxString RESCUE_CASE_CANDIDATE::GetActionDescription ( ) const
overridevirtual

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

Implements RESCUE_CANDIDATE.

Definition at line 196 of file project_rescue.cpp.

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

◆ GetCacheCandidate()

virtual LIB_SYMBOL * RESCUE_CANDIDATE::GetCacheCandidate ( ) const
inlinevirtualinherited

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

Reimplemented in RESCUE_CACHE_CANDIDATE, and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE.

Definition at line 82 of file project_rescue.h.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

◆ GetConvert()

int RESCUE_CANDIDATE::GetConvert ( ) const
inlineinherited

Definition at line 92 of file project_rescue.h.

References RESCUE_CANDIDATE::m_convert.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

◆ 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 88 of file project_rescue.h.

References RESCUE_CANDIDATE::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 76 of file project_rescue.h.

References RESCUE_CANDIDATE::m_new_name.

◆ GetRequestedName()

virtual wxString RESCUE_CANDIDATE::GetRequestedName ( ) const
inlinevirtualinherited

Get the name that was originally requested in the schematic.

Definition at line 71 of file project_rescue.h.

References RESCUE_CANDIDATE::m_requested_name.

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

◆ GetUnit()

int RESCUE_CANDIDATE::GetUnit ( ) const
inlineinherited

Definition at line 90 of file project_rescue.h.

References RESCUE_CANDIDATE::m_unit.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

◆ PerformAction()

bool RESCUE_CASE_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 204 of file project_rescue.cpp.

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

Member Data Documentation

◆ m_convert

int RESCUE_CANDIDATE::m_convert
protectedinherited

Definition at line 111 of file project_rescue.h.

Referenced by RESCUE_CANDIDATE::GetConvert(), RESCUE_CACHE_CANDIDATE::RESCUE_CACHE_CANDIDATE(), RESCUE_CASE_CANDIDATE(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::RESCUE_SYMBOL_LIB_TABLE_CANDIDATE().

◆ m_lib_candidate

LIB_SYMBOL* RESCUE_CANDIDATE::m_lib_candidate
protectedinherited

Definition at line 109 of file project_rescue.h.

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

◆ m_new_name

wxString RESCUE_CANDIDATE::m_new_name
protectedinherited

Definition at line 108 of file project_rescue.h.

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

◆ m_requested_name

wxString RESCUE_CANDIDATE::m_requested_name
protectedinherited

Definition at line 107 of file project_rescue.h.

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

◆ m_unit

int RESCUE_CANDIDATE::m_unit
protectedinherited

Definition at line 110 of file project_rescue.h.

Referenced by RESCUE_CANDIDATE::GetUnit(), RESCUE_CACHE_CANDIDATE::RESCUE_CACHE_CANDIDATE(), RESCUE_CASE_CANDIDATE(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::RESCUE_SYMBOL_LIB_TABLE_CANDIDATE().

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