KiCad PCB EDA Suite
pcb_component.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, 2008 Lubo Racko <developer@lura.sk>
5  * Copyright (C) 2007, 2008, 2012-2013 Alexander Lunev <al.lunev@yahoo.com>
6  * Copyright (C) 2012 KiCad Developers, see CHANGELOG.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 
30 #ifndef PCB_COMPONENT_H_
31 #define PCB_COMPONENT_H_
32 
33 #include <wx/wx.h>
34 #include <wx/file.h>
35 
36 #include <pcad2kicad_common.h>
37 #include <pcb_callbacks.h>
38 #include <class_board.h>
39 #include <class_module.h>
40 #include <class_track.h>
41 #include <class_edge_mod.h>
42 #include <class_zone.h>
43 #include <class_pcb_text.h>
44 
45 namespace PCAD2KICAD {
46 
47 // basic parent class for PCB objects
48 class PCB_COMPONENT : public wxObject
49 {
50 public:
51  int m_tag;
52  char m_objType;
59  TTEXTVALUE m_name; // name has also private positions, rotations and so on....
60  wxString m_net;
61  int m_netCode;
62  wxString m_compRef; // internal usage for XL parsing
63  wxString m_patGraphRefName; // internal usage for XL parsing
64 
65  PCB_COMPONENT( PCB_CALLBACKS* aCallbacks, BOARD* aBoard );
67 
68  virtual void SetPosOffset( int aX_offs, int aY_offs );
69  virtual void Flip();
70  virtual void AddToModule( MODULE* aModule );
71  virtual void AddToBoard() = 0;
72 
73  PCB_LAYER_ID GetKiCadLayer() { return m_callbacks->GetKiCadLayer( m_PCadLayer ); }
75  int GetNetCode( wxString aNetName ) { return m_callbacks->GetNetCode( aNetName ); }
76 
77 protected:
80 };
81 
82 WX_DEFINE_ARRAY( PCB_COMPONENT*, PCB_COMPONENTS_ARRAY );
83 WX_DEFINE_ARRAY( wxRealPoint*, VERTICES_ARRAY );
84 
85 } // namespace PCAD2KICAD
86 
87 #endif // PCB_COMPONENT_H_
TEXTE_PCB class definition.
Class BOARD to handle a board.
Classes to handle copper zones.
virtual void AddToModule(MODULE *aModule)
PCB_LAYER_ID GetKiCadLayer()
Definition: pcb_component.h:73
Functions relatives to tracks, vias and segments used to fill zones.
virtual void SetPosOffset(int aX_offs, int aY_offs)
PCB_LAYER_ID
A quick note on layer IDs:
WX_DEFINE_ARRAY(PCB_COMPONENT *, PCB_COMPONENTS_ARRAY)
virtual PCB_LAYER_ID GetKiCadLayer(int aPCadLayer)=0
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:166
virtual int GetNewTimestamp()=0
virtual int GetNetCode(wxString netName)=0
PCB_CALLBACKS * m_callbacks
Definition: pcb_component.h:78
int GetNetCode(wxString aNetName)
Definition: pcb_component.h:75
Module description (excepted pads)
virtual void AddToBoard()=0
EDGE_MODULE class definition.
PCB_COMPONENT(PCB_CALLBACKS *aCallbacks, BOARD *aBoard)