RESCUE_CANDIDATE Class Reference

#include <project_rescue.h>

Inheritance diagram for RESCUE_CANDIDATE:

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

Detailed Description

Definition at line 64 of file project_rescue.h.

Constructor & Destructor Documentation

RESCUE_CANDIDATE()

RESCUE_CANDIDATE::RESCUE_CANDIDATE ( const wxString & aRequestedName, const wxString & aNewName, LIB_SYMBOL * aLibCandidate, int aUnit, int aBodyStyle )

inline

Definition at line 67 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().

~RESCUE_CANDIDATE()

virtual RESCUE_CANDIDATE::~RESCUE_CANDIDATE ( )

inlinevirtual

Definition at line 76 of file project_rescue.h.

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

Referenced by DIALOG_RESCUE_EACH::PopulateConflictList().

GetBodyStyle()

int RESCUE_CANDIDATE::GetBodyStyle ( ) const

inline

Definition at line 101 of file project_rescue.h.

References m_bodyStyle.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

GetCacheCandidate()

virtual LIB_SYMBOL * RESCUE_CANDIDATE::GetCacheCandidate ( ) const

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 92 of file project_rescue.h.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

GetLibCandidate()

virtual LIB_SYMBOL * RESCUE_CANDIDATE::GetLibCandidate ( ) const

inlinevirtual

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

Definition at line 98 of file project_rescue.h.

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 86 of file project_rescue.h.

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 81 of file project_rescue.h.

References m_requested_name.

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

GetUnit()

int RESCUE_CANDIDATE::GetUnit ( ) const

inline

Definition at line 100 of file project_rescue.h.

References m_unit.

Referenced by DIALOG_RESCUE_EACH::displayItemsInConflict().

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

Member Data Documentation

m_bodyStyle

int RESCUE_CANDIDATE::m_bodyStyle

protected

Definition at line 120 of file project_rescue.h.

Referenced by GetBodyStyle(), and RESCUE_CANDIDATE().

m_lib_candidate

LIB_SYMBOL* RESCUE_CANDIDATE::m_lib_candidate

protected

Definition at line 118 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().

m_new_name

wxString RESCUE_CANDIDATE::m_new_name

protected

Definition at line 117 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().

m_requested_name

wxString RESCUE_CANDIDATE::m_requested_name

protected

Definition at line 116 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().

m_unit

int RESCUE_CANDIDATE::m_unit

protected

Definition at line 119 of file project_rescue.h.

Referenced by GetUnit(), and RESCUE_CANDIDATE().

---

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

• project_rescue.h