KiCad PCB EDA Suite
schematic.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) 2020-2022 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef KICAD_SCHEMATIC_H
21#define KICAD_SCHEMATIC_H
22
23#include <eda_item.h>
24#include <sch_sheet_path.h>
25#include <schematic_settings.h>
26
27
28class BUS_ALIAS;
30class EDA_BASE_FRAME;
31class ERC_SETTINGS;
32class PROJECT;
33class SCH_SCREEN;
34class SCH_SHEET;
35class SCH_SHEET_LIST;
36class SCH_GLOBALLABEL;
37
38
40{
41public:
43 virtual ~SCHEMATIC_IFACE() {};
44
45 virtual CONNECTION_GRAPH* ConnectionGraph() const = 0;
46 virtual SCH_SHEET_LIST GetSheets() const = 0;
47 virtual void SetCurrentSheet( const SCH_SHEET_PATH& aPath ) = 0;
48 virtual SCH_SHEET_PATH& CurrentSheet() const = 0;
49 virtual wxString GetFileName() const = 0;
50 virtual PROJECT& Prj() const = 0;
51};
52
60class SCHEMATIC : public SCHEMATIC_IFACE, public EDA_ITEM
61{
62public:
63 SCHEMATIC( PROJECT* aPrj );
64
65 virtual ~SCHEMATIC();
66
67 virtual wxString GetClass() const override
68 {
69 return wxT( "SCHEMATIC" );
70 }
71
73 void Reset();
74
76 PROJECT& Prj() const override { return *m_project; }
77 void SetProject( PROJECT* aPrj );
78
79 const std::map<wxString, wxString>* GetProperties() { return &m_properties; }
80
86 SCH_SHEET_LIST GetSheets() const override
87 {
89 }
90
91 SCH_SHEET& Root() const
92 {
93 return *m_rootSheet;
94 }
95
104 void SetRoot( SCH_SHEET* aRootSheet );
105
107 bool IsValid() const
108 {
109 return m_rootSheet != nullptr;
110 }
111
113 SCH_SCREEN* RootScreen() const;
114
115 bool ResolveTextVar( wxString* token, int aDepth ) const;
116
118 wxString GetFileName() const override;
119
120 SCH_SHEET_PATH& CurrentSheet() const override
121 {
122 return *m_currentSheet;
123 }
124
125 void SetCurrentSheet( const SCH_SHEET_PATH& aPath ) override
126 {
127 *m_currentSheet = aPath;
128 }
129
131 {
132 return m_connectionGraph;
133 }
134
136
137 ERC_SETTINGS& ErcSettings() const;
138
139 std::vector<SCH_MARKER*> ResolveERCExclusions();
140
145 std::shared_ptr<BUS_ALIAS> GetBusAlias( const wxString& aLabel ) const;
146
152 std::set<wxString> GetNetClassAssignmentCandidates();
153
159 bool ResolveCrossReference( wxString* token, int aDepth ) const;
160
161 std::map<wxString, std::set<int>>& GetPageRefsMap() { return m_labelToPageRefsMap; }
162
163 std::map<int, wxString> GetVirtualPageToSheetNamesMap() const;
164 std::map<int, wxString> GetVirtualPageToSheetPagesMap() const;
165
166 wxString ConvertRefsToKIIDs( const wxString& aSource ) const;
167 wxString ConvertKIIDsToRefs( const wxString& aSource ) const;
168
173
182
191
198
203 void RecomputeIntersheetRefs( const std::function<void( SCH_GLOBALLABEL* )>& aItemCallback );
204
209 void FixupJunctions();
210
211#if defined(DEBUG)
212 void Show( int nestLevel, std::ostream& os ) const override {}
213#endif
214
215private:
216 friend class SCH_EDIT_FRAME;
217
219
222
230
233
238 std::map<wxString, std::set<int>> m_labelToPageRefsMap;
239
243 std::map<wxString, wxString> m_properties;
244};
245
246#endif
Calculates the connectivity of a schematic and generates netlists.
The base frame for deriving all KiCad main window classes.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
Container for ERC settings.
Definition: erc_settings.h:114
Container for project specific data.
Definition: project.h:64
virtual void SetCurrentSheet(const SCH_SHEET_PATH &aPath)=0
virtual wxString GetFileName() const =0
virtual CONNECTION_GRAPH * ConnectionGraph() const =0
virtual SCH_SHEET_LIST GetSheets() const =0
virtual SCH_SHEET_PATH & CurrentSheet() const =0
virtual PROJECT & Prj() const =0
virtual ~SCHEMATIC_IFACE()
Definition: schematic.h:43
These settings were stored in SCH_BASE_FRAME previously.
Holds all the data relating to one schematic.
Definition: schematic.h:61
void Reset()
Initialize this schematic to a blank one, unloading anything existing.
Definition: schematic.cpp:53
void SetLegacySymbolInstanceData()
Update the symbol value and footprint instance data for legacy designs.
Definition: schematic.cpp:488
CONNECTION_GRAPH * m_connectionGraph
Holds and calculates connectivity information of this schematic.
Definition: schematic.h:232
virtual wxString GetClass() const override
Return the class name.
Definition: schematic.h:67
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:120
SCH_SHEET_PATH * m_currentSheet
The sheet path of the sheet currently being edited or displayed.
Definition: schematic.h:229
bool ResolveTextVar(wxString *token, int aDepth) const
Definition: schematic.cpp:125
virtual ~SCHEMATIC()
Definition: schematic.cpp:46
std::shared_ptr< BUS_ALIAS > GetBusAlias(const wxString &aLabel) const
Return a pointer to a bus alias object for the given label, or null if one doesn't exist.
Definition: schematic.cpp:264
std::vector< SCH_MARKER * > ResolveERCExclusions()
Definition: schematic.cpp:192
wxString GetFileName() const override
Helper to retrieve the filename from the root sheet screen.
Definition: schematic.cpp:172
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:178
CONNECTION_GRAPH * ConnectionGraph() const override
Definition: schematic.h:130
wxString ConvertKIIDsToRefs(const wxString &aSource) const
Definition: schematic.cpp:426
std::map< wxString, std::set< int > > & GetPageRefsMap()
Definition: schematic.h:161
SCH_SHEET_LIST & GetFullHierarchy() const
Return the full schematic flattened hierarchical sheet list.
Definition: schematic.cpp:477
void SetCurrentSheet(const SCH_SHEET_PATH &aPath) override
Definition: schematic.h:125
void FixupJunctions()
Add junctions to this schematic where required.
Definition: schematic.cpp:603
std::map< wxString, std::set< int > > m_labelToPageRefsMap
Holds a map of labels to the page sequence (virtual page number) that they appear on.
Definition: schematic.h:238
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:86
wxString ConvertRefsToKIIDs(const wxString &aSource) const
Definition: schematic.cpp:358
void SetRoot(SCH_SHEET *aRootSheet)
Initialize the schematic with a new root sheet.
Definition: schematic.cpp:106
void SetProject(PROJECT *aPrj)
Definition: schematic.cpp:78
std::map< int, wxString > GetVirtualPageToSheetPagesMap() const
Definition: schematic.cpp:347
PROJECT * m_project
Definition: schematic.h:218
SCH_SCREEN * RootScreen() const
Helper to retrieve the screen of the root sheet.
Definition: schematic.cpp:119
SCHEMATIC(PROJECT *aPrj)
Definition: schematic.cpp:34
std::set< wxString > GetNetClassAssignmentCandidates()
Return the set of netname candidates for netclass assignment.
Definition: schematic.cpp:279
void RecomputeIntersheetRefs(const std::function< void(SCH_GLOBALLABEL *)> &aItemCallback)
Update the schematic's page reference map for all global labels, and refresh the labels so that they ...
Definition: schematic.cpp:541
bool IsValid() const
A simple test if the schematic is loaded, not a complete one.
Definition: schematic.h:107
const std::map< wxString, wxString > * GetProperties()
Definition: schematic.h:79
SCH_SHEET & Root() const
Definition: schematic.h:91
std::map< int, wxString > GetVirtualPageToSheetNamesMap() const
Definition: schematic.cpp:331
wxString GetUniqueFilenameForCurrentSheet()
Definition: schematic.cpp:496
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
Definition: schematic.cpp:512
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Definition: schematic.h:76
bool ResolveCrossReference(wxString *token, int aDepth) const
Resolves text vars that refer to other items.
Definition: schematic.cpp:298
std::map< wxString, wxString > m_properties
Properties for text variable substitution (and perhaps other uses in future).
Definition: schematic.h:243
ERC_SETTINGS & ErcSettings() const
Definition: schematic.cpp:185
SCH_SHEET * m_rootSheet
The top-level sheet in this schematic hierarchy (or potentially the only one)
Definition: schematic.h:221
Schematic editor (Eeschema) main window.
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:57
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.