KiCad PCB EDA Suite
netlist_exporter_generic.cpp
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) 1992-2013 jp.charras at wanadoo.fr
5  * Copyright (C) 2013-2017 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 1992-2017 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 #include <build_version.h>
27 #include <sch_base_frame.h>
28 #include <class_library.h>
29 
30 #include <sch_edit_frame.h>
31 #include <symbol_lib_table.h>
32 
34 
35 static bool sortPinsByNumber( LIB_PIN* aPin1, LIB_PIN* aPin2 );
36 
37 bool NETLIST_EXPORTER_GENERIC::WriteNetlist( const wxString& aOutFileName, unsigned aNetlistOptions )
38 {
39  // Prepare list of nets generation
40  for( unsigned ii = 0; ii < m_masterList->size(); ii++ )
41  m_masterList->GetItem( ii )->m_Flag = 0;
42 
43  // output the XML format netlist.
44  wxXmlDocument xdoc;
45 
46  xdoc.SetRoot( makeRoot( GNL_ALL ) );
47 
48  return xdoc.Save( aOutFileName, 2 /* indent bug, today was ignored by wxXml lib */ );
49 }
50 
51 
53 {
54  XNODE* xroot = node( "export" );
55 
56  xroot->AddAttribute( "version", "D" );
57 
58  if( aCtl & GNL_HEADER )
59  // add the "design" header
60  xroot->AddChild( makeDesignHeader() );
61 
62  if( aCtl & GNL_COMPONENTS )
63  xroot->AddChild( makeComponents() );
64 
65  if( aCtl & GNL_PARTS )
66  xroot->AddChild( makeLibParts() );
67 
68  if( aCtl & GNL_LIBRARIES )
69  // must follow makeGenericLibParts()
70  xroot->AddChild( makeLibraries() );
71 
72  if( aCtl & GNL_NETS )
73  xroot->AddChild( makeListOfNets() );
74 
75  return xroot;
76 }
77 
78 
81 {
82  wxString value;
83  wxString datasheet;
84  wxString footprint;
85 
86  std::map< wxString, wxString > f;
87 };
88 
89 
91 {
92  if( comp->GetUnitCount() > 1 )
93  {
94  // Sadly, each unit of a component can have its own unique fields. This block
95  // finds the last non blank field and records it. Last guy wins and the order
96  // of units occuring in a schematic hierarchy is variable. Therefore user
97  // is best off setting fields into only one unit. But this scavenger algorithm
98  // will find any non blank fields in all units and use the last non-blank field
99  // for each unique field name.
100 
101  COMP_FIELDS fields;
102  wxString ref = comp->GetRef( aSheet );
103 
104  SCH_SHEET_LIST sheetList( g_RootSheet );
105 
106  for( unsigned i = 0; i < sheetList.size(); i++ )
107  {
108  for( EDA_ITEM* item = sheetList[i].LastDrawList(); item; item = item->Next() )
109  {
110  if( item->Type() != SCH_COMPONENT_T )
111  continue;
112 
113  SCH_COMPONENT* comp2 = (SCH_COMPONENT*) item;
114 
115  wxString ref2 = comp2->GetRef( &sheetList[i] );
116 
117  if( ref2.CmpNoCase( ref ) != 0 )
118  continue;
119 
120  // The last guy wins. User should only set fields in any one unit.
121  // remark: IsVoid() returns true for empty strings or the "~" string (empty field value)
122  if( !comp2->GetField( VALUE )->IsVoid() )
123  fields.value = comp2->GetField( VALUE )->GetText();
124 
125  if( !comp2->GetField( FOOTPRINT )->IsVoid() )
126  fields.footprint = comp2->GetField( FOOTPRINT )->GetText();
127 
128  if( !comp2->GetField( DATASHEET )->IsVoid() )
129  fields.datasheet = comp2->GetField( DATASHEET )->GetText();
130 
131  for( int fldNdx = MANDATORY_FIELDS; fldNdx < comp2->GetFieldCount(); ++fldNdx )
132  {
133  SCH_FIELD* f = comp2->GetField( fldNdx );
134 
135  if( f->GetText().size() )
136  {
137  fields.f[ f->GetName() ] = f->GetText();
138  }
139  }
140  }
141  }
142 
143  // Do not output field values blank in netlist:
144  if( fields.value.size() )
145  xcomp->AddChild( node( "value", fields.value ) );
146  else // value field always written in netlist
147  xcomp->AddChild( node( "value", "~" ) );
148 
149  if( fields.footprint.size() )
150  xcomp->AddChild( node( "footprint", fields.footprint ) );
151 
152  if( fields.datasheet.size() )
153  xcomp->AddChild( node( "datasheet", fields.datasheet ) );
154 
155  if( fields.f.size() )
156  {
157  XNODE* xfields;
158  xcomp->AddChild( xfields = node( "fields" ) );
159 
160  // non MANDATORY fields are output alphabetically
161  for( std::map< wxString, wxString >::const_iterator it = fields.f.begin();
162  it != fields.f.end(); ++it )
163  {
164  XNODE* xfield;
165  xfields->AddChild( xfield = node( "field", it->second ) );
166  xfield->AddAttribute( "name", it->first );
167  }
168  }
169  }
170  else
171  {
172  xcomp->AddChild( node( "value", comp->GetField( VALUE )->GetText() ) );
173 
174  if( !comp->GetField( FOOTPRINT )->IsVoid() )
175  xcomp->AddChild( node( "footprint", comp->GetField( FOOTPRINT )->GetText() ) );
176 
177  if( !comp->GetField( DATASHEET )->IsVoid() )
178  xcomp->AddChild( node( "datasheet", comp->GetField( DATASHEET )->GetText() ) );
179 
180  // Export all user defined fields within the component,
181  // which start at field index MANDATORY_FIELDS. Only output the <fields>
182  // container element if there are any <field>s.
183  if( comp->GetFieldCount() > MANDATORY_FIELDS )
184  {
185  XNODE* xfields;
186  xcomp->AddChild( xfields = node( "fields" ) );
187 
188  for( int fldNdx = MANDATORY_FIELDS; fldNdx < comp->GetFieldCount(); ++fldNdx )
189  {
190  SCH_FIELD* f = comp->GetField( fldNdx );
191 
192  // only output a field if non empty and not just "~"
193  if( !f->IsVoid() )
194  {
195  XNODE* xfield;
196  xfields->AddChild( xfield = node( "field", f->GetText() ) );
197  xfield->AddAttribute( "name", f->GetName() );
198  }
199  }
200  }
201  }
202 }
203 
204 
206 {
207  XNODE* xcomps = node( "components" );
208 
209  wxString timeStamp;
210 
212 
213  SCH_SHEET_LIST sheetList( g_RootSheet );
214 
215  // Output is xml, so there is no reason to remove spaces from the field values.
216  // And XML element names need not be translated to various languages.
217 
218  for( unsigned i = 0; i < sheetList.size(); i++ )
219  {
220  for( EDA_ITEM* schItem = sheetList[i].LastDrawList(); schItem; schItem = schItem->Next() )
221  {
222  SCH_COMPONENT* comp = findNextComponent( schItem, &sheetList[i] );
223 
224  if( !comp )
225  break; // No component left
226 
227  schItem = comp;
228 
229  XNODE* xcomp; // current component being constructed
230 
231  // Output the component's elements in order of expected access frequency.
232  // This may not always look best, but it will allow faster execution
233  // under XSL processing systems which do sequential searching within
234  // an element.
235 
236  xcomps->AddChild( xcomp = node( "comp" ) );
237  xcomp->AddAttribute( "ref", comp->GetRef( &sheetList[i] ) );
238 
239  addComponentFields( xcomp, comp, &sheetList[i] );
240 
241  XNODE* xlibsource;
242  xcomp->AddChild( xlibsource = node( "libsource" ) );
243 
244  // "logical" library name, which is in anticipation of a better search
245  // algorithm for parts based on "logical_lib.part" and where logical_lib
246  // is merely the library name minus path and extension.
247  PART_SPTR part = comp->GetPartRef().lock();
248 
249  if( part )
250  xlibsource->AddAttribute( "lib", part->GetLibId().GetLibNickname() );
251 
252  // We only want the symbol name, not the full LIB_ID.
253  xlibsource->AddAttribute( "part", comp->GetLibId().GetLibItemName() );
254 
255  XNODE* xsheetpath;
256 
257  xcomp->AddChild( xsheetpath = node( "sheetpath" ) );
258  xsheetpath->AddAttribute( "names", sheetList[i].PathHumanReadable() );
259  xsheetpath->AddAttribute( "tstamps", sheetList[i].Path() );
260 
261  timeStamp.Printf( "%8.8lX", (unsigned long)comp->GetTimeStamp() );
262  xcomp->AddChild( node( "tstamp", timeStamp ) );
263  }
264  }
265 
266  return xcomps;
267 }
268 
269 
271 {
272  SCH_SCREEN* screen;
273  XNODE* xdesign = node( "design" );
274  XNODE* xtitleBlock;
275  XNODE* xsheet;
276  XNODE* xcomment;
277  wxString sheetTxt;
278  wxFileName sourceFileName;
279 
280  // the root sheet is a special sheet, call it source
281  xdesign->AddChild( node( "source", g_RootSheet->GetScreen()->GetFileName() ) );
282 
283  xdesign->AddChild( node( "date", DateAndTime() ) );
284 
285  // which Eeschema tool
286  xdesign->AddChild( node( "tool", wxString( "Eeschema " ) + GetBuildVersion() ) );
287 
288  /*
289  Export the sheets information
290  */
291  SCH_SHEET_LIST sheetList( g_RootSheet );
292 
293  for( unsigned i = 0; i < sheetList.size(); i++ )
294  {
295  screen = sheetList[i].LastScreen();
296 
297  xdesign->AddChild( xsheet = node( "sheet" ) );
298 
299  // get the string representation of the sheet index number.
300  // Note that sheet->GetIndex() is zero index base and we need to increment the
301  // number by one to make it human readable
302  sheetTxt.Printf( "%u", i + 1 );
303  xsheet->AddAttribute( "number", sheetTxt );
304  xsheet->AddAttribute( "name", sheetList[i].PathHumanReadable() );
305  xsheet->AddAttribute( "tstamps", sheetList[i].Path() );
306 
307 
308  TITLE_BLOCK tb = screen->GetTitleBlock();
309 
310  xsheet->AddChild( xtitleBlock = node( "title_block" ) );
311 
312  xtitleBlock->AddChild( node( "title", tb.GetTitle() ) );
313  xtitleBlock->AddChild( node( "company", tb.GetCompany() ) );
314  xtitleBlock->AddChild( node( "rev", tb.GetRevision() ) );
315  xtitleBlock->AddChild( node( "date", tb.GetDate() ) );
316 
317  // We are going to remove the fileName directories.
318  sourceFileName = wxFileName( screen->GetFileName() );
319  xtitleBlock->AddChild( node( "source", sourceFileName.GetFullName() ) );
320 
321  xtitleBlock->AddChild( xcomment = node( "comment" ) );
322  xcomment->AddAttribute( "number", "1" );
323  xcomment->AddAttribute( "value", tb.GetComment1() );
324 
325  xtitleBlock->AddChild( xcomment = node( "comment" ) );
326  xcomment->AddAttribute( "number", "2" );
327  xcomment->AddAttribute( "value", tb.GetComment2() );
328 
329  xtitleBlock->AddChild( xcomment = node( "comment" ) );
330  xcomment->AddAttribute( "number", "3" );
331  xcomment->AddAttribute( "value", tb.GetComment3() );
332 
333  xtitleBlock->AddChild( xcomment = node( "comment" ) );
334  xcomment->AddAttribute( "number", "4" );
335  xcomment->AddAttribute( "value", tb.GetComment4() );
336  }
337 
338  return xdesign;
339 }
340 
341 
343 {
344  XNODE* xlibs = node( "libraries" ); // auto_ptr
345 
346  for( std::set<wxString>::iterator it = m_libraries.begin(); it!=m_libraries.end(); ++it )
347  {
348  wxString libNickname = *it;
349  XNODE* xlibrary;
350 
351  if( m_libTable->HasLibrary( libNickname ) )
352  {
353  xlibs->AddChild( xlibrary = node( "library" ) );
354  xlibrary->AddAttribute( "logical", libNickname );
355  xlibrary->AddChild( node( "uri", m_libTable->GetFullURI( libNickname ) ) );
356  }
357 
358  // @todo: add more fun stuff here
359  }
360 
361  return xlibs;
362 }
363 
364 
366 {
367  XNODE* xlibparts = node( "libparts" ); // auto_ptr
368 
369  LIB_PINS pinList;
370  LIB_FIELDS fieldList;
371 
372  m_libraries.clear();
373 
374  for( std::set<LIB_PART*>::iterator it = m_LibParts.begin(); it!=m_LibParts.end(); ++it )
375  {
376  LIB_PART* lcomp = *it;
377  wxString libNickname = lcomp->GetLibId().GetLibNickname();;
378 
379  // The library nickname will be empty if the cache library is used.
380  if( !libNickname.IsEmpty() )
381  m_libraries.insert( libNickname ); // inserts component's library if unique
382 
383  XNODE* xlibpart;
384  xlibparts->AddChild( xlibpart = node( "libpart" ) );
385  xlibpart->AddAttribute( "lib", libNickname );
386  xlibpart->AddAttribute( "part", lcomp->GetName() );
387 
388  if( lcomp->GetAliasCount() )
389  {
390  wxArrayString aliases = lcomp->GetAliasNames( false );
391  if( aliases.GetCount() )
392  {
393  XNODE* xaliases = node( "aliases" );
394  xlibpart->AddChild( xaliases );
395  for( unsigned i=0; i<aliases.GetCount(); ++i )
396  {
397  xaliases->AddChild( node( "alias", aliases[i] ) );
398  }
399  }
400  }
401 
402  //----- show the important properties -------------------------
403  if( !lcomp->GetAlias( 0 )->GetDescription().IsEmpty() )
404  xlibpart->AddChild( node( "description", lcomp->GetAlias( 0 )->GetDescription() ) );
405 
406  if( !lcomp->GetAlias( 0 )->GetDocFileName().IsEmpty() )
407  xlibpart->AddChild( node( "docs", lcomp->GetAlias( 0 )->GetDocFileName() ) );
408 
409  // Write the footprint list
410  if( lcomp->GetFootprints().GetCount() )
411  {
412  XNODE* xfootprints;
413  xlibpart->AddChild( xfootprints = node( "footprints" ) );
414 
415  for( unsigned i=0; i<lcomp->GetFootprints().GetCount(); ++i )
416  {
417  xfootprints->AddChild( node( "fp", lcomp->GetFootprints()[i] ) );
418  }
419  }
420 
421  //----- show the fields here ----------------------------------
422  fieldList.clear();
423  lcomp->GetFields( fieldList );
424 
425  XNODE* xfields;
426  xlibpart->AddChild( xfields = node( "fields" ) );
427 
428  for( unsigned i=0; i<fieldList.size(); ++i )
429  {
430  if( !fieldList[i].GetText().IsEmpty() )
431  {
432  XNODE* xfield;
433  xfields->AddChild( xfield = node( "field", fieldList[i].GetText() ) );
434  xfield->AddAttribute( "name", fieldList[i].GetName(false) );
435  }
436  }
437 
438  //----- show the pins here ------------------------------------
439  pinList.clear();
440  lcomp->GetPins( pinList, 0, 0 );
441 
442  /* we must erase redundant Pins references in pinList
443  * These redundant pins exist because some pins
444  * are found more than one time when a component has
445  * multiple parts per package or has 2 representations (DeMorgan conversion)
446  * For instance, a 74ls00 has DeMorgan conversion, with different pin shapes,
447  * and therefore each pin appears 2 times in the list.
448  * Common pins (VCC, GND) can also be found more than once.
449  */
450  sort( pinList.begin(), pinList.end(), sortPinsByNumber );
451  for( int ii = 0; ii < (int)pinList.size()-1; ii++ )
452  {
453  if( pinList[ii]->GetNumber() == pinList[ii+1]->GetNumber() )
454  { // 2 pins have the same number, remove the redundant pin at index i+1
455  pinList.erase(pinList.begin() + ii + 1);
456  ii--;
457  }
458  }
459 
460  if( pinList.size() )
461  {
462  XNODE* pins;
463 
464  xlibpart->AddChild( pins = node( "pins" ) );
465  for( unsigned i=0; i<pinList.size(); ++i )
466  {
467  XNODE* pin;
468 
469  pins->AddChild( pin = node( "pin" ) );
470  pin->AddAttribute( "num", pinList[i]->GetNumber() );
471  pin->AddAttribute( "name", pinList[i]->GetName() );
472  pin->AddAttribute( "type", pinList[i]->GetCanonicalElectricalTypeName() );
473 
474  // caution: construction work site here, drive slowly
475  }
476  }
477  }
478 
479  return xlibparts;
480 }
481 
482 
484 {
485  XNODE* xnets = node( "nets" ); // auto_ptr if exceptions ever get used.
486  wxString netCodeTxt;
487  wxString netName;
488  wxString ref;
489 
490  XNODE* xnet = 0;
491  int netCode;
492  int lastNetCode = -1;
493  int sameNetcodeCount = 0;
494 
495 
496  /* output:
497  <net code="123" name="/cfcard.sch/WAIT#">
498  <node ref="R23" pin="1"/>
499  <node ref="U18" pin="12"/>
500  </net>
501  */
502 
503  m_LibParts.clear(); // must call this function before using m_LibParts.
504 
505  for( unsigned ii = 0; ii < m_masterList->size(); ii++ )
506  {
507  NETLIST_OBJECT* nitem = m_masterList->GetItem( ii );
508  SCH_COMPONENT* comp;
509 
510  // New net found, write net id;
511  if( ( netCode = nitem->GetNet() ) != lastNetCode )
512  {
513  sameNetcodeCount = 0; // item count for this net
514  netName = nitem->GetNetName();
515  lastNetCode = netCode;
516  }
517 
518  if( nitem->m_Type != NET_PIN )
519  continue;
520 
521  if( nitem->m_Flag != 0 ) // Redundant pin, skip it
522  continue;
523 
524  comp = nitem->GetComponentParent();
525 
526  // Get the reference for the net name and the main parent component
527  ref = comp->GetRef( &nitem->m_SheetPath );
528  if( ref[0] == wxChar( '#' ) )
529  continue;
530 
531  if( ++sameNetcodeCount == 1 )
532  {
533  xnets->AddChild( xnet = node( "net" ) );
534  netCodeTxt.Printf( "%d", netCode );
535  xnet->AddAttribute( "code", netCodeTxt );
536  xnet->AddAttribute( "name", netName );
537  }
538 
539  XNODE* xnode;
540  xnet->AddChild( xnode = node( "node" ) );
541  xnode->AddAttribute( "ref", ref );
542  xnode->AddAttribute( "pin", nitem->GetPinNumText() );
543  }
544 
545  return xnets;
546 }
547 
548 
549 XNODE* NETLIST_EXPORTER_GENERIC::node( const wxString& aName, const wxString& aTextualContent /* = wxEmptyString*/ )
550 {
551  XNODE* n = new XNODE( wxXML_ELEMENT_NODE, aName );
552 
553  if( aTextualContent.Len() > 0 ) // excludes wxEmptyString, the parameter's default value
554  n->AddChild( new XNODE( wxXML_TEXT_NODE, wxEmptyString, aTextualContent ) );
555 
556  return n;
557 }
558 
559 
560 static bool sortPinsByNumber( LIB_PIN* aPin1, LIB_PIN* aPin2 )
561 {
562  // return "lhs < rhs"
563  return RefDesStringCompare( aPin1->GetNumber(), aPin2->GetNumber() ) < 0;
564 }
Class SCH_SHEET_LIST.
bool WriteNetlist(const wxString &aOutFileName, unsigned aNetlistOptions) override
Function WriteNetlist writes to specified output file.
int RefDesStringCompare(const wxString &strFWord, const wxString &strSWord)
Function RefDesStringCompare acts just like the strcmp function but treats numbers within the string ...
Definition: string.cpp:365
Class SCH_FIELD instances are attached to a component and provide a place for the component&#39;s value...
Definition: sch_field.h:56
wxString GetNetName(bool adoptTimestamp=false) const
Function GetNetName.
wxString GetName(bool aUseDefaultName=true) const
Function GetName returns the field name.
Definition: sch_field.cpp:424
PART_REF & GetPartRef()
name of datasheet
const wxString & GetPinNumText() const
Function GetPinNum returns a pin number in wxString form.
XNODE * makeComponents()
Function makeComponents.
UNIQUE_STRINGS m_ReferencesAlreadyFound
Used for "multi parts per package" components, avoids processing a lib component more than once...
XNODE * node(const wxString &aName, const wxString &aTextualContent=wxEmptyString)
Function node is a convenience function that creates a new XNODE with an optional textual child...
LIB_ALIAS * GetAlias(size_t aIndex)
const wxString & GetCompany() const
Definition: title_block.h:98
NETLIST_OBJECT * GetItem(unsigned aIdx) const
Acces to an item in list.
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
const wxString & GetFileName() const
Definition: sch_screen.h:120
bool IsVoid() const
Function IsVoid returns true if the field is either empty or holds "~".
Definition: sch_field.h:116
const LIB_ID & GetLibId() const
const wxString & GetComment4() const
Definition: title_block.h:123
const wxString & GetDate() const
Definition: title_block.h:78
SCH_SHEET_PATH m_SheetPath
int GetUnitCount() const
Return the number of units per package of the symbol.
void Clear()
Function Clear erases the record.
SCH_COMPONENT * findNextComponent(EDA_ITEM *aItem, SCH_SHEET_PATH *aSheetPath)
size_t GetAliasCount() const
NETLIST_ITEM_T m_Type
SCH_SCREEN * GetScreen()
Definition: sch_sheet.h:279
Class TITLE_BLOCK holds the information shown in the lower right corner of a plot, printout, or editing view.
Definition: title_block.h:39
NETLIST_OBJECT_LIST * m_masterList
Field Name Module PCB, i.e. "16DIP300".
const wxString & GetNumber() const
Definition: lib_pin.h:193
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
XNODE * makeRoot(int aCtl=GNL_ALL)
Function makeGenericRoot builds the entire document tree for the generic export.
std::set< LIB_PART *, LIB_PART_LESS_THAN > m_LibParts
unique library parts used. LIB_PART items are sorted by names
const wxString & GetTitle() const
Definition: title_block.h:64
std::set< wxString > m_libraries
Set of library nicknames.
int GetNet() const
SCH_SHEET * g_RootSheet
Definition: eeschema.cpp:55
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
void addComponentFields(XNODE *xcomp, SCH_COMPONENT *comp, SCH_SHEET_PATH *aSheet)
wxString GetBuildVersion()
Function GetBuildVersion Return the build version string.
const UTF8 & GetLibItemName() const
Definition: lib_id.h:115
const wxString & GetRevision() const
Definition: title_block.h:88
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:128
std::shared_ptr< LIB_PART > PART_SPTR
shared pointer to LIB_PART
XNODE * makeDesignHeader()
Function makeDesignHeader fills out a project "design" header into an XML node.
wxString GetDescription() const
Define a library symbol object.
Holder for multi-unit component fields.
const wxString & GetComment3() const
Definition: title_block.h:122
wxString GetText(GRAPHIC_PINSHAPE shape)
Definition: pin_shape.cpp:33
Class SCH_SHEET_PATH.
const wxString GetRef(const SCH_SHEET_PATH *aSheet)
Return the reference for the given sheet path.
wxArrayString & GetFootprints()
SCH_COMPONENT * GetComponentParent() const
For Pins (NET_PINS):
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:125
const wxString & GetComment2() const
Definition: title_block.h:121
Class XNODE holds an XML or S-expression element.
Definition: xnode.h:43
wxString GetFullURI(const wxString &aLibNickname, bool aExpandEnvVars=true) const
Return the full URI of the library mapped to aLibNickname.
wxString GetDocFileName() const
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_draw_item.h:60
const wxString & GetComment1() const
Definition: title_block.h:120
int GetFieldCount() const
Return the number of fields in this symbol.
std::vector< LIB_FIELD > LIB_FIELDS
Definition: lib_field.h:257
wxArrayString GetAliasNames(bool aIncludeRoot=true) const
#define GNL_ALL
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
const LIB_ID & GetLibId() const
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:180
XNODE * makeLibraries()
Function makeLibraries fills out an XML node with a list of used libraries and returns it...
std::map< wxString, wxString > f
const wxString & GetName() const
bool HasLibrary(const wxString &aNickname) const
Test for the existence of aNickname in the library table.
Definition for part library class.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:98
static bool sortPinsByNumber(LIB_PIN *aPin1, LIB_PIN *aPin2)
#define VALUE
XNODE * makeListOfNets()
Function makeListOfNets fills out an XML node with a list of nets and returns it. ...
wxString DateAndTime()
Function DateAndTime.
Definition: string.cpp:229
timestamp_t GetTimeStamp() const
Definition: base_struct.h:233
void GetFields(LIB_FIELDS &aList)
Return a list of fields withing this part.
XNODE * makeLibParts()
Function makeLibParts fills out an XML node with the unique library parts and returns it...