KiCad PCB EDA Suite
class_board.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) 2007 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
5  * Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef CLASS_BOARD_H_
26 #define CLASS_BOARD_H_
27 
28 #include <tuple>
29 #include <core/iterators.h>
30 #include <board_design_settings.h>
31 #include <board_item_container.h>
32 #include <class_module.h>
33 #include <class_pad.h>
34 #include <pcb_general_settings.h>
35 #include <common.h> // PAGE_INFO
36 #include <eda_rect.h>
38 #include <netinfo.h>
39 #include <pcb_plot_params.h>
40 #include <title_block.h>
41 #include <zone_settings.h>
42 
43 #include <memory>
44 
45 using std::unique_ptr;
46 
47 class PCB_BASE_FRAME;
48 class PCB_EDIT_FRAME;
49 class PICKED_ITEMS_LIST;
50 class BOARD;
51 class ZONE_CONTAINER;
52 class TRACK;
53 class D_PAD;
54 class MARKER_PCB;
55 class MSG_PANEL_ITEM;
56 class NETLIST;
57 class REPORTER;
58 class SHAPE_POLY_SET;
59 class CONNECTIVITY_DATA;
60 class COMPONENT;
61 
66 enum LAYER_T
67 {
73 };
74 
75 
80 struct LAYER
81 {
83  {
84  clear();
85  }
86 
87  void clear()
88  {
89  m_type = LT_SIGNAL;
90  m_visible = true;
91  m_number = 0;
92  m_name.clear();
93  }
94 
95  /*
96  LAYER( const wxString& aName = wxEmptyString,
97  LAYER_T aType = LT_SIGNAL, bool aVisible = true, int aNumber = -1 ) :
98  m_name( aName ),
99  m_type( aType ),
100  m_visible( aVisible ),
101  m_number( aNumber )
102  {
103  }
104  */
105 
106  wxString m_name;
108  bool m_visible;
109  int m_number;
110 
117  static const char* ShowType( LAYER_T aType );
118 
126  static LAYER_T ParseType( const char* aType );
127 };
128 
129 
130 // Helper class to handle high light nets
132 {
133  friend class BOARD;
134 
135 protected:
136  int m_netCode; // net selected for highlight (-1 when no net selected )
137  bool m_highLightOn; // highlight active
138 
139  void Clear()
140  {
141  m_netCode = -1;
142  m_highLightOn = false;
143  }
144 
146  {
147  Clear();
148  }
149 };
150 
151 
152 DECL_VEC_FOR_SWIG( MARKERS, MARKER_PCB* )
153 DECL_VEC_FOR_SWIG( ZONE_CONTAINERS, ZONE_CONTAINER* )
154 DECL_DEQ_FOR_SWIG( TRACKS, TRACK* )
155 
156 
157 
162 {
163  friend class PCB_EDIT_FRAME;
164 
165 private:
167  wxString m_fileName;
168 
170  MARKERS m_markers;
171 
173  DRAWINGS m_drawings;
174 
176  MODULES m_modules;
177 
179  TRACKS m_tracks;
180 
182  ZONE_CONTAINERS m_ZoneDescriptorList;
183 
185 
186  // if true m_highLight_NetCode is used
187  HIGH_LIGHT_INFO m_highLight; // current high light data
188  HIGH_LIGHT_INFO m_highLightPrevious; // a previously stored high light data
189 
191 
192  std::shared_ptr<CONNECTIVITY_DATA> m_connectivity;
193 
200 
201 
202  // The default copy constructor & operator= are inadequate,
203  // either write one or do not use it at all
204  BOARD( const BOARD& aOther ) = delete;
205 
206  BOARD& operator=( const BOARD& aOther ) = delete;
207 
208 public:
209  static inline bool ClassOf( const EDA_ITEM* aItem )
210  {
211  return aItem && PCB_T == aItem->Type();
212  }
213 
214  void SetFileName( const wxString& aFileName ) { m_fileName = aFileName; }
215 
216  const wxString &GetFileName() const { return m_fileName; }
217 
218  TRACKS& Tracks()
219  {
220  return m_tracks;
221  }
222  const TRACKS& Tracks() const
223  {
224  return m_tracks;
225  }
226 
227  MODULES& Modules()
228  {
229  return m_modules;
230  }
231  const MODULES& Modules() const
232  {
233  return m_modules;
234  }
235 
236  DRAWINGS& Drawings()
237  {
238  return m_drawings;
239  }
240 
241  ZONE_CONTAINERS& Zones()
242  {
243  return m_ZoneDescriptorList;
244  }
245 
246  const std::vector<BOARD_CONNECTED_ITEM*> AllConnectedItems();
247 
250 
251  BOARD();
252  ~BOARD();
253 
254  const wxPoint GetPosition() const override;
255  void SetPosition( const wxPoint& aPos ) override;
256 
257  bool IsEmpty() const
258  {
259  return m_drawings.empty() && m_modules.empty() && m_tracks.empty() &&
260  m_ZoneDescriptorList.empty();
261  }
262 
263  void Move( const wxPoint& aMoveVector ) override;
264 
265  void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
266  int GetFileFormatVersionAtLoad() const { return m_fileFormatVersionAtLoad; }
267 
268  void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_INSERT ) override;
269 
270  void Remove( BOARD_ITEM* aBoardItem ) override;
271 
277  {
278  return m_modules.empty() ? nullptr : m_modules.front();
279  }
280 
285  {
286  for( MODULE* mod : m_modules )
287  delete mod;
288 
289  m_modules.clear();
290  }
291 
292  BOARD_ITEM* GetItem( void* aWeakReference );
293 
294  BOARD_ITEM* Duplicate( const BOARD_ITEM* aItem, bool aAddToBoard = false );
295 
301  std::shared_ptr<CONNECTIVITY_DATA> GetConnectivity() const
302  {
303  return m_connectivity;
304  }
305 
311  void BuildConnectivity();
312 
313 
318  void DeleteMARKERs();
319 
324  void DeleteZONEOutlines();
325 
332  MARKER_PCB* GetMARKER( int index ) const
333  {
334  if( (unsigned) index < m_markers.size() )
335  return m_markers[index];
336 
337  return NULL;
338  }
339 
344  int GetMARKERCount() const
345  {
346  return (int) m_markers.size();
347  }
348 
353  void SetAuxOrigin( const wxPoint& aPoint ) { m_designSettings.m_AuxOrigin = aPoint; }
354  const wxPoint& GetAuxOrigin() const { return m_designSettings.m_AuxOrigin; }
355 
360  void SetGridOrigin( const wxPoint& aPoint ) { m_designSettings.m_GridOrigin = aPoint; }
361  const wxPoint& GetGridOrigin() const { return m_designSettings.m_GridOrigin; }
362 
368  {
369  m_highLight.Clear();
370  m_highLightPrevious.Clear();
371  }
372 
377  int GetHighLightNetCode() const { return m_highLight.m_netCode; }
378 
383  void SetHighLightNet( int aNetCode)
384  {
385  m_highLight.m_netCode = aNetCode;
386  }
387 
392  bool IsHighLightNetON() const { return m_highLight.m_highLightOn; }
393 
398  void HighLightOFF() { m_highLight.m_highLightOn = false; }
399 
405  void HighLightON() { m_highLight.m_highLightOn = true; }
406 
411  int GetCopperLayerCount() const;
412 
413  void SetCopperLayerCount( int aCount );
414 
421  LSET GetEnabledLayers() const;
422 
429  void SetEnabledLayers( LSET aLayerMask );
430 
438  bool IsLayerEnabled( PCB_LAYER_ID aLayer ) const
439  {
440  return m_designSettings.IsLayerEnabled( aLayer );
441  }
442 
450  bool IsLayerVisible( PCB_LAYER_ID aLayer ) const
451  {
452  return m_designSettings.IsLayerVisible( aLayer );
453  }
454 
461  LSET GetVisibleLayers() const;
462 
469  void SetVisibleLayers( LSET aLayerMask );
470 
471  // these 2 functions are not tidy at this time, since there are PCB_LAYER_IDs that
472  // are not stored in the bitmap.
473 
481  int GetVisibleElements() const;
482 
490  void SetVisibleElements( int aMask );
491 
497  void SetVisibleAlls();
498 
507  bool IsElementVisible( GAL_LAYER_ID aLayer ) const;
508 
516  void SetElementVisibility( GAL_LAYER_ID aLayer, bool aNewState );
517 
525  bool IsModuleLayerVisible( PCB_LAYER_ID aLayer );
526 
532  {
533  // remove const-ness with cast. TODO(snh): Make GetDesignSettings const
534  return const_cast<BOARD_DESIGN_SETTINGS&>( m_designSettings );
535  }
536 
541  void SetDesignSettings( const BOARD_DESIGN_SETTINGS& aDesignSettings )
542  {
543  m_designSettings = aDesignSettings;
544  }
545 
546  const PAGE_INFO& GetPageSettings() const { return m_paper; }
547  void SetPageSettings( const PAGE_INFO& aPageSettings ) { m_paper = aPageSettings; }
548 
549  const PCB_PLOT_PARAMS& GetPlotOptions() const { return m_plotOptions; }
550  void SetPlotOptions( const PCB_PLOT_PARAMS& aOptions ) { m_plotOptions = aOptions; }
551 
552  TITLE_BLOCK& GetTitleBlock() { return m_titles; }
553  void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) { m_titles = aTitleBlock; }
554 
555  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
556 
561  const COLORS_DESIGN_SETTINGS& Colors() const { return m_generalSettings->Colors(); }
562 
563  const PCB_GENERAL_SETTINGS& GeneralSettings() const { return *m_generalSettings; }
564 
565  void SetGeneralSettings( PCB_GENERAL_SETTINGS* aGeneralSettings )
566  {
567  m_generalSettings = aGeneralSettings;
568  }
569 
585  bool GetBoardPolygonOutlines( SHAPE_POLY_SET& aOutlines,
586  wxString* aErrorText = nullptr, wxPoint* aErrorLocation = nullptr );
587 
599  void ConvertBrdLayerToPolygonalContours( PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aOutlines );
600 
611  const PCB_LAYER_ID GetLayerID( const wxString& aLayerName ) const;
612 
623  const wxString GetLayerName( PCB_LAYER_ID aLayer ) const;
624 
634  bool SetLayerName( PCB_LAYER_ID aLayer, const wxString& aLayerName );
635 
647  static wxString GetStandardLayerName( PCB_LAYER_ID aLayerId )
648  {
649  // a BOARD's standard layer name is the PCB_LAYER_ID fixed name
650  return LSET::Name( aLayerId );
651  }
652 
661  bool SetLayerDescr( PCB_LAYER_ID aIndex, const LAYER& aLayer );
662 
671  LAYER_T GetLayerType( PCB_LAYER_ID aLayer ) const;
672 
681  bool SetLayerType( PCB_LAYER_ID aLayer, LAYER_T aLayerType );
682 
688  unsigned GetNodesCount( int aNet = -1 );
689 
694  unsigned GetUnconnectedNetCount() const;
695 
700  unsigned GetPadCount();
701 
706  D_PAD* GetPad( unsigned aIndex ) const;
707 
715  const std::vector<D_PAD*> GetPads();
716 
718  {
719  m_NetInfo.buildListOfNets();
720  }
721 
728  NETINFO_ITEM* FindNet( int aNetcode ) const;
729 
736  NETINFO_ITEM* FindNet( const wxString& aNetname ) const;
737 
739  {
740  return m_NetInfo;
741  }
742 
743 #ifndef SWIG
744 
749  {
750  return m_NetInfo.begin();
751  }
752 
758  {
759  return m_NetInfo.end();
760  }
761 #endif
762 
767  unsigned GetNetCount() const
768  {
769  return m_NetInfo.GetNetCount();
770  }
771 
778  EDA_RECT ComputeBoundingBox( bool aBoardEdgesOnly = false ) const;
779 
780  const EDA_RECT GetBoundingBox() const override
781  {
782  return ComputeBoundingBox( false );
783  }
784 
793  {
794  return ComputeBoundingBox( true );
795  }
796 
797  void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList ) override;
798 
807  void Print( PCB_BASE_FRAME* aFrame, wxDC* aDC, const wxPoint& aOffset = ZeroOffset ) override;
808 
822  SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] ) override;
823 
833  MODULE* FindModuleByReference( const wxString& aReference ) const;
834 
844  MODULE* FindModule( const wxString& aRefOrTimeStamp, bool aSearchByTimeStamp = false ) const;
845 
853  int SortedNetnamesList( wxArrayString& aNames, bool aSortbyPadsCount );
854 
862  void SynchronizeNetsAndNetClasses();
863 
864  /***************************************************************************/
865 
866  wxString GetClass() const override
867  {
868  return wxT( "BOARD" );
869  }
870 
871 #if defined(DEBUG)
872  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
873 #endif
874 
875 
876  /*************************/
877  /* Copper Areas handling */
878  /*************************/
879 
891  ZONE_CONTAINER* HitTestForAnyFilledArea( const wxPoint& aRefPos,
892  PCB_LAYER_ID aStartLayer,
893  PCB_LAYER_ID aEndLayer,
894  int aNetCode );
895 
906  int SetAreasNetCodesFromNetNames( void );
907 
914  ZONE_CONTAINER* GetArea( int index ) const
915  {
916  if( (unsigned) index < m_ZoneDescriptorList.size() )
917  return m_ZoneDescriptorList[index];
918 
919  return NULL;
920  }
921 
928  int GetAreaIndex( const ZONE_CONTAINER* aArea ) const
929  {
930  for( int ii = 0; ii < GetAreaCount(); ii++ ) // Search for aArea in list
931  {
932  if( aArea == GetArea( ii ) ) // Found !
933  return ii;
934  }
935 
936  return -1;
937  }
938 
943  std::list<ZONE_CONTAINER*> GetZoneList( bool aIncludeZonesInFootprints = false );
944 
949  int GetAreaCount() const
950  {
951  return (int) m_ZoneDescriptorList.size();
952  }
953 
954  /* Functions used in test, merge and cut outlines */
955 
967  ZONE_CONTAINER* AddArea( PICKED_ITEMS_LIST* aNewZonesList, int aNetcode,
968  PCB_LAYER_ID aLayer, wxPoint aStartPointPosition, int aHatch );
969 
980  ZONE_CONTAINER* InsertArea( int aNetcode, int aAreaIdx, PCB_LAYER_ID aLayer,
981  int aCornerX, int aCornerY, int aHatch );
982 
992  bool NormalizeAreaPolygon( PICKED_ITEMS_LIST* aNewZonesList, ZONE_CONTAINER* aCurrArea );
993 
1004  bool OnAreaPolygonModified( PICKED_ITEMS_LIST* aModifiedZonesList,
1005  ZONE_CONTAINER* modified_area );
1006 
1017  bool CombineAllAreasInNet( PICKED_ITEMS_LIST* aDeletedList,
1018  int aNetCode,
1019  bool aUseLocalFlags );
1020 
1028  void RemoveArea( PICKED_ITEMS_LIST* aDeletedList, ZONE_CONTAINER* area_to_remove );
1029 
1035  bool TestAreaIntersections( ZONE_CONTAINER* area_to_test );
1036 
1045  bool TestAreaIntersection( ZONE_CONTAINER* area_ref, ZONE_CONTAINER* area_to_test );
1046 
1058  bool CombineAreas( PICKED_ITEMS_LIST* aDeletedList,
1059  ZONE_CONTAINER* area_ref,
1060  ZONE_CONTAINER* area_to_combine );
1061 
1070  D_PAD* GetPad( const wxPoint& aPosition, LSET aLayerMask );
1071  D_PAD* GetPad( const wxPoint& aPosition )
1072  {
1073  return GetPad( aPosition, LSET().set() );
1074  }
1075 
1084  D_PAD* GetPad( TRACK* aTrace, ENDPOINT_T aEndPoint );
1085 
1096  D_PAD* GetPadFast( const wxPoint& aPosition, LSET aLayerMask );
1097 
1113  D_PAD* GetPad( std::vector<D_PAD*>& aPadList, const wxPoint& aPosition, LSET aLayerMask );
1114 
1121  void PadDelete( D_PAD* aPad );
1122 
1135  void GetSortedPadListByXthenYCoord( std::vector<D_PAD*>& aVector, int aNetCode = -1 );
1136 
1144  std::tuple<int, double, double> GetTrackLength( const TRACK& aTrack ) const;
1145 
1153  TRACKS TracksInNet( int aNetCode );
1154 
1169  MODULE* GetFootprint( const wxPoint& aPosition, PCB_LAYER_ID aActiveLayer,
1170  bool aVisibleOnly, bool aIgnoreLocked = false );
1171 
1176  void ClearAllNetCodes();
1177 
1183  void MapNets( const BOARD* aDestBoard );
1184 
1185  void SanitizeNetcodes();
1186 };
1187 
1188 #endif // CLASS_BOARD_H_
MODULES m_modules
MODULES for components on the board, owned by pointer.
Definition: class_board.h:176
iterator end() const
Definition: netinfo.h:531
Wrapper class, so you can iterate through NETINFO_ITEM*s, not std::pair<int/wxString,...
Definition: netinfo.h:480
void SetFileFormatVersionAtLoad(int aVersion)
Definition: class_board.h:265
D_PAD * GetPad(const wxPoint &aPosition)
Definition: class_board.h:1071
void BuildListOfNets()
Definition: class_board.h:717
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: class_board.h:780
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:546
void SetElementVisibility(GAL_LAYER_ID aElement, bool aNewState)
Function SetElementVisibility changes the visibility of an element category.
static bool ClassOf(const EDA_ITEM *aItem)
Definition: class_board.h:209
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: class_board.h:549
Definition: typeinfo.h:85
int GetMARKERCount() const
Function GetMARKERCount.
Definition: class_board.h:344
wxPoint m_GridOrigin
origin for grid offsets
void SetGridOrigin(const wxPoint &aPoint)
Function SetGridOrigin sets the origin point of the grid.
Definition: class_board.h:360
wxString m_name
The name of the layer, there should be no spaces in this name.
Definition: class_board.h:106
wxString m_fileName
the board filename
Definition: class_board.h:167
void SetPosition(wxString aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
bool IsLayerEnabled(PCB_LAYER_ID aLayerId) const
Function IsLayerEnabled tests whether a given layer is enabled.
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition: class_board.h:553
PAGE_INFO m_paper
Definition: class_board.h:196
const EDA_RECT GetBoardEdgesBoundingBox() const
Function GetBoardEdgesBoundingBox Returns the board bounding box calculated using exclusively the boa...
Definition: class_board.h:792
bool IsHighLightNetON() const
Function IsHighLightNetON.
Definition: class_board.h:392
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: class_board.h:547
LAYER_T m_type
The type of the layer.
Definition: class_board.h:107
NETINFO_LIST::iterator EndNets() const
Function EndNets.
Definition: class_board.h:757
ZONE_CONTAINER * m_CurrentZoneContour
zone contour currently in progress
Definition: class_board.h:249
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
void HighLightOFF()
Function HighLightOFF Disable highlight.
Definition: class_board.h:398
LAYER()
Definition: class_board.h:82
#define DECL_DEQ_FOR_SWIG(TypeName, MemberType)
Definition: macros.h:160
bool IsLayerVisible(PCB_LAYER_ID aLayerId) const
Function IsLayerVisible tests whether a given layer is visible.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:531
HIGH_LIGHT_INFO m_highLight
Definition: class_board.h:187
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
HIGH_LIGHT_INFO m_highLightPrevious
Definition: class_board.h:188
bool IsLayerEnabled(PCB_LAYER_ID aLayer) const
Function IsLayerEnabled is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:438
TRACKS m_tracks
TRACKS for traces on the board, owned by pointer.
Definition: class_board.h:179
const wxString & GetFileName() const
Definition: class_board.h:216
Class TITLE_BLOCK holds the information shown in the lower right corner of a plot,...
Definition: title_block.h:40
PCB_PLOT_PARAMS m_plotOptions
Definition: class_board.h:198
void SetVisibleAlls()
Function SetVisibleAlls Set the status of all visible element categories and layers to VISIBLE.
void SetAuxOrigin(const wxPoint &aPoint)
Function SetAuxOrigin sets the origin point used for plotting.
Definition: class_board.h:353
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
NETINFO_LIST::iterator BeginNets() const
Function BeginNets.
Definition: class_board.h:748
static const char * ShowType(LAYER_T aType)
Function ShowType converts a LAYER_T enum to a const char*.
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:108
PCB_LAYER_ID
A quick note on layer IDs:
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:949
Class LSET is a set of PCB_LAYER_IDs.
void ResetNetHighLight()
Function ResetNetHighLight Reset all high light data to the init state.
Definition: class_board.h:367
Class NETLIST stores all of information read from a netlist along with the flags used to update the N...
Definition: pcb_netlist.h:214
unsigned GetNetCount() const
Function GetNetCount.
Definition: class_board.h:767
MODULES & Modules()
Definition: class_board.h:227
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Function Name returns the fixed name association with aLayerId.
Definition: lset.cpp:73
Class NETINFO_LIST is a container class for NETINFO_ITEM elements, which are the nets.
Definition: netinfo.h:409
Class SHAPE_POLY_SET.
Class PAGE_INFO describes the page size and margins of a paper page on which to eventually print or p...
Definition: page_info.h:54
iterator begin() const
Definition: netinfo.h:526
LAYER_T
Enum LAYER_T gives the allowed types of layers, same as Specctra DSN spec.
Definition: class_board.h:66
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:301
TITLE_BLOCK m_titles
text in lower right of screen and plots
Definition: class_board.h:197
MODULE * GetFirstModule() const
Gets the first module in the list (used in footprint viewer/editor) or NULL if none.
Definition: class_board.h:276
bool m_visible
Definition: class_board.h:108
ENDPOINT_T
Definition: class_track.h:53
#define DECL_VEC_FOR_SWIG(TypeName, MemberType)
Declare a std::vector but no swig template.
Definition: macros.h:159
void SetDesignSettings(const BOARD_DESIGN_SETTINGS &aDesignSettings)
Function SetDesignSettings.
Definition: class_board.h:541
void SetGeneralSettings(PCB_GENERAL_SETTINGS *aGeneralSettings)
Definition: class_board.h:565
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:170
void SetFileName(const wxString &aFileName)
Definition: class_board.h:214
const wxPoint & GetAuxOrigin() const
Definition: class_board.h:354
void SetPlotOptions(const PCB_PLOT_PARAMS &aOptions)
Definition: class_board.h:550
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
static LAYER_T ParseType(const char *aType)
Function ParseType converts a string to a LAYER_T.
const MODULES & Modules() const
Definition: class_board.h:231
Class PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board.
NETINFO_LIST & GetNetInfo()
Definition: class_board.h:738
DRAWINGS m_drawings
BOARD_ITEMs for drawings on the board, owned by pointer.
Definition: class_board.h:173
const wxPoint & GetGridOrigin() const
Definition: class_board.h:361
Pad object description.
COLORS_DESIGN_SETTINGS & Colors()
int GetFileFormatVersionAtLoad() const
Definition: class_board.h:266
void HighLightON()
Function HighLightON Enable highlight.
Definition: class_board.h:405
Class COMPONENT is used to store components and all of their related information found in a netlist.
Definition: pcb_netlist.h:83
MARKER_PCB * GetMARKER(int index) const
Function GetMARKER returns the MARKER at a given index.
Definition: class_board.h:332
int GetHighLightNetCode() const
Function GetHighLightNetCode.
Definition: class_board.h:377
void SetHighLightNet(int aNetCode)
Function SetHighLightNet.
Definition: class_board.h:383
void clear()
Definition: class_board.h:87
const COLORS_DESIGN_SETTINGS & Colors() const
Function GetColorSettings.
Definition: class_board.h:561
Class NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:65
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
Function IsLayerVisible is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:450
ZONE_CONTAINERS & Zones()
Definition: class_board.h:241
TITLE_BLOCK & GetTitleBlock()
Definition: class_board.h:552
Board layer functions and definitions.
const PCB_GENERAL_SETTINGS & GeneralSettings() const
Definition: class_board.h:563
int m_fileFormatVersionAtLoad
the version loaded from the file
Definition: class_board.h:190
PCB_GENERAL_SETTINGS * m_generalSettings
reference only; I have no ownership
Definition: class_board.h:195
Class LAYER holds information pertinent to a layer of a BOARD.
Definition: class_board.h:80
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:182
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:192
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Class PCB_EDIT_FRAME is the main frame for Pcbnew.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
The common library.
wxString GetClass() const override
Function GetClass returns the class name.
Definition: class_board.h:866
const TRACKS & Tracks() const
Definition: class_board.h:222
Class COLORS_DESIGN_SETTINGS is a list of color settings for designs in Pcbnew.
unsigned GetNetCount() const
Function GetNetCount.
Definition: netinfo.h:436
void DeleteAllModules()
Removes all modules from the deque and frees the memory associated with them.
Definition: class_board.h:284
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:194
Module description (excepted pads)
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:914
Abstract interface for BOARD_ITEMs capable of storing other items inside.
int m_number
Definition: class_board.h:109
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
int GetAreaIndex(const ZONE_CONTAINER *aArea) const
Function GetAreaIndex returns the Area Index for the given Zone Container.
Definition: class_board.h:928
bool IsElementVisible(GAL_LAYER_ID aElement) const
Function IsElementVisible tests whether a given element category is visible.
SEARCH_RESULT
Definition: base_struct.h:54
DRAWINGS & Drawings()
Definition: class_board.h:236
bool IsEmpty() const
Definition: class_board.h:257
#define mod(a, n)
Definition: greymap.cpp:24
wxPoint m_AuxOrigin
origin for plot exports
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
EDA_UNITS_T
Definition: common.h:133
TRACKS & Tracks()
Definition: class_board.h:218
void buildListOfNets()
Function buildListOfNets builds or rebuilds the list of NETINFO_ITEMs The list is sorted by names.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Function GetStandardLayerName returns an "English Standard" name of a PCB layer when given aLayerNumb...
Definition: class_board.h:647
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.