ee_tool_utils.h File Reference

#include <optional>
#include <set>
#include <sch_item.h>
#include <tool/selection.h>

Go to the source code of this file.

Functions
wxString	GetSchItemAsText (const SCH_ITEM &aItem)
wxString	GetSelectedItemsAsText (const SELECTION &aSel)
std::set< int >	GetUnplacedUnitsForSymbol (const SCH_SYMBOL &aSym)
	Get a list of unplaced (i.e.
std::optional< SCH_REFERENCE >	FindSymbolByRefAndUnit (const SCHEMATIC &aSheet, const wxString &aRef, int aUnit)
	Find a symbol by reference and unit.

Function Documentation

FindSymbolByRefAndUnit()

std::optional< SCH_REFERENCE > FindSymbolByRefAndUnit	(	const SCHEMATIC &	aSheet,
		const wxString &	aRef,
		int	aUnit
	)

Find a symbol by reference and unit.

Returns

A SCH_REFERENCE to the found symbol, or std::nullopt if not found.

Definition at line 163 of file ee_tool_utils.cpp.

References SCH_SHEET_LIST::GetSymbols(), and SCHEMATIC::Hierarchy().

Referenced by SCH_EDIT_FRAME::SelectUnit().

GetSchItemAsText()

wxString GetSchItemAsText

(

const SCH_ITEM &

aItem

)

Definition at line 37 of file ee_tool_utils.cpp.

References SCH_TABLE::GetCell(), SCH_TABLE::GetColCount(), SCH_TABLE::GetRowCount(), SCH_FIELD::GetShownText(), SCH_TEXTBOX::GetShownText(), pin, SCH_DIRECTIVE_LABEL_T, SCH_FIELD_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PIN_T, SCH_SHEET_PIN_T, SCH_TABLE_T, SCH_TABLECELL_T, SCH_TEXT_T, SCH_TEXTBOX_T, text, and EDA_ITEM::Type().

Referenced by GetSelectedItemsAsText().

GetSelectedItemsAsText()

wxString GetSelectedItemsAsText

(

const SELECTION &

aSel

)

Definition at line 107 of file ee_tool_utils.cpp.

References GetSchItemAsText().

Referenced by SCH_EDITOR_CONTROL::CopyAsText(), and SYMBOL_EDITOR_EDIT_TOOL::CopyAsText().

GetUnplacedUnitsForSymbol()

std::set< int > GetUnplacedUnitsForSymbol

(

const SCH_SYMBOL &

aSym

)

Get a list of unplaced (i.e.

not in schamtic) unit numbers for a symbol.

Definition at line 131 of file ee_tool_utils.cpp.

References SCHEMATIC::CurrentSheet(), SCH_SYMBOL::GetRef(), SCH_SHEET_LIST::GetSymbols(), SCH_SYMBOL::GetUnitCount(), SCHEMATIC::Hierarchy(), and SCH_ITEM::Schematic().

Referenced by SCH_DRAWING_TOOLS::PlaceNextSymbolUnit(), and SYMBOL_UNIT_MENU::update().