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

#include <project_rescue.h>

Inheritance diagram for SYMBOL_LIB_TABLE_RESCUER:
RESCUER

Public Member Functions

 SYMBOL_LIB_TABLE_RESCUER (PROJECT &aProject, SCHEMATIC *aSchematic, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackeEndType)
 
virtual ~SYMBOL_LIB_TABLE_RESCUER ()
 
virtual void FindCandidates () override
 Populate the RESCUER with all possible candidates. More...
 
virtual void InvokeDialog (wxWindow *aParent, bool aAskShowAgain) override
 Display a dialog to allow the user to select rescues. More...
 
virtual void OpenRescueLibrary () override
 
virtual bool WriteRescueLibrary (wxWindow *aParent) override
 Write the rescue library. More...
 
virtual void AddSymbol (LIB_SYMBOL *aNewSymbol) override
 
void RemoveDuplicates ()
 Filter out duplicately named rescue candidates. More...
 
size_t GetCandidateCount ()
 Return the number of rescue candidates found. More...
 
size_t GetChosenCandidateCount ()
 Get the number of rescue candidates chosen by the user. More...
 
std::vector< SCH_SYMBOL * > * GetSymbols ()
 Get the list of symbols that need rescued. More...
 
PROJECT * GetPrj ()
 Return the #SCH_PROJECT object for access to the symbol libraries. More...
 
SCHEMATIC * Schematic ()
 
void LogRescue (SCH_SYMBOL *aSymbol, const wxString &aOldName, const wxString &aNewName)
 Used by individual RESCUE_CANDIDATE objects to log a rescue for undoing. More...
 
bool DoRescues ()
 Perform all chosen rescue actions, logging them to be undone if necessary. More...
 
void UndoRescues ()
 Reverse the effects of all rescues on the project. More...
 

Static Public Member Functions

static bool RescueProject (wxWindow *aParent, RESCUER &aRescuer, bool aRunningOnDemand)
 

Protected Attributes

std::vector< SCH_SYMBOL * > m_symbols
 
PROJECT * m_prj
 
SCHEMATIC * m_schematic
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_galBackEndType
 
SCH_SHEET_PATH * m_currentSheet
 
boost::ptr_vector< RESCUE_CANDIDATE > m_all_candidates
 
std::vector< RESCUE_CANDIDATE * > m_chosen_candidates
 
std::vector< RESCUE_LOG > m_rescue_log
 

Private Attributes

std::vector< std::unique_ptr< LIB_SYMBOL > > m_rescueLibSymbols
 
std::unique_ptr< STRING_UTF8_MAP > m_properties
 Library plugin properties. More...
 

Detailed Description

Definition at line 358 of file project_rescue.h.

Constructor & Destructor Documentation

◆ SYMBOL_LIB_TABLE_RESCUER()

SYMBOL_LIB_TABLE_RESCUER::SYMBOL_LIB_TABLE_RESCUER ( PROJECT &  aProject,
SCHEMATIC *  aSchematic,
SCH_SHEET_PATH *  aCurrentSheet,
EDA_DRAW_PANEL_GAL::GAL_TYPE  aGalBackeEndType 
)

Definition at line 801 of file project_rescue.cpp.

References m_properties.

◆ ~SYMBOL_LIB_TABLE_RESCUER()

virtual SYMBOL_LIB_TABLE_RESCUER::~SYMBOL_LIB_TABLE_RESCUER ( )
inlinevirtual

Definition at line 365 of file project_rescue.h.

Member Function Documentation

◆ AddSymbol()

void SYMBOL_LIB_TABLE_RESCUER::AddSymbol ( LIB_SYMBOL *  aNewSymbol)
overridevirtual

Implements RESCUER.

Definition at line 916 of file project_rescue.cpp.

References m_rescueLibSymbols.

◆ DoRescues()

bool RESCUER::DoRescues ( )
inherited

Perform all chosen rescue actions, logging them to be undone if necessary.

Returns
True on success

Definition at line 565 of file project_rescue.cpp.

References RESCUER::m_chosen_candidates.

Referenced by RESCUER::RescueProject().

◆ FindCandidates()

void SYMBOL_LIB_TABLE_RESCUER::FindCandidates ( )
overridevirtual

Populate the RESCUER with all possible candidates.

Implements RESCUER.

Definition at line 810 of file project_rescue.cpp.

References RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), and RESCUER::m_all_candidates.

◆ GetCandidateCount()

size_t RESCUER::GetCandidateCount ( )
inlineinherited

Return the number of rescue candidates found.

Definition at line 276 of file project_rescue.h.

References RESCUER::m_all_candidates.

