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 
26 #ifndef PCB_COMPONENT_H_
27 #define PCB_COMPONENT_H_
28 
29 #include <pcad/pcad2kicad_common.h>
30 #include <pcad/pcad_item_types.h>
31 #include <pcad/pcb_callbacks.h>
32 
33 #include <kiid.h>
35 #include <wx/object.h>
36 
37 class BOARD;
38 class FOOTPRINT;
39 class wxString;
40 class wxRealPoint;
41 
42 namespace PCAD2KICAD {
43 
44 // basic parent class for PCB objects
45 class PCB_COMPONENT : public wxObject
46 {
47 public:
48  PCB_COMPONENT( PCB_CALLBACKS* aCallbacks, BOARD* aBoard );
50 
51  virtual void SetPosOffset( int aX_offs, int aY_offs );
52  virtual void Flip();
53  virtual void AddToFootprint( FOOTPRINT* aFootprint );
54  virtual void AddToBoard() = 0;
55 
57  int GetNetCode( wxString aNetName ) const { return m_callbacks->GetNetCode( aNetName ); }
58 
59  int m_tag;
60  char m_objType;
67  TTEXTVALUE m_name; // name has also private positions, rotations and so on....
68  wxString m_net;
69  int m_netCode;
70  wxString m_compRef; // internal usage for XL parsing
71  wxString m_patGraphRefName; // internal usage for XL parsing
72 
73 protected:
76 };
77 
78 } // namespace PCAD2KICAD
79 
80 #endif // PCB_COMPONENT_H_
virtual void AddToFootprint(FOOTPRINT *aFootprint)
virtual void SetPosOffset(int aX_offs, int aY_offs)
Definition: kiid.h:44
PCB_LAYER_ID
A quick note on layer IDs:
virtual PCB_LAYER_ID GetKiCadLayer(int aPCadLayer) const =0
int GetNetCode(wxString aNetName) const
Definition: pcb_component.h:57
PCB_LAYER_ID GetKiCadLayer() const
Definition: pcb_component.h:56
virtual int GetNetCode(const wxString &netName) const =0
Board layer functions and definitions.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
PCB_CALLBACKS * m_callbacks
Definition: pcb_component.h:74
virtual void AddToBoard()=0
PCB_COMPONENT(PCB_CALLBACKS *aCallbacks, BOARD *aBoard)