KiCad PCB EDA Suite
RESCUE_CANDIDATE Class Referenceabstract

#include <project_rescue.h>

Inheritance diagram for RESCUE_CANDIDATE:
RESCUE_CACHE_CANDIDATE RESCUE_CASE_CANDIDATE RESCUE_SYMBOL_LIB_TABLE_CANDIDATE

Public Member Functions

virtual ~RESCUE_CANDIDATE ()
 
virtual wxString GetRequestedName () const
 Get the name that was originally requested in the schematic. More...
 
virtual wxString GetNewName () const
 Get the name we're proposing changing it to. More...
 
virtual LIB_PARTGetCacheCandidate () const
 Get the part that can be loaded from the project cache, if possible, or else NULL. More...
 
virtual LIB_PARTGetLibCandidate () const
 Get the part the would be loaded from the libraries, if possible, or else NULL. More...
 
virtual wxString GetActionDescription () const =0
 Get a description of the action proposed, for displaying in the UI. More...
 
virtual bool PerformAction (RESCUER *aRescuer)=0
 Perform the actual rescue action. More...
 

Protected Attributes

wxString m_requested_name
 
wxString m_new_name
 
LIB_PARTm_lib_candidate
 

Detailed Description

Definition at line 66 of file project_rescue.h.

Constructor & Destructor Documentation

◆ ~RESCUE_CANDIDATE()

virtual RESCUE_CANDIDATE::~RESCUE_CANDIDATE ( )
inlinevirtual

Definition at line 74 of file project_rescue.h.

74 {}

Member Function Documentation

◆ GetActionDescription()

virtual wxString RESCUE_CANDIDATE::GetActionDescription ( ) const
pure virtual

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

Implemented in RESCUE_SYMBOL_LIB_TABLE_CANDIDATE, RESCUE_CACHE_CANDIDATE, and RESCUE_CASE_CANDIDATE.

Referenced by DIALOG_RESCUE_EACH::PopulateConflictList().

◆ GetCacheCandidate()

virtual LIB_PART* RESCUE_CANDIDATE::GetCacheCandidate ( ) const
inlinevirtual

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

Reimplemented in RESCUE_SYMBOL_LIB_TABLE_CANDIDATE, and RESCUE_CACHE_CANDIDATE.

Definition at line 90 of file project_rescue.h.

90 { return NULL; }

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

◆ GetLibCandidate()

virtual LIB_PART* RESCUE_CANDIDATE::GetLibCandidate ( ) const
inlinevirtual

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

Definition at line 96 of file project_rescue.h.

96 { return m_lib_candidate; }
LIB_PART * m_lib_candidate

References m_lib_candidate.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

◆ GetNewName()

virtual wxString RESCUE_CANDIDATE::GetNewName ( ) const
inlinevirtual

Get the name we're proposing changing it to.

Definition at line 84 of file project_rescue.h.

84 { return m_new_name; }

References m_new_name.

◆ GetRequestedName()

virtual wxString RESCUE_CANDIDATE::GetRequestedName ( ) const
inlinevirtual

Get the name that was originally requested in the schematic.

Definition at line 79 of file project_rescue.h.

79 { return m_requested_name; }
wxString m_requested_name

References m_requested_name.

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

◆ PerformAction()

virtual bool RESCUE_CANDIDATE::PerformAction ( RESCUER aRescuer)
pure virtual

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.

Implemented in RESCUE_SYMBOL_LIB_TABLE_CANDIDATE, RESCUE_CACHE_CANDIDATE, and RESCUE_CASE_CANDIDATE.

Member Data Documentation

◆ m_lib_candidate

◆ m_new_name

◆ m_requested_name


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