KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ee_tool_utils.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#pragma once
25
26#include <optional>
27#include <set>
28
29#include <sch_item.h>
30#include <tool/selection.h>
31
32class SCH_REFERENCE;
33class SCH_SYMBOL;
34class SCHEMATIC;
35
36wxString GetSchItemAsText( const SCH_ITEM& aItem );
37
38wxString GetSelectedItemsAsText( const SELECTION& aSel );
39
43std::set<int> GetUnplacedUnitsForSymbol( const SCH_SYMBOL& aSym );
44
50std::optional<SCH_REFERENCE> FindSymbolByRefAndUnit( const SCHEMATIC& aSheet, const wxString& aRef,
51 int aUnit );
Holds all the data relating to one schematic.
Definition: schematic.h:77
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:166
A helper to define a symbol's reference designator in a schematic.
Schematic symbol object.
Definition: sch_symbol.h:104
std::optional< SCH_REFERENCE > FindSymbolByRefAndUnit(const SCHEMATIC &aSheet, const wxString &aRef, int aUnit)
Find a symbol by reference and unit.
std::set< int > GetUnplacedUnitsForSymbol(const SCH_SYMBOL &aSym)
Get a list of unplaced (i.e.
wxString GetSelectedItemsAsText(const SELECTION &aSel)
wxString GetSchItemAsText(const SCH_ITEM &aItem)