KiCad PCB EDA Suite
|
#include <project_rescue.h>
Public Member Functions | |
RESCUE_CANDIDATE (const wxString &aRequestedName, const wxString &aNewName, LIB_SYMBOL *aLibCandidate, int aUnit, int aBodyStyle) | |
virtual | ~RESCUE_CANDIDATE () |
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 | GetBodyStyle () const |
virtual wxString | GetActionDescription () const =0 |
Get a description of the action proposed, for displaying in the UI. | |
virtual bool | PerformAction (RESCUER *aRescuer)=0 |
Perform the actual rescue action. | |
Protected Attributes | |
wxString | m_requested_name |
wxString | m_new_name |
LIB_SYMBOL * | m_lib_candidate |
int | m_unit |
int | m_bodyStyle |
Definition at line 63 of file project_rescue.h.
|
inline |
Definition at line 66 of file project_rescue.h.
References m_bodyStyle, m_lib_candidate, m_new_name, m_requested_name, and m_unit.
Referenced by RESCUE_CACHE_CANDIDATE::RESCUE_CACHE_CANDIDATE(), RESCUE_CACHE_CANDIDATE::RESCUE_CACHE_CANDIDATE(), RESCUE_CASE_CANDIDATE::RESCUE_CASE_CANDIDATE(), RESCUE_CASE_CANDIDATE::RESCUE_CASE_CANDIDATE(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::RESCUE_SYMBOL_LIB_TABLE_CANDIDATE(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::RESCUE_SYMBOL_LIB_TABLE_CANDIDATE().
|
inlinevirtual |
Definition at line 75 of file project_rescue.h.
|
pure virtual |
Get a description of the action proposed, for displaying in the UI.
Implemented in RESCUE_CACHE_CANDIDATE, RESCUE_CASE_CANDIDATE, and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE.
Referenced by DIALOG_RESCUE_EACH::PopulateConflictList().
|
inline |
Definition at line 100 of file project_rescue.h.
References m_bodyStyle.
Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().
|
inlinevirtual |
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 91 of file project_rescue.h.
Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().
|
inlinevirtual |
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().
|
inlinevirtual |
Get the name we're proposing changing it to.
Definition at line 85 of file project_rescue.h.
References m_new_name.
|
inlinevirtual |
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().
|
inline |
Definition at line 99 of file project_rescue.h.
References m_unit.
Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().
|
pure virtual |
Perform the actual rescue action.
If successful, this must log the rescue using RESCUER::LogRescue to allow it to be reversed.
Implemented in RESCUE_CACHE_CANDIDATE, RESCUE_CASE_CANDIDATE, and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE.
|
protected |
Definition at line 119 of file project_rescue.h.
Referenced by GetBodyStyle(), and RESCUE_CANDIDATE().
|
protected |
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().
|
protected |
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().
|
protected |
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().
|
protected |
Definition at line 118 of file project_rescue.h.
Referenced by GetUnit(), and RESCUE_CANDIDATE().