KiCad PCB EDA Suite: LEGACY_RESCUER Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

#include <project_rescue.h>

Inheritance diagram for LEGACY_RESCUER:

Public Member Functions
	LEGACY_RESCUER (PROJECT &aProject, SCHEMATIC aSchematic, SCH_SHEET_PATH aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackEndType)

virtual	~LEGACY_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::unique_ptr< SYMBOL_LIB >	m_rescue_lib

Detailed Description

Definition at line 330 of file project_rescue.h.

Constructor & Destructor Documentation

◆ LEGACY_RESCUER()

LEGACY_RESCUER::LEGACY_RESCUER	(	PROJECT &	aProject,
		SCHEMATIC *	aSchematic,
		SCH_SHEET_PATH *	aCurrentSheet,
		EDA_DRAW_PANEL_GAL::GAL_TYPE	aGalBackEndType
	)

inline

Definition at line 333 of file project_rescue.h.

◆ ~LEGACY_RESCUER()

virtual LEGACY_RESCUER::~LEGACY_RESCUER ( )

inlinevirtual

Definition at line 339 of file project_rescue.h.

Member Function Documentation

◆ AddSymbol()

void LEGACY_RESCUER::AddSymbol ( LIB_SYMBOL * aNewSymbol )

overridevirtual

Implements RESCUER.

Definition at line 792 of file project_rescue.cpp.

References m_rescue_lib, and LIB_SYMBOL::SetLib().

◆ 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 LEGACY_RESCUER::FindCandidates ( )

overridevirtual

Populate the RESCUER with all possible candidates.

Implements RESCUER.

Definition at line 667 of file project_rescue.cpp.

References RESCUE_CASE_CANDIDATE::FindRescues(), RESCUE_CACHE_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 LEGACY_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 674 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 LEGACY_RESCUER::OpenRescueLibrary ( )

overridevirtual

Implements RESCUER.

Definition at line 681 of file project_rescue.cpp.

References SYMBOL_LIBS::FindLibrary(), GetRescueLibraryFileName(), SYMBOL_LIB::GetSymbols(), RESCUER::m_prj, m_rescue_lib, RESCUER::m_schematic, and PROJECT_SCH::SchLibs().

◆ 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 LEGACY_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 711 of file project_rescue.cpp.

References _, DisplayError(), PROJECT::ELEM_SCH_SYMBOL_LIBS, PROJECT::GetElem(), SYMBOL_LIBS::GetLibNamesAndPaths(), SYMBOL_LIBS::LoadAllLibraries(), RESCUER::m_prj, m_rescue_lib, RESCUER::m_schematic, SCHEMATIC::Root(), PROJECT::SetElem(), SYMBOL_LIBS::SetLibNamesAndPaths(), and SCH_SCREENS::UpdateSymbolLinks().

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(), FindCandidates(), SYMBOL_LIB_TABLE_RESCUER::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 InvokeDialog(), SYMBOL_LIB_TABLE_RESCUER::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 InvokeDialog(), SYMBOL_LIB_TABLE_RESCUER::InvokeDialog(), and RESCUER::RESCUER().

◆ m_prj

PROJECT* RESCUER::m_prj

protectedinherited

Definition at line 318 of file project_rescue.h.

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

◆ m_rescue_lib

std::unique_ptr<SYMBOL_LIB> LEGACY_RESCUER::m_rescue_lib

private

Definition at line 354 of file project_rescue.h.

Referenced by AddSymbol(), OpenRescueLibrary(), 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_schematic

SCHEMATIC* RESCUER::m_schematic

protectedinherited

Definition at line 319 of file project_rescue.h.

Referenced by OpenRescueLibrary(), SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary(), RESCUER::RESCUER(), RESCUER::Schematic(), WriteRescueLibrary(), and SYMBOL_LIB_TABLE_RESCUER::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:

LEGACY_RESCUER
Generated on Fri Dec 8 2023 00:04:42 for KiCad PCB EDA Suite by 1.9.5