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@gmail.com>
5  * Copyright (C) 2011-2021 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 <lib_symbol.h>
30 #include <collector.h>
32 #include <sch_item.h>
33 
34 
35 class SCH_SHEET_PATH;
36 class SCH_SYMBOL;
37 
38 
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 MovableItems[];
45  static const KICAD_T SymbolsOnly[];
46  static const KICAD_T SheetsOnly[];
47  static const KICAD_T WiresOnly[];
48  static const KICAD_T FieldOwners[];
49 
50  EE_COLLECTOR( const KICAD_T* aScanTypes = EE_COLLECTOR::AllItems ) :
51  m_Unit( 0 ),
52  m_Convert( 0 )
53  {
54  SetScanTypes( aScanTypes );
55  }
56 
63  SCH_ITEM* operator[]( int aIndex ) const override
64  {
65  if( (unsigned)aIndex < (unsigned)GetCount() )
66  return (SCH_ITEM*) m_list[ aIndex ];
67 
68  return nullptr;
69  }
70 
71  SEARCH_RESULT Inspect( EDA_ITEM* aItem, void* aTestData ) override;
72 
84  void Collect( SCH_SCREEN* aScreen, const KICAD_T aFilterList[], const wxPoint& aPos,
85  int aUnit = 0, int aConvert = 0 );
86 
98  void Collect( LIB_ITEMS_CONTAINER& aItems, const KICAD_T aFilterList[], const wxPoint& aPos,
99  int aUnit = 0, int aConvert = 0 );
100 
106  bool IsCorner() const;
107 
108 public:
109  int m_Unit; // Fixed symbol unit filter (for symbol editor)
110  int m_Convert; // Fixed DeMorgan filter (for symbol editor)
111 };
112 
113 
114 void CollectOtherUnits( const wxString& thisRef, int thisUnit, const LIB_ID& aLibId,
115  SCH_SHEET_PATH& aSheet, std::vector<SCH_SYMBOL*>* otherUnits );
116 
117 #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)
Scan a EDA_ITEM using this class's Inspector method which does the collection.
void SetScanTypes(const KICAD_T *scanTypes)
Record the list of KICAD_T types to consider for collection by the Inspect() function.
Definition: collector.h:220
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254
static const KICAD_T FieldOwners[]
Definition: ee_collectors.h:48
static const KICAD_T MovableItems[]
Definition: ee_collectors.h:44
static const KICAD_T SheetsOnly[]
Definition: ee_collectors.h:46
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
int GetCount() const
Return the number of objects in the list.
Definition: collector.h:87
Subclass of DIALOG_SCH_FIND_BASE, which is generated by wxFormBuilder.
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:63
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
bool IsCorner() const
Test if the collected items form a corner of two line segments.
void CollectOtherUnits(const wxString &thisRef, int thisUnit, const LIB_ID &aLibId, SCH_SHEET_PATH &aSheet, std::vector< SCH_SYMBOL * > *otherUnits)
Schematic symbol object.
Definition: sch_symbol.h:78
static const KICAD_T AllItems[]
Definition: ee_collectors.h:42
SEARCH_RESULT Inspect(EDA_ITEM *aItem, void *aTestData) override
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
An abstract class that will find and hold all the objects according to an inspection done by the Insp...
Definition: collector.h:53
static const KICAD_T SymbolsOnly[]
Definition: ee_collectors.h:45
SEARCH_RESULT
Definition: eda_item.h:41
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:193
static const KICAD_T EditableItems[]
Definition: ee_collectors.h:43
EE_COLLECTOR(const KICAD_T *aScanTypes=EE_COLLECTOR::AllItems)
Definition: ee_collectors.h:50
static const KICAD_T WiresOnly[]
Definition: ee_collectors.h:47