KiCad PCB EDA Suite
pcb_netlist.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) 2012 Jean-Pierre Charras.
5 * Copyright (C) 2013-2016 Wayne Stambaugh <[email protected]>.
6 * Copyright (C) 2012-2022 KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#ifndef PCB_NETLIST_H
27#define PCB_NETLIST_H
28
29#include <boost/ptr_container/ptr_vector.hpp>
30#include <wx/arrstr.h>
31
32#include <lib_id.h>
33#include <footprint.h>
34
35
36class REPORTER;
37
38
44{
45public:
47
48 COMPONENT_NET( const wxString& aPinName, const wxString& aNetName,
49 const wxString& aPinFunction, const wxString& aPinType ) :
50 m_pinName( aPinName ),
51 m_netName( aNetName ),
52 m_pinFunction( aPinFunction ),
53 m_pinType( aPinType )
54 {
55 }
56
57 const wxString& GetPinName() const { return m_pinName; }
58 const wxString& GetNetName() const { return m_netName; }
59 const wxString& GetPinFunction() const { return m_pinFunction; }
60 const wxString& GetPinType() const { return m_pinType; }
61
62 bool IsValid() const { return !m_pinName.IsEmpty(); }
63
64 bool operator <( const COMPONENT_NET& aNet ) const
65 {
66 return m_pinName < aNet.m_pinName;
67 }
68
69 int Format( OUTPUTFORMATTER* aOut, int aNestLevel, int aCtl );
70
71private:
72 wxString m_pinName;
73 wxString m_netName;
74 wxString m_pinFunction;
75 wxString m_pinType;
76};
77
78
79typedef std::vector< COMPONENT_NET > COMPONENT_NETS;
80
85{
86public:
87 COMPONENT( const LIB_ID& aFPID,
88 const wxString& aReference,
89 const wxString& aValue,
90 const KIID_PATH& aPath,
91 const std::vector<KIID>& aKiids )
92 {
93 m_fpid = aFPID;
94 m_reference = aReference;
95 m_value = aValue;
96 m_pinCount = 0;
97 m_path = aPath;
98 m_kiids = aKiids;
99 }
100
101 virtual ~COMPONENT() { };
102
103 void AddNet( const wxString& aPinName, const wxString& aNetName, const wxString& aPinFunction,
104 const wxString& aPinType )
105 {
106 m_nets.emplace_back( aPinName, aNetName, aPinFunction, aPinType );
107 }
108
109 unsigned GetNetCount() const { return m_nets.size(); }
110
111 const COMPONENT_NET& GetNet( unsigned aIndex ) const { return m_nets[aIndex]; }
112
113 const COMPONENT_NET& GetNet( const wxString& aPinName ) const;
114
115 void ClearNets() { m_nets.clear(); }
116
117 void SortPins() { sort( m_nets.begin(), m_nets.end() ); }
118
119 void SetName( const wxString& aName ) { m_name = aName;}
120 const wxString& GetName() const { return m_name; }
121
122 void SetLibrary( const wxString& aLibrary ) { m_library = aLibrary; }
123 const wxString& GetLibrary() const { return m_library; }
124
125 void SetReference( const wxString& aReference ) { m_reference = aReference; }
126 const wxString& GetReference() const { return m_reference; }
127
128 void SetValue( const wxString& aValue ) { m_value = aValue; }
129 const wxString& GetValue() const { return m_value; }
130
131 void SetProperties( std::map<wxString, wxString>& aProps )
132 {
133 m_properties = std::move( aProps );
134 }
135 const std::map<wxString, wxString>& GetProperties() const { return m_properties; }
136
137 void SetFPID( const LIB_ID& aFPID ) { m_fpid = aFPID; }
138 const LIB_ID& GetFPID() const { return m_fpid; }
139
140 void SetAltFPID( const LIB_ID& aFPID ) { m_altFpid = aFPID; }
141 const LIB_ID& GetAltFPID() const { return m_altFpid; }
142
143 const KIID_PATH& GetPath() const { return m_path; }
144
145 const std::vector<KIID>& GetKIIDs() const { return m_kiids; }
146
147 void SetFootprintFilters( const wxArrayString& aFilters ) { m_footprintFilters = aFilters; }
148 const wxArrayString& GetFootprintFilters() const { return m_footprintFilters; }
149
150 void SetPinCount( int aPinCount ) { m_pinCount = aPinCount; }
151 int GetPinCount() const { return m_pinCount; }
152
153 FOOTPRINT* GetFootprint( bool aRelease = false )
154 {
155 return ( aRelease ) ? m_footprint.release() : m_footprint.get();
156 }
157
158 void SetFootprint( FOOTPRINT* aFootprint );
159
160 bool IsLibSource( const wxString& aLibrary, const wxString& aName ) const
161 {
162 return aLibrary == m_library && aName == m_name;
163 }
164
165 void Format( OUTPUTFORMATTER* aOut, int aNestLevel, int aCtl );
166
167private:
168 std::vector<COMPONENT_NET> m_nets;
169
170 wxArrayString m_footprintFilters;
172 wxString m_reference;
173 wxString m_value;
174
177
179 std::vector<KIID> m_kiids;
180
182 wxString m_name;
183
185 wxString m_library;
186
189
194
196 std::unique_ptr<FOOTPRINT> m_footprint;
197
199 std::map<wxString, wxString> m_properties;
200
202};
203
204
205typedef boost::ptr_vector< COMPONENT > COMPONENTS;
206
207
213{
214public:
216 m_findByTimeStamp( false ),
217 m_replaceFootprints( false )
218 {
219 }
220
224 bool IsEmpty() const { return m_components.empty(); }
225
229 void Clear() { m_components.clear(); }
230
234 unsigned GetCount() const { return m_components.size(); }
235
242 COMPONENT* GetComponent( unsigned aIndex ) { return &m_components[ aIndex ]; }
243
252 void AddComponent( COMPONENT* aComponent );
253
260 COMPONENT* GetComponentByReference( const wxString& aReference );
261
268 COMPONENT* GetComponentByPath( const KIID_PATH& aPath );
269
270 void SortByFPID();
271 void SortByReference();
272
273 void SetFindByTimeStamp( bool aFindByTimeStamp ) { m_findByTimeStamp = aFindByTimeStamp; }
274 bool IsFindByTimeStamp() const { return m_findByTimeStamp; }
275
276 void SetReplaceFootprints( bool aReplace ) { m_replaceFootprints = aReplace; }
278
282 bool AnyFootprintsLinked() const;
283
284 void Format( const char* aDocName, OUTPUTFORMATTER* aOut, int aNestLevel, int aCtl = 0 );
285
286#define CTL_OMIT_EXTRA (1<<0)
287#define CTL_OMIT_NETS (1<<1)
288#define CTL_OMIT_FILTERS (1<<2)
289#define CTL_OMIT_FP_UUID (1<<3)
290
291#define CTL_FOR_CVPCB (CTL_OMIT_NETS | CTL_OMIT_FILTERS | CTL_OMIT_EXTRA)
292
294 {
295 Format( "cvpcb_netlist", aOut, 0, CTL_FOR_CVPCB );
296 }
297
298private:
299 COMPONENTS m_components; // Components found in the netlist.
300
301 bool m_findByTimeStamp; // Associate components by KIID (or refdes if false)
302 bool m_replaceFootprints; // Update footprints to match footprints defined in netlist
303};
304
305
306#endif // PCB_NETLIST_H
Used to store the component pin name to net name (and pin function) associations stored in a netlist.
Definition: pcb_netlist.h:44
const wxString & GetNetName() const
Definition: pcb_netlist.h:58
wxString m_pinName
Definition: pcb_netlist.h:72
wxString m_pinType
Definition: pcb_netlist.h:75
COMPONENT_NET(const wxString &aPinName, const wxString &aNetName, const wxString &aPinFunction, const wxString &aPinType)
Definition: pcb_netlist.h:48
wxString m_pinFunction
Definition: pcb_netlist.h:74
int Format(OUTPUTFORMATTER *aOut, int aNestLevel, int aCtl)
Definition: pcb_netlist.cpp:32
wxString m_netName
Definition: pcb_netlist.h:73
bool operator<(const COMPONENT_NET &aNet) const
Definition: pcb_netlist.h:64
bool IsValid() const
Definition: pcb_netlist.h:62
const wxString & GetPinFunction() const
Definition: pcb_netlist.h:59
const wxString & GetPinName() const
Definition: pcb_netlist.h:57
const wxString & GetPinType() const
Definition: pcb_netlist.h:60
Store all of the related footprint information found in a netlist.
Definition: pcb_netlist.h:85
const COMPONENT_NET & GetNet(unsigned aIndex) const
Definition: pcb_netlist.h:111
const KIID_PATH & GetPath() const
Definition: pcb_netlist.h:143
void SetValue(const wxString &aValue)
Definition: pcb_netlist.h:128
void SetLibrary(const wxString &aLibrary)
Definition: pcb_netlist.h:122
void SetProperties(std::map< wxString, wxString > &aProps)
Definition: pcb_netlist.h:131
wxArrayString m_footprintFilters
Definition: pcb_netlist.h:170
const wxString & GetReference() const
Definition: pcb_netlist.h:126
virtual ~COMPONENT()
Definition: pcb_netlist.h:101
void SetAltFPID(const LIB_ID &aFPID)
Definition: pcb_netlist.h:140
void Format(OUTPUTFORMATTER *aOut, int aNestLevel, int aCtl)
Definition: pcb_netlist.cpp:74
int m_pinCount
Definition: pcb_netlist.h:171
const wxString & GetValue() const
Definition: pcb_netlist.h:129
KIID_PATH m_path
A fully specified path to the component (but not the component: [ sheetUUID, sheetUUID,...
Definition: pcb_netlist.h:176
wxString m_value
Definition: pcb_netlist.h:173
std::vector< KIID > m_kiids
A vector of possible KIIDs corresponding to all units in a symbol.
Definition: pcb_netlist.h:179
const std::map< wxString, wxString > & GetProperties() const
Definition: pcb_netlist.h:135
int GetPinCount() const
Definition: pcb_netlist.h:151
void SetFPID(const LIB_ID &aFPID)
Definition: pcb_netlist.h:137
void SortPins()
Definition: pcb_netlist.h:117
void SetPinCount(int aPinCount)
Definition: pcb_netlist.h:150
wxString m_reference
Definition: pcb_netlist.h:172
void ClearNets()
Definition: pcb_netlist.h:115
wxString m_name
The name of the component in m_library used when it was placed on the schematic.
Definition: pcb_netlist.h:182
LIB_ID m_altFpid
The alt LIB_ID of the footprint, when there are 2 different assigned footprints, One from the netlist...
Definition: pcb_netlist.h:193
const LIB_ID & GetAltFPID() const
Definition: pcb_netlist.h:141
void SetFootprint(FOOTPRINT *aFootprint)
Definition: pcb_netlist.cpp:40
bool IsLibSource(const wxString &aLibrary, const wxString &aName) const
Definition: pcb_netlist.h:160
FOOTPRINT * GetFootprint(bool aRelease=false)
Definition: pcb_netlist.h:153
void SetFootprintFilters(const wxArrayString &aFilters)
Definition: pcb_netlist.h:147
void AddNet(const wxString &aPinName, const wxString &aNetName, const wxString &aPinFunction, const wxString &aPinType)
Definition: pcb_netlist.h:103
wxString m_library
The name of the component library where m_name was found.
Definition: pcb_netlist.h:185
LIB_ID m_fpid
The LIB_ID of the footprint assigned to the component.
Definition: pcb_netlist.h:188
const wxArrayString & GetFootprintFilters() const
Definition: pcb_netlist.h:148
std::vector< COMPONENT_NET > m_nets
list of nets shared by the component pins
Definition: pcb_netlist.h:168
const std::vector< KIID > & GetKIIDs() const
Definition: pcb_netlist.h:145
COMPONENT(const LIB_ID &aFPID, const wxString &aReference, const wxString &aValue, const KIID_PATH &aPath, const std::vector< KIID > &aKiids)
Definition: pcb_netlist.h:87
static COMPONENT_NET m_emptyNet
Definition: pcb_netlist.h:201
std::unique_ptr< FOOTPRINT > m_footprint
The FOOTPRINT loaded for #m_FPID.
Definition: pcb_netlist.h:196
std::map< wxString, wxString > m_properties
Component-specific properties found in the netlist.
Definition: pcb_netlist.h:199
const LIB_ID & GetFPID() const
Definition: pcb_netlist.h:138
unsigned GetNetCount() const
Definition: pcb_netlist.h:109
const wxString & GetLibrary() const
Definition: pcb_netlist.h:123
const wxString & GetName() const
Definition: pcb_netlist.h:120
void SetName(const wxString &aName)
Definition: pcb_netlist.h:119
void SetReference(const wxString &aReference)
Definition: pcb_netlist.h:125
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
Definition: pcb_netlist.h:213
void Format(const char *aDocName, OUTPUTFORMATTER *aOut, int aNestLevel, int aCtl=0)
bool GetReplaceFootprints() const
Definition: pcb_netlist.h:277
void SetReplaceFootprints(bool aReplace)
Definition: pcb_netlist.h:276
void SortByFPID()
bool m_findByTimeStamp
Definition: pcb_netlist.h:301
unsigned GetCount() const
Definition: pcb_netlist.h:234
void AddComponent(COMPONENT *aComponent)
Add aComponent to the NETLIST.
bool IsEmpty() const
Definition: pcb_netlist.h:224
COMPONENT * GetComponentByPath(const KIID_PATH &aPath)
Return a COMPONENT by aPath.
COMPONENT * GetComponentByReference(const wxString &aReference)
Return a COMPONENT by aReference.
void Clear()
Remove all components from the netlist.
Definition: pcb_netlist.h:229
void SetFindByTimeStamp(bool aFindByTimeStamp)
Definition: pcb_netlist.h:273
COMPONENT * GetComponent(unsigned aIndex)
Return the COMPONENT at aIndex.
Definition: pcb_netlist.h:242
bool m_replaceFootprints
Definition: pcb_netlist.h:302
COMPONENTS m_components
Definition: pcb_netlist.h:299
bool IsFindByTimeStamp() const
Definition: pcb_netlist.h:274
void SortByReference()
void FormatCvpcbNetlist(OUTPUTFORMATTER *aOut)
Definition: pcb_netlist.h:293
bool AnyFootprintsLinked() const
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:310
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
std::vector< COMPONENT_NET > COMPONENT_NETS
Definition: pcb_netlist.h:79
boost::ptr_vector< COMPONENT > COMPONENTS
Definition: pcb_netlist.h:205
#define CTL_FOR_CVPCB
Definition: pcb_netlist.h:291