KiCad PCB EDA Suite
RESCUE_CANDIDATE Class Referenceabstract

#include <project_rescue.h>

Inheritance diagram for RESCUE_CANDIDATE:
RESCUE_CACHE_CANDIDATE RESCUE_CASE_CANDIDATE

Public Member Functions

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

Detailed Description

Definition at line 55 of file project_rescue.h.

Constructor & Destructor Documentation

virtual RESCUE_CANDIDATE::~RESCUE_CANDIDATE ( )
inlinevirtual

Definition at line 58 of file project_rescue.h.

58 {}

Member Function Documentation

virtual wxString RESCUE_CANDIDATE::GetActionDescription ( ) const
pure virtual

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

Implemented in RESCUE_CACHE_CANDIDATE, and RESCUE_CASE_CANDIDATE.

Referenced by DIALOG_RESCUE_EACH::PopulateConflictList().

virtual LIB_PART* RESCUE_CANDIDATE::GetCacheCandidate ( ) const
inlinevirtual

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

Reimplemented in RESCUE_CACHE_CANDIDATE.

Definition at line 77 of file project_rescue.h.

Referenced by DIALOG_RESCUE_EACH::OnHandleCachePreviewRepaint().

77 { return NULL; }
virtual LIB_PART* RESCUE_CANDIDATE::GetLibCandidate ( ) const
inlinevirtual

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

Reimplemented in RESCUE_CACHE_CANDIDATE, and RESCUE_CASE_CANDIDATE.

Definition at line 84 of file project_rescue.h.

Referenced by DIALOG_RESCUE_EACH::OnHandleLibraryPreviewRepaint().

84 { return NULL; }
virtual wxString RESCUE_CANDIDATE::GetNewName ( ) const
pure virtual

Function GetNewName Get the name we're proposing changing it to.

Implemented in RESCUE_CACHE_CANDIDATE, and RESCUE_CASE_CANDIDATE.

virtual wxString RESCUE_CANDIDATE::GetRequestedName ( ) const
pure virtual

Function GetRequestedName Get the name that was originally requested in the schematic.

Implemented in RESCUE_CACHE_CANDIDATE, and RESCUE_CASE_CANDIDATE.

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

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

Function PerformAction 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_CACHE_CANDIDATE, and RESCUE_CASE_CANDIDATE.


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