Agent for all the modifications while syncing the sheet pin and hierarchical label. More...

#include <sheet_synchronization_agent.h>

Public Types
enum	SHEET_SYNCHRONIZATION_PLACEMENT { PLACE_SHEET_PIN , PLACE_HIERLABEL }

using	DO_DELETE_ITEM = std::function<void( EDA_ITEM*, SCH_SHEET_PATH )>

using	MODIFICATION = std::function<void()>

using	DO_MODIFY_ITEM = std::function<void( EDA_ITEM*, SCH_SHEET_PATH, MODIFICATION const& )>

using	DO_PLACE_ITEM

Public Member Functions
	SHEET_SYNCHRONIZATION_AGENT (DO_MODIFY_ITEM aDoModify, DO_DELETE_ITEM aDoDelete, DO_PLACE_ITEM aPlaceItem, TOOL_MANAGER aToolManager, SCH_EDIT_FRAME a_frame)

	~SHEET_SYNCHRONIZATION_AGENT ()

void	ModifyItem (SHEET_SYNCHRONIZATION_ITEM &aItem, std::function< void()> const &aDoModify, const SCH_SHEET_PATH &aPath)

void	ModifyItem (SCH_ITEM *aItem, std::function< void()> const &aDoModify, const SCH_SHEET_PATH &aPath, SHEET_SYNCHRONIZATION_ITEM_KIND aKind)

void	RemoveItem (SHEET_SYNCHRONIZATION_ITEM &aItem, SCH_SHEET *aSheet, SCH_SHEET_PATH const &aPath)

void	PlaceSheetPin (SCH_SHEET aSheet, SCH_SHEET_PATH const &aPath, std::set< EDA_ITEM > const &aLabels)

void	PlaceHieraLable (SCH_SHEET aSheet, SCH_SHEET_PATH const &aPath, std::set< EDA_ITEM > const &aPins)

Private Attributes
DO_MODIFY_ITEM	m_doModify

DO_DELETE_ITEM	m_doDelete

DO_PLACE_ITEM	m_doPlaceItem

Detailed Description

Agent for all the modifications while syncing the sheet pin and hierarchical label.

Definition at line 46 of file sheet_synchronization_agent.h.

Member Typedef Documentation

◆ DO_DELETE_ITEM

using SHEET_SYNCHRONIZATION_AGENT::DO_DELETE_ITEM = std::function<void( EDA_ITEM*, SCH_SHEET_PATH )>

Definition at line 55 of file sheet_synchronization_agent.h.

◆ DO_MODIFY_ITEM

using SHEET_SYNCHRONIZATION_AGENT::DO_MODIFY_ITEM = std::function<void( EDA_ITEM*, SCH_SHEET_PATH, MODIFICATION const& )>

Definition at line 59 of file sheet_synchronization_agent.h.

◆ DO_PLACE_ITEM

using SHEET_SYNCHRONIZATION_AGENT::DO_PLACE_ITEM

Initial value:

 
            std::function<void( SCH_SHEET*, SCH_SHEET_PATH, SHEET_SYNCHRONIZATION_PLACEMENT,
                                std::set<EDA_ITEM*> const& )>

Definition at line 61 of file sheet_synchronization_agent.h.

◆ MODIFICATION

using SHEET_SYNCHRONIZATION_AGENT::MODIFICATION = std::function<void()>

Definition at line 57 of file sheet_synchronization_agent.h.

Member Enumeration Documentation

◆ SHEET_SYNCHRONIZATION_PLACEMENT

enum SHEET_SYNCHRONIZATION_AGENT::SHEET_SYNCHRONIZATION_PLACEMENT

Enumerator
PLACE_SHEET_PIN
PLACE_HIERLABEL

Definition at line 49 of file sheet_synchronization_agent.h.

Constructor & Destructor Documentation

◆ SHEET_SYNCHRONIZATION_AGENT()

SHEET_SYNCHRONIZATION_AGENT::SHEET_SYNCHRONIZATION_AGENT	(	DO_MODIFY_ITEM	aDoModify,
		DO_DELETE_ITEM	aDoDelete,
		DO_PLACE_ITEM	aPlaceItem,
		TOOL_MANAGER *	aToolManager,
		SCH_EDIT_FRAME *	a_frame )

Definition at line 33 of file sheet_synchronization_agent.cpp.

References m_doDelete, m_doModify, m_doPlaceItem, and move.

◆ ~SHEET_SYNCHRONIZATION_AGENT()

SHEET_SYNCHRONIZATION_AGENT::~SHEET_SYNCHRONIZATION_AGENT ( )

default

Member Function Documentation

◆ ModifyItem() [1/2]

void SHEET_SYNCHRONIZATION_AGENT::ModifyItem	(	SCH_ITEM *	aItem,
		std::function< void()> const &	aDoModify,
		const SCH_SHEET_PATH &	aPath,
		SHEET_SYNCHRONIZATION_ITEM_KIND	aKind )

Definition at line 56 of file sheet_synchronization_agent.cpp.

References HIERLABEL, HIERLABEL_AND_SHEET_PIN, m_doModify, SCH_SHEET_PATH::pop_back(), and SHEET_PIN.

◆ ModifyItem() [2/2]

void SHEET_SYNCHRONIZATION_AGENT::ModifyItem	(	SHEET_SYNCHRONIZATION_ITEM &	aItem,
		std::function< void()> const &	aDoModify,
		const SCH_SHEET_PATH &	aPath )