KiCad PCB EDA Suite
tracks_cleaner.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) 2022 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef KICAD_TRACKS_CLEANER_H
25#define KICAD_TRACKS_CLEANER_H
26
27#include <pcb_track.h>
28#include <board.h>
29
30class BOARD_COMMIT;
31class CLEANUP_ITEM;
32class REPORTER;
33
34
35// Helper class used to clean tracks and vias
37{
38public:
39 TRACKS_CLEANER( BOARD* aPcb, BOARD_COMMIT& aCommit );
40
54 void CleanupBoard( bool aDryRun, std::vector<std::shared_ptr<CLEANUP_ITEM> >* aItemsList,
55 bool aCleanVias, bool aRemoveMisConnected, bool aMergeSegments,
56 bool aDeleteUnconnected, bool aDeleteTracksinPad, bool aDeleteDanglingVias,
57 REPORTER* aReporter = nullptr );
58
59private:
60 /*
61 * Removes track segments which are connected to more than one net (short circuits).
62 */
64
71 bool deleteDanglingTracks( bool aTrack, bool aVia );
72
73 void deleteTracksInPads();
74
78 void cleanup( bool aDeleteDuplicateVias, bool aDeleteNullSegments,
79 bool aDeleteDuplicateSegments, bool aMergeSegments );
80
89 bool mergeCollinearSegments( PCB_TRACK* aSeg1, PCB_TRACK* aSeg2 );
90
97 bool testTrackEndpointIsNode( PCB_TRACK* aTrack, bool aTstStart );
98
99 void removeItems( std::set<BOARD_ITEM*>& aItems );
100
101 const std::vector<BOARD_CONNECTED_ITEM*>& getConnectedItems( PCB_TRACK* aTrack );
102
103private:
105 BOARD_COMMIT& m_commit; // caller owns
107 std::vector<std::shared_ptr<CLEANUP_ITEM>>* m_itemsList; // caller owns
109
110 // Cache connections. O(n^2) is awful, but it beats O(2n^3).
111 std::map<PCB_TRACK*, std::vector<BOARD_CONNECTED_ITEM*>> m_connectedItemsCache;
112};
113
114
115#endif //KICAD_TRACKS_CLEANER_H
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:265
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
const std::vector< BOARD_CONNECTED_ITEM * > & getConnectedItems(PCB_TRACK *aTrack)
void removeItems(std::set< BOARD_ITEM * > &aItems)
void cleanup(bool aDeleteDuplicateVias, bool aDeleteNullSegments, bool aDeleteDuplicateSegments, bool aMergeSegments)
Geometry-based cleanup: duplicate items, null items, colinear items.
void CleanupBoard(bool aDryRun, std::vector< std::shared_ptr< CLEANUP_ITEM > > *aItemsList, bool aCleanVias, bool aRemoveMisConnected, bool aMergeSegments, bool aDeleteUnconnected, bool aDeleteTracksinPad, bool aDeleteDanglingVias, REPORTER *aReporter=nullptr)
the cleanup function.
bool testTrackEndpointIsNode(PCB_TRACK *aTrack, bool aTstStart)
REPORTER * m_reporter
bool mergeCollinearSegments(PCB_TRACK *aSeg1, PCB_TRACK *aSeg2)
helper function merge aTrackRef and aCandidate, when possible, i.e.
bool deleteDanglingTracks(bool aTrack, bool aVia)
Removes tracks or vias only connected on one end.
std::map< PCB_TRACK *, std::vector< BOARD_CONNECTED_ITEM * > > m_connectedItemsCache
std::vector< std::shared_ptr< CLEANUP_ITEM > > * m_itemsList
TRACKS_CLEANER(BOARD *aPcb, BOARD_COMMIT &aCommit)
void removeShortingTrackSegments()
BOARD_COMMIT & m_commit