Referenced by SCH_EDITOR_CONTROL::rescueProject(), RESCUER::RescueProject(), and DIALOG_RESCUE_EACH::TransferDataFromWindow().

◆ GetChosenCandidateCount()

size_t RESCUER::GetChosenCandidateCount ( )
inlineinherited

Get the number of rescue candidates chosen by the user.

Definition at line 281 of file project_rescue.h.

References RESCUER::m_chosen_candidates.

Referenced by RESCUER::RescueProject().

◆ GetPrj()

PROJECT * RESCUER::GetPrj ( )
inlineinherited

Return the #SCH_PROJECT object for access to the symbol libraries.

Definition at line 291 of file project_rescue.h.

References RESCUER::m_prj.

Referenced by RESCUE_CASE_CANDIDATE::FindRescues(), RESCUE_CACHE_CANDIDATE::FindRescues(), and RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues().

◆ GetSymbols()

std::vector< SCH_SYMBOL * > * RESCUER::GetSymbols ( )
inlineinherited

Get the list of symbols that need rescued.

Definition at line 286 of file project_rescue.h.

References RESCUER::m_symbols.

Referenced by RESCUE_CASE_CANDIDATE::FindRescues(), RESCUE_CACHE_CANDIDATE::FindRescues(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), RESCUE_CASE_CANDIDATE::PerformAction(), RESCUE_CACHE_CANDIDATE::PerformAction(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), and DIALOG_RESCUE_EACH::PopulateInstanceList().

◆ InvokeDialog()

void SYMBOL_LIB_TABLE_RESCUER::InvokeDialog ( wxWindow *  aParent,
bool  aAskShowAgain 
)
overridevirtual

Display a dialog to allow the user to select rescues.

Parameters
aAskShowAgain- whether the "Never Show Again" button should be visible

Implements RESCUER.

Definition at line 816 of file project_rescue.cpp.

References InvokeDialogRescueEach(), RESCUER::m_currentSheet, and RESCUER::m_galBackEndType.

◆ LogRescue()

void RESCUER::LogRescue ( SCH_SYMBOL *  aSymbol,
const wxString &  aOldName,
const wxString &  aNewName 
)
inherited

Used by individual RESCUE_CANDIDATE objects to log a rescue for undoing.

Definition at line 554 of file project_rescue.cpp.

References RESCUER::m_rescue_log, RESCUE_LOG::new_name, RESCUE_LOG::old_name, and RESCUE_LOG::symbol.

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

◆ OpenRescueLibrary()

void SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary ( )
overridevirtual

Implements RESCUER.

Definition at line 823 of file project_rescue.cpp.

References SCH_IO_MGR::EnumFromStr(), SYMBOL_LIB_TABLE::FindRow(), GetRescueLibraryFileName(), SYMBOL_LIB_TABLE_ROW::GetType(), KiCadSymbolLibFileExtension, SYMBOL_LIB_TABLE::LoadSymbolLib(), RESCUER::m_prj, m_rescueLibSymbols, RESCUER::m_schematic, SCH_LEGACY_PLUGIN::PropBuffering, and PROJECT_SCH::SchSymbolLibTable().

◆ RemoveDuplicates()

void RESCUER::RemoveDuplicates ( )
inherited

Filter out duplicately named rescue candidates.

Definition at line 636 of file project_rescue.cpp.

References RESCUER::m_all_candidates.

Referenced by RESCUER::RescueProject().

◆ RescueProject()

bool RESCUER::RescueProject ( wxWindow *  aParent,
RESCUER &  aRescuer,
bool  aRunningOnDemand 
)
staticinherited

Definition at line 590 of file project_rescue.cpp.

References _, RESCUER::DoRescues(), RESCUER::FindCandidates(), RESCUER::GetCandidateCount(), RESCUER::GetChosenCandidateCount(), RESCUER::InvokeDialog(), RESCUER::OpenRescueLibrary(), RESCUER::RemoveDuplicates(), RESCUER::UndoRescues(), and RESCUER::WriteRescueLibrary().

Referenced by DIALOG_SYMBOL_REMAP::OnRemapSymbols(), and SCH_EDITOR_CONTROL::rescueProject().

◆ Schematic()

SCHEMATIC * RESCUER::Schematic ( )
inlineinherited

Definition at line 293 of file project_rescue.h.

References RESCUER::m_schematic.

Referenced by RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues().

◆ UndoRescues()

void RESCUER::UndoRescues ( )
inherited

Reverse the effects of all rescues on the project.

Definition at line 577 of file project_rescue.cpp.

References RESCUER::m_rescue_log, and LIB_ID::SetLibItemName().

Referenced by RESCUER::RescueProject().

◆ WriteRescueLibrary()

bool SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary ( wxWindow *  aParent)
overridevirtual

