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 <[email protected]>
5 * Copyright (C) 2011-2022 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
35class SCH_SHEET_PATH;
36class SCH_SYMBOL;
37
38
39class EE_COLLECTOR : public COLLECTOR
40{
41public:
42 static const std::vector<KICAD_T> EditableItems;
43 static const std::vector<KICAD_T> MovableItems;
44 static const std::vector<KICAD_T> FieldOwners;
45
46 EE_COLLECTOR( const std::vector<KICAD_T>& aScanTypes = { SCH_LOCATE_ANY_T } ) :
47 m_Unit( 0 ),
48 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 nullptr;
66 }
67
68 INSPECT_RESULT Inspect( EDA_ITEM* aItem, void* aTestData ) override;
69
80 void Collect( SCH_SCREEN* aScreen, const std::vector<KICAD_T>& aScanTypes,
81 const VECTOR2I& aPos, int aUnit = 0, int aConvert = 0 );
82
93 void Collect( LIB_ITEMS_CONTAINER& aItems, const std::vector<KICAD_T>& aScanTypes,
94 const VECTOR2I& aPos, int aUnit = 0, int aConvert = 0 );
95
101 bool IsCorner() const;
102
103public:
104 int m_Unit; // Fixed symbol unit filter (for symbol editor)
105 int m_Convert; // Fixed DeMorgan filter (for symbol editor)
106
108};
109
110
111void CollectOtherUnits( const wxString& thisRef, int thisUnit, const LIB_ID& aLibId,
112 SCH_SHEET_PATH& aSheet, std::vector<SCH_SYMBOL*>* otherUnits );
113
114#endif // EE_COLLECTORS_H
An abstract class that will find and hold all the objects according to an inspection done by the Insp...
Definition: collector.h:48
int GetCount() const
Return the number of objects in the list.
Definition: collector.h:81
void SetScanTypes(const std::vector< KICAD_T > &aTypes)
Record the list of KICAD_T types to consider for collection by the Inspect() function.
Definition: collector.h:211
std::vector< EDA_ITEM * > m_list
Definition: collector.h:240
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
EE_COLLECTOR(const std::vector< KICAD_T > &aScanTypes={ SCH_LOCATE_ANY_T })
Definition: ee_collectors.h:46
bool m_ShowPinElectricalTypes
static const std::vector< KICAD_T > MovableItems
Definition: ee_collectors.h:43
bool IsCorner() const
Test if the collected items form a corner of two line segments.
INSPECT_RESULT Inspect(EDA_ITEM *aItem, void *aTestData) override
void Collect(SCH_SCREEN *aScreen, const std::vector< KICAD_T > &aScanTypes, const VECTOR2I &aPos, int aUnit=0, int aConvert=0)
Scan a EDA_ITEM using this class's Inspector method which does the collection.
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
static const std::vector< KICAD_T > EditableItems
Definition: ee_collectors.h:42
static const std::vector< KICAD_T > FieldOwners
Definition: ee_collectors.h:44
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:147
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Schematic symbol object.
Definition: sch_symbol.h:81
INSPECT_RESULT
Definition: eda_item.h:42
void CollectOtherUnits(const wxString &thisRef, int thisUnit, const LIB_ID &aLibId, SCH_SHEET_PATH &aSheet, std::vector< SCH_SYMBOL * > *otherUnits)
@ SCH_LOCATE_ANY_T
Definition: typeinfo.h:183