KiCad PCB EDA Suite
Toggle main menu visibility
Main Page
Related Pages
Modules
Namespaces
Namespace List
Namespace Members
All
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
q
r
s
t
u
v
w
Functions
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
r
s
t
u
v
w
Variables
a
c
d
e
f
g
h
i
k
l
m
o
p
r
s
t
u
v
Typedefs
a
c
e
f
i
k
l
m
n
o
p
s
v
w
Enumerations
c
d
f
g
l
m
n
o
p
q
r
s
t
v
Enumerator
a
b
c
d
e
g
h
i
l
m
n
o
p
r
s
t
u
v
Classes
Class List
Class Index
Class Hierarchy
Class Members
All
$
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
~
Functions
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
~
Variables
$
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
Typedefs
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
r
s
t
u
v
Enumerations
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
z
Enumerator
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
r
s
t
u
v
w
x
z
Related Functions
a
b
c
d
e
f
g
h
i
j
l
m
n
o
p
r
s
t
u
v
z
Files
File List
File Members
All
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
Functions
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
z
Variables
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
z
Typedefs
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
r
s
t
u
v
w
x
z
Enumerations
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
r
s
t
u
v
w
x
z
Enumerator
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
r
s
t
u
v
w
x
y
z
Macros
_
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
KiCad Dev Docs
•
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Modules
Pages
Concepts
Loading...
Searching...
No Matches
sch_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 The 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
32
class
SCH_REFERENCE
;
33
class
SCH_SYMBOL
;
34
class
SCHEMATIC
;
35
36
wxString
GetSchItemAsText
(
const
SCH_ITEM
& aItem );
37
38
wxString
GetSelectedItemsAsText
(
const
SELECTION
& aSel );
39
43
std::set<int>
GetUnplacedUnitsForSymbol
(
const
SCH_SYMBOL
& aSym );
44
50
std::optional<SCH_REFERENCE>
FindSymbolByRefAndUnit
(
const
SCHEMATIC
& aSheet,
const
wxString& aRef,
51
int
aUnit );
SCHEMATIC
Holds all the data relating to one schematic.
Definition:
schematic.h:69
SCH_ITEM
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition:
sch_item.h:168
SCH_REFERENCE
A helper to define a symbol's reference designator in a schematic.
Definition:
sch_reference_list.h:77
SCH_SYMBOL
Schematic symbol object.
Definition:
sch_symbol.h:75
SELECTION
Definition:
selection.h:39
sch_item.h
FindSymbolByRefAndUnit
std::optional< SCH_REFERENCE > FindSymbolByRefAndUnit(const SCHEMATIC &aSheet, const wxString &aRef, int aUnit)
Find a symbol by reference and unit.
Definition:
sch_tool_utils.cpp:163
GetUnplacedUnitsForSymbol
std::set< int > GetUnplacedUnitsForSymbol(const SCH_SYMBOL &aSym)
Get a list of unplaced (i.e.
Definition:
sch_tool_utils.cpp:131
GetSelectedItemsAsText
wxString GetSelectedItemsAsText(const SELECTION &aSel)
Definition:
sch_tool_utils.cpp:107
GetSchItemAsText
wxString GetSchItemAsText(const SCH_ITEM &aItem)
Definition:
sch_tool_utils.cpp:37
selection.h
src
eeschema
tools
sch_tool_utils.h
Generated on Tue Apr 1 2025 00:05:32 for KiCad PCB EDA Suite by
1.9.6