KiCad PCB EDA Suite
ee_collectors.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) 2011 Wayne Stambaugh <stambaughw@verizon.net>
5  * Copyright (C) 2011-2019 KiCad Developers, see AUTHORS.txt for contributors.
6  * Copyright (C) 2019 CERN
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 EE_COLLECTORS_H
27 #define EE_COLLECTORS_H
28 
29 #include <class_libentry.h>
30 #include <collector.h>
32 #include <sch_item.h>
33 #include <sch_sheet_path.h>
34 
35 
39 class EE_COLLECTOR : public COLLECTOR
40 {
41 public:
42  static const KICAD_T AllItems[];
43  static const KICAD_T EditableItems[];
44  static const KICAD_T ComponentsOnly[];
45  static const KICAD_T SheetsOnly[];
46 
47  EE_COLLECTOR( const KICAD_T* aScanTypes = EE_COLLECTOR::AllItems ) :
48  m_Unit( 0 ),
49  m_Convert( 0 )
50  {
51  SetScanTypes( aScanTypes );
52  }
53 
60  SCH_ITEM* operator[]( int aIndex ) const override
61  {
62  if( (unsigned)aIndex < (unsigned)GetCount() )
63  return (SCH_ITEM*) m_List[ aIndex ];
64 
65  return NULL;
66  }
67 
68  SEARCH_RESULT Inspect( EDA_ITEM* aItem, void* aTestData ) override;
69 
81  void Collect( SCH_SCREEN* aScreen, const KICAD_T aFilterList[], const wxPoint& aPos,
82  int aUnit = 0, int aConvert = 0 );
83 
95  void Collect( LIB_ITEMS_CONTAINER& aItems, const KICAD_T aFilterList[], const wxPoint& aPos,
96  int aUnit = 0, int aConvert = 0 );
97 
103  bool IsCorner() const;
104 
118  bool IsDraggableJunction() const;
119 
120 public:
121  int m_Unit; // Fixed symbol unit filter (for symbol editor)
122  int m_Convert; // Fixed DeMorgan filter (for symbol editor)
123 };
124 
125 
126 #endif // EE_COLLECTORS_H
COLLECTOR class definition.
void Collect(SCH_SCREEN *aScreen, const KICAD_T aFilterList[], const wxPoint &aPos, int aUnit=0, int aConvert=0)
Function Collect scans a EDA_ITEM using this class's Inspector method, which does the collection.
void SetScanTypes(const KICAD_T *scanTypes)
Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() f...
Definition: collector.h:201
EE_COLLECTOR.
Definition: ee_collectors.h:39
static const KICAD_T ComponentsOnly[]
Definition: ee_collectors.h:44
static const KICAD_T SheetsOnly[]
Definition: ee_collectors.h:45
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:100
#define NULL
Subclass of DIALOG_SCH_FIND_BASE, which is generated by wxFormBuilder.
Class LIB_PIN definition.
SCH_ITEM * operator[](int aIndex) const override
Overload COLLECTOR::operator[](int) to return a SCH_ITEM instead of an EDA_ITEM.
Definition: ee_collectors.h:60
bool IsDraggableJunction() const
Function IsDraggableJunction tests to see if the collected items form a draggable junction.
bool IsCorner() const
Function IsCorner tests if the collected items forms as corner of two line segments.
static const KICAD_T AllItems[]
Definition: ee_collectors.h:42
SEARCH_RESULT Inspect(EDA_ITEM *aItem, void *aTestData) override
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:166
COLLECTOR is an abstract class that will find and hold all the objects according to an inspection don...
Definition: collector.h:55
SEARCH_RESULT
Definition: base_struct.h:54
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58
SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:147
static const KICAD_T EditableItems[]
Definition: ee_collectors.h:43
EE_COLLECTOR(const KICAD_T *aScanTypes=EE_COLLECTOR::AllItems)
Definition: ee_collectors.h:47