KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2023 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
53class SCHEMATIC;
54
56{
57public:
59 virtual void OnSchItemsAdded( SCHEMATIC& aSch, std::vector<SCH_ITEM*>& aSchItem ) {}
60 virtual void OnSchItemsRemoved( SCHEMATIC& aSch, std::vector<SCH_ITEM*>& aSchItem ) {}
61 virtual void OnSchItemsChanged( SCHEMATIC& aSch, std::vector<SCH_ITEM*>& aSchItem ) {}
62};
63
71class SCHEMATIC : public SCHEMATIC_IFACE, public EDA_ITEM
72{
73public:
74 SCHEMATIC( PROJECT* aPrj );
75
76 virtual ~SCHEMATIC();
77
78 virtual wxString GetClass() const override
79 {
80 return wxT( "SCHEMATIC" );
81 }
82
84 void Reset();
85
87 PROJECT& Prj() const override { return *m_project; }
88 void SetProject( PROJECT* aPrj );
89
90 const std::map<wxString, wxString>* GetProperties() { return &m_properties; }
91
97 SCH_SHEET_LIST GetSheets() const override
98 {
100 }
101
103 {
104 return *m_rootSheet;
105 }
106
115 void SetRoot( SCH_SHEET* aRootSheet );
116
118 bool IsValid() const
119 {
120 return m_rootSheet != nullptr;
121 }
122
124 SCH_SCREEN* RootScreen() const;
125
126 void GetContextualTextVars( wxArrayString* aVars ) const;
127
128 bool ResolveTextVar( wxString* token, int aDepth ) const;
129
131 wxString GetFileName() const override;
132
133 SCH_SHEET_PATH& CurrentSheet() const override
134 {
135 return *m_currentSheet;
136 }
137
138 void SetCurrentSheet( const SCH_SHEET_PATH& aPath ) override
139 {
140 *m_currentSheet = aPath;
141 }
142
144 {
145 return m_connectionGraph;
146 }
147
149
150 ERC_SETTINGS& ErcSettings() const;
151
152 std::vector<SCH_MARKER*> ResolveERCExclusions();
153
158 std::shared_ptr<BUS_ALIAS> GetBusAlias( const wxString& aLabel ) const;
159
165 std::set<wxString> GetNetClassAssignmentCandidates();
166
172 bool ResolveCrossReference( wxString* token, int aDepth ) const;
173
174 std::map<wxString, std::set<int>>& GetPageRefsMap() { return m_labelToPageRefsMap; }
175
176 std::map<int, wxString> GetVirtualPageToSheetNamesMap() const;
177 std::map<int, wxString> GetVirtualPageToSheetPagesMap() const;
178
179 wxString ConvertRefsToKIIDs( const wxString& aSource ) const;
180 wxString ConvertKIIDsToRefs( const wxString& aSource ) const;
181
186
195
204
211
216 void RecomputeIntersheetRefs( const std::function<void( SCH_GLOBALLABEL* )>& aItemCallback );
217
222 {
223 m_operatingPoints.clear();
224 }
225
229 void SetOperatingPoint( const wxString& aSignal, double aValue )
230 {
231 m_operatingPoints[ aSignal ] = aValue;
232 }
233
234 wxString GetOperatingPoint( const wxString& aNetName, int aPrecision, const wxString& aRange );
235
240 void FixupJunctions();
241
246 void OnItemsAdded( std::vector<SCH_ITEM*>& aNewItems );
247
252 void OnItemsRemoved( std::vector<SCH_ITEM*>& aRemovedItems );
253
262 void AddListener( SCHEMATIC_LISTENER* aListener );
263
268 void RemoveListener( SCHEMATIC_LISTENER* aListener );
269
273 void RemoveAllListeners();
274
279 void OnItemsChanged( std::vector<SCH_ITEM*>& aItems );
280
281#if defined(DEBUG)
282 void Show( int nestLevel, std::ostream& os ) const override {}
283#endif
284
285private:
286 friend class SCH_EDIT_FRAME;
287
288 template <typename Func, typename... Args>
289 void InvokeListeners( Func&& aFunc, Args&&... args )
290 {
291 for( auto&& l : m_listeners )
292 ( l->*aFunc )( std::forward<Args>( args )... );
293 }
294
296
299
307
310
315 std::map<wxString, std::set<int>> m_labelToPageRefsMap;
316
320 std::map<wxString, wxString> m_properties;
321
325 std::map<wxString, double> m_operatingPoints;
326
330 std::vector<SCHEMATIC_LISTENER*> m_listeners;
331};
332
333#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
virtual void OnSchItemsRemoved(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem)
Definition: schematic.h:60
virtual ~SCHEMATIC_LISTENER()
Definition: schematic.h:58
virtual void OnSchItemsChanged(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem)
Definition: schematic.h:61
virtual void OnSchItemsAdded(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem)
Definition: schematic.h:59
These settings were stored in SCH_BASE_FRAME previously.
Holds all the data relating to one schematic.
Definition: schematic.h:72
void Reset()
Initialize this schematic to a blank one, unloading anything existing.
Definition: schematic.cpp:56
void SetLegacySymbolInstanceData()
Update the symbol value and footprint instance data for legacy designs.
Definition: schematic.cpp:515
void OnItemsAdded(std::vector< SCH_ITEM * > &aNewItems)
Must be used if Add() is used using a BULK_x ADD_MODE to generate a change event for listeners.
Definition: schematic.cpp:678
CONNECTION_GRAPH * m_connectionGraph
Holds and calculates connectivity information of this schematic.
Definition: schematic.h:309
virtual wxString GetClass() const override
Return the class name.
Definition: schematic.h:78
void SetOperatingPoint(const wxString &aSignal, double aValue)
Set operating points from a .op simulation.
Definition: schematic.h:229
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:133
void RemoveListener(SCHEMATIC_LISTENER *aListener)
Remove the specified listener.
Definition: schematic.cpp:697
SCH_SHEET_PATH * m_currentSheet
The sheet path of the sheet currently being edited or displayed.
Definition: schematic.h:306
wxString GetOperatingPoint(const wxString &aNetName, int aPrecision, const wxString &aRange)
Definition: schematic.cpp:630
bool ResolveTextVar(wxString *token, int aDepth) const
Definition: schematic.cpp:152
void OnItemsRemoved(std::vector< SCH_ITEM * > &aRemovedItems)
Must be used if Remove() is used using a BULK_x REMOVE_MODE to generate a change event for listeners.
Definition: schematic.cpp:684
virtual ~SCHEMATIC()
Definition: schematic.cpp:49
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:291
std::vector< SCH_MARKER * > ResolveERCExclusions()
Definition: schematic.cpp:219
wxString GetFileName() const override
Helper to retrieve the filename from the root sheet screen.
Definition: schematic.cpp:199
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:205
void ClearOperatingPoints()
Clear operating points from a .op simulation.
Definition: schematic.h:221
CONNECTION_GRAPH * ConnectionGraph() const override
Definition: schematic.h:143
wxString ConvertKIIDsToRefs(const wxString &aSource) const
Definition: schematic.cpp:453
std::map< wxString, std::set< int > > & GetPageRefsMap()
Definition: schematic.h:174
SCH_SHEET_LIST & GetFullHierarchy() const
Return the full schematic flattened hierarchical sheet list.
Definition: schematic.cpp:504
void SetCurrentSheet(const SCH_SHEET_PATH &aPath) override
Definition: schematic.h:138
void FixupJunctions()
Add junctions to this schematic where required.
Definition: schematic.cpp:650
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:315
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:97
wxString ConvertRefsToKIIDs(const wxString &aSource) const
Definition: schematic.cpp:385
void SetRoot(SCH_SHEET *aRootSheet)
Initialize the schematic with a new root sheet.
Definition: schematic.cpp:109
void SetProject(PROJECT *aPrj)
Definition: schematic.cpp:81
void AddListener(SCHEMATIC_LISTENER *aListener)
Add a listener to the schematic to receive calls whenever something on the schematic has been modifie...
Definition: schematic.cpp:690
std::map< int, wxString > GetVirtualPageToSheetPagesMap() const
Definition: schematic.cpp:374
PROJECT * m_project
Definition: schematic.h:295
SCH_SCREEN * RootScreen() const
Helper to retrieve the screen of the root sheet.
Definition: schematic.cpp:122
std::set< wxString > GetNetClassAssignmentCandidates()
Return the set of netname candidates for netclass assignment.
Definition: schematic.cpp:306
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:568
void InvokeListeners(Func &&aFunc, Args &&... args)
Definition: schematic.h:289
bool IsValid() const
A simple test if the schematic is loaded, not a complete one.
Definition: schematic.h:118
void RemoveAllListeners()
Remove all listeners.
Definition: schematic.cpp:709
const std::map< wxString, wxString > * GetProperties()
Definition: schematic.h:90
void GetContextualTextVars(wxArrayString *aVars) const
Definition: schematic.cpp:128
SCH_SHEET & Root() const
Definition: schematic.h:102
std::map< int, wxString > GetVirtualPageToSheetNamesMap() const
Definition: schematic.cpp:358
wxString GetUniqueFilenameForCurrentSheet()
Definition: schematic.cpp:523
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
Definition: schematic.cpp:539
std::vector< SCHEMATIC_LISTENER * > m_listeners
Currently installed listeners.
Definition: schematic.h:330
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Definition: schematic.h:87
bool ResolveCrossReference(wxString *token, int aDepth) const
Resolves text vars that refer to other items.
Definition: schematic.cpp:325
std::map< wxString, double > m_operatingPoints
Simulation operating points for text variable substitution.
Definition: schematic.h:325
std::map< wxString, wxString > m_properties
Properties for text variable substitution (and perhaps other uses in future).
Definition: schematic.h:320
ERC_SETTINGS & ErcSettings() const
Definition: schematic.cpp:212
void OnItemsChanged(std::vector< SCH_ITEM * > &aItems)
Notify the schematic and its listeners that an item on the schematic has been modified in some way.
Definition: schematic.cpp:715
SCH_SHEET * m_rootSheet
The top-level sheet in this schematic hierarchy (or potentially the only one)
Definition: schematic.h:298
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.