KiCad PCB EDA Suite
array_creator.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  * Created on: 11 Mar 2016, author John Beard
5  * Copyright (C) 1992-2016 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 
29 #ifndef PCBNEW_ARRAY_CREATOR_H_
30 #define PCBNEW_ARRAY_CREATOR_H_
31 
33 
34 #include <class_board.h>
35 #include <class_module.h>
36 #include <class_board_item.h>
37 
47 {
48 public:
50  m_parent( parent )
51  {}
52 
56  void Invoke();
57 
58 protected:
59  virtual ~ARRAY_CREATOR() {}
60 
62 
63 private:
64 
68  virtual BOARD* getBoard() const = 0;
69 
73  virtual MODULE* getModule() const = 0;
74 
79  virtual int getNumberOfItemsToArray() const = 0;
80 
84  virtual BOARD_ITEM* getNthItemToArray( int n ) const = 0;
85 
90  virtual wxPoint getRotationCentre() const = 0;
91 
96  virtual void prePushAction( BOARD_ITEM* new_item )
97  {}
98 
102  virtual void postPushAction( BOARD_ITEM* new_item )
103  {}
104 
108  virtual void finalise() = 0;
109 };
110 
111 
112 
113 
114 #endif /* PCBNEW_ARRAY_CREATOR_H_ */
virtual ~ARRAY_CREATOR()
Definition: array_creator.h:59
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
Classes BOARD_ITEM and BOARD_CONNECTED_ITEM.
Class BOARD to handle a board.
virtual void postPushAction(BOARD_ITEM *new_item)
PCB_BASE_FRAME & m_parent
Definition: array_creator.h:61
virtual MODULE * getModule() const =0
virtual wxPoint getRotationCentre() const =0
virtual BOARD * getBoard() const =0
virtual int getNumberOfItemsToArray() const =0
virtual void finalise()=0
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:166
ARRAY_CREATOR(PCB_BASE_FRAME &parent)
Definition: array_creator.h:49
virtual BOARD_ITEM * getNthItemToArray(int n) const =0
Module description (excepted pads)
virtual void prePushAction(BOARD_ITEM *new_item)
Definition: array_creator.h:96
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...