Write the rescue library.

Called after successful PerformAction()s. If this fails, undo the actions.

Returns
True on success.

Implements RESCUER.

Definition at line 855 of file project_rescue.cpp.

References _, DisplayErrorMessage(), PROJECT::ELEM_SYMBOL_LIB_TABLE, SCH_IO_MGR::EnumFromStr(), SYMBOL_LIB_TABLE::FindRow(), PROJECT::GetProjectPath(), GetRescueLibraryFileName(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), SYMBOL_LIB_TABLE_ROW::GetType(), LIB_TABLE::InsertRow(), KiCadSymbolLibFileExtension, RESCUER::m_prj, m_properties, m_rescueLibSymbols, RESCUER::m_schematic, SCHEMATIC::Root(), LIB_TABLE::Save(), SCH_PLUGIN::SaveLibrary(), SCH_PLUGIN::SaveSymbol(), PROJECT_SCH::SchSymbolLibTable(), PROJECT::SetElem(), SCH_SCREENS::UpdateSymbolLinks(), and IO_ERROR::What().

Member Data Documentation

◆ m_all_candidates

boost::ptr_vector<RESCUE_CANDIDATE> RESCUER::m_all_candidates
protectedinherited

Definition at line 323 of file project_rescue.h.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict(), LEGACY_RESCUER::FindCandidates(), FindCandidates(), RESCUER::GetCandidateCount(), DIALOG_RESCUE_EACH::PopulateConflictList(), DIALOG_RESCUE_EACH::PopulateInstanceList(), RESCUER::RemoveDuplicates(), and DIALOG_RESCUE_EACH::TransferDataFromWindow().

◆ m_chosen_candidates

std::vector<RESCUE_CANDIDATE*> RESCUER::m_chosen_candidates
protectedinherited

Definition at line 324 of file project_rescue.h.

Referenced by RESCUER::DoRescues(), RESCUER::GetChosenCandidateCount(), DIALOG_RESCUE_EACH::OnCancelClick(), DIALOG_RESCUE_EACH::OnNeverShowClick(), and DIALOG_RESCUE_EACH::TransferDataFromWindow().

◆ m_currentSheet

SCH_SHEET_PATH* RESCUER::m_currentSheet
protectedinherited

Definition at line 321 of file project_rescue.h.

Referenced by LEGACY_RESCUER::InvokeDialog(), InvokeDialog(), and RESCUER::RESCUER().

◆ m_galBackEndType

EDA_DRAW_PANEL_GAL::GAL_TYPE RESCUER::m_galBackEndType
protectedinherited

Definition at line 320 of file project_rescue.h.

Referenced by LEGACY_RESCUER::InvokeDialog(), InvokeDialog(), and RESCUER::RESCUER().

◆ m_prj

PROJECT* RESCUER::m_prj
protectedinherited

Definition at line 318 of file project_rescue.h.

Referenced by RESCUER::GetPrj(), LEGACY_RESCUER::OpenRescueLibrary(), OpenRescueLibrary(), RESCUER::RESCUER(), LEGACY_RESCUER::WriteRescueLibrary(), and WriteRescueLibrary().

◆ m_properties

std::unique_ptr<STRING_UTF8_MAP> SYMBOL_LIB_TABLE_RESCUER::m_properties
private

Library plugin properties.

Definition at line 382 of file project_rescue.h.

Referenced by SYMBOL_LIB_TABLE_RESCUER(), and WriteRescueLibrary().

◆ m_rescue_log

std::vector<RESCUE_LOG> RESCUER::m_rescue_log
protectedinherited

Definition at line 326 of file project_rescue.h.

Referenced by RESCUER::LogRescue(), and RESCUER::UndoRescues().

◆ m_rescueLibSymbols

std::vector<std::unique_ptr<LIB_SYMBOL> > SYMBOL_LIB_TABLE_RESCUER::m_rescueLibSymbols
private

Definition at line 380 of file project_rescue.h.

Referenced by AddSymbol(), OpenRescueLibrary(), and WriteRescueLibrary().

◆ m_schematic

SCHEMATIC* RESCUER::m_schematic
protectedinherited

Definition at line 319 of file project_rescue.h.

Referenced by LEGACY_RESCUER::OpenRescueLibrary(), OpenRescueLibrary(), RESCUER::RESCUER(), RESCUER::Schematic(), LEGACY_RESCUER::WriteRescueLibrary(), and WriteRescueLibrary().

◆ m_symbols

std::vector<SCH_SYMBOL*> RESCUER::m_symbols
protectedinherited

Definition at line 317 of file project_rescue.h.

Referenced by RESCUER::GetSymbols(), and RESCUER::RESCUER().

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