KiCad PCB EDA Suite: TRACKS_CLEANER Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

#include <tracks_cleaner.h>

Public Member Functions
	TRACKS_CLEANER (BOARD *aPcb, BOARD_COMMIT &aCommit)

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.

void	SetFilter (const std::function< bool(BOARD_CONNECTED_ITEM *aItem)> &aFilter)

Private Member Functions
bool	filterItem (BOARD_CONNECTED_ITEM *aItem)

void	removeShortingTrackSegments ()

bool	deleteDanglingTracks (bool aTrack, bool aVia)
	Removes tracks or vias only connected on one end.

void	deleteTracksInPads ()

void	cleanup (bool aDeleteDuplicateVias, bool aDeleteNullSegments, bool aDeleteDuplicateSegments, bool aMergeSegments)
	Geometry-based cleanup: duplicate items, null items, colinear items.

bool	mergeCollinearSegments (PCB_TRACK aSeg1, PCB_TRACK aSeg2)
	helper function merge aTrackRef and aCandidate, when possible, i.e.

bool	testTrackEndpointIsNode (PCB_TRACK *aTrack, bool aTstStart)

void	removeItems (std::set< BOARD_ITEM * > &aItems)

const std::vector< BOARD_CONNECTED_ITEM * > &	getConnectedItems (PCB_TRACK *aTrack)

Private Attributes
BOARD *	m_brd

BOARD_COMMIT &	m_commit

bool	m_dryRun

std::vector< std::shared_ptr< CLEANUP_ITEM > > *	m_itemsList

REPORTER *	m_reporter

std::map< PCB_TRACK , std::vector< BOARD_CONNECTED_ITEM > >	m_connectedItemsCache

std::function< bool(BOARD_CONNECTED_ITEM *aItem)>	m_filter

Detailed Description

Definition at line 36 of file tracks_cleaner.h.

Constructor & Destructor Documentation

◆ TRACKS_CLEANER()

TRACKS_CLEANER::TRACKS_CLEANER	(	BOARD *	aPcb,
		BOARD_COMMIT &	aCommit
	)

Definition at line 38 of file tracks_cleaner.cpp.

Member Function Documentation

◆ cleanup()

void TRACKS_CLEANER::cleanup	(	bool	aDeleteDuplicateVias,
		bool	aDeleteNullSegments,
		bool	aDeleteDuplicateSegments,
		bool	aMergeSegments
	)

private

Geometry-based cleanup: duplicate items, null items, colinear items.

Definition at line 367 of file tracks_cleaner.cpp.

References LSET::AllCuMask(), CLEANUP_REDUNDANT_VIA, CLEANUP_ZERO_LENGTH_TRACK, filterItem(), BOARD::GetConnectivity(), PCB_VIA::GetLayerSet(), PCB_VIA::GetPosition(), PCB_VIA::GetViaType(), DRC_RTREE::Insert(), IS_DELETED, m_brd, m_itemsList, pad, PCB_TRACE_T, PCB_VIA_T, DRC_RTREE::QueryColliding(), SKIP_STRUCT, BOARD::Tracks(), and via.

Referenced by CleanupBoard().

◆ CleanupBoard()

void TRACKS_CLEANER::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.

Parameters

aDryRun	= true to build changes list, false to modify the board
aItemsList	= list of modified items
aCleanVias	= true to remove superimposed vias
aRemoveMisConnected	= true to remove segments connecting 2 different nets (short circuits)
aMergeSegments	= true to merge collinear segmenst and remove 0 len segm
aDeleteUnconnected	= true to remove dangling tracks
aDeleteTracksinPad	= true to remove tracks fully inside pads
aDeleteDanglingVias	= true to remove a via that is only connected to a single layer
aReporter	is a REPORTER to print activity and info

Definition at line 55 of file tracks_cleaner.cpp.

References _, cleanup(), deleteDanglingTracks(), deleteTracksInPads(), m_dryRun, m_itemsList, m_reporter, removeShortingTrackSegments(), and REPORTER::Report().

Referenced by BOOST_FIXTURE_TEST_CASE().

◆ deleteDanglingTracks()

bool TRACKS_CLEANER::deleteDanglingTracks	(	bool	aTrack,
		bool	aVia
	)

private

Removes tracks or vias only connected on one end.

Parameters

aTrack	if true, clean dangling tracks
aVia	if true, clean dangling vias

Returns: true if any items were deleted

Definition at line 259 of file tracks_cleaner.cpp.

References BOARD::BuildConnectivity(), CLEANUP_DANGLING_TRACK, CLEANUP_DANGLING_VIA, filterItem(), BOARD::GetConnectivity(), IS_DELETED, m_brd, m_commit, m_dryRun, m_itemsList, PCB_ARC_T, PCB_TRACE_T, PCB_VIA_T, BOARD::Remove(), COMMIT::Removed(), and BOARD::Tracks().

Referenced by CleanupBoard().

◆ deleteTracksInPads()

void TRACKS_CLEANER::deleteTracksInPads ( )

private

Definition at line 319 of file tracks_cleaner.cpp.

References ARC_HIGH_DEF, SHAPE_POLY_SET::BooleanSubtract(), CLEANUP_TRACK_IN_PAD, ERROR_INSIDE, filterItem(), BOARD::GetConnectivity(), IS_DELETED, SHAPE_POLY_SET::IsEmpty(), m_brd, m_dryRun, m_itemsList, pad, PCB_VIA_T, SHAPE_POLY_SET::PM_FAST, removeItems(), and BOARD::Tracks().

Referenced by CleanupBoard().

◆ filterItem()

bool TRACKS_CLEANER::filterItem ( BOARD_CONNECTED_ITEM * aItem )

private

Definition at line 164 of file tracks_cleaner.cpp.

References m_filter.

Referenced by cleanup(), deleteDanglingTracks(), deleteTracksInPads(), and removeShortingTrackSegments().

◆ getConnectedItems()

const std::vector< BOARD_CONNECTED_ITEM * > & TRACKS_CLEANER::getConnectedItems ( PCB_TRACK * aTrack )

private

Definition at line 574 of file tracks_cleaner.cpp.

References connectedTypes, BOARD::GetConnectivity(), m_brd, m_connectedItemsCache, PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, and PCB_ZONE_T.

Referenced by mergeCollinearSegments().

◆ mergeCollinearSegments()

bool TRACKS_CLEANER::mergeCollinearSegments	(	PCB_TRACK *	aSeg1,
		PCB_TRACK *	aSeg2
	)

private

helper function merge aTrackRef and aCandidate, when possible, i.e.

when they are colinear, same width, and obviously same layer

Returns: true if the segments are merged, false if not

Parameters

aSeg1	is the reference
aSeg2	is the candidate, and after merging, the removed segment

Definition at line 591 of file tracks_cleaner.cpp.

References CLEANUP_MERGE_TRACKS, getConnectedItems(), BOARD::GetConnectivity(), PCB_TRACK::GetEnd(), PCB_TRACK::GetStart(), PCB_TRACK::GetWidth(), IS_DELETED, BOARD_ITEM::IsLocked(), PCB_TRACK::IsPointOnEnds(), m_brd, m_commit, m_dryRun, m_itemsList, COMMIT::Modify(), PCB_ARC_T, PCB_TRACE_T, PCB_VIA_T, BOARD::Remove(), COMMIT::Removed(), PCB_TRACK::SetEnd(), EDA_ITEM::SetFlags(), BOARD_ITEM::SetParentGroup(), PCB_TRACK::SetStart(), testTrackEndpointIsNode(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ removeItems()

void TRACKS_CLEANER::removeItems ( std::set< BOARD_ITEM * > & aItems )

private

Definition at line 733 of file tracks_cleaner.cpp.

References m_brd, m_commit, BOARD::Remove(), and COMMIT::Removed().

Referenced by deleteTracksInPads(), and removeShortingTrackSegments().

◆ removeShortingTrackSegments()

void TRACKS_CLEANER::removeShortingTrackSegments ( )

private

Definition at line 173 of file tracks_cleaner.cpp.

References CLEANUP_SHORTING_TRACK, CLEANUP_SHORTING_VIA, filterItem(), BOARD::GetConnectivity(), m_brd, m_dryRun, m_itemsList, PCB_VIA_T, removeItems(), and BOARD::Tracks().

Referenced by CleanupBoard().

◆ SetFilter()

void TRACKS_CLEANER::SetFilter ( const std::function< bool(BOARD_CONNECTED_ITEM *aItem)> & aFilter )

inline

Definition at line 59 of file tracks_cleaner.h.

References m_filter.

Referenced by DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup().

◆ testTrackEndpointIsNode()

bool TRACKS_CLEANER::testTrackEndpointIsNode	(	PCB_TRACK *	aTrack,
		bool	aTstStart
	)

private

Returns: true if a track end position is a node, i.e. a end connected to more than one item.

Parameters

aTrack	is the track to test.
aTstStart	= true ot test the start point of the track or false for end point

Definition at line 226 of file tracks_cleaner.cpp.

References anchor, CN_ITEM::Anchors(), BOARD::GetConnectivity(), PCB_TRACK::GetEnd(), PCB_TRACK::GetStart(), m_brd, and CN_ITEM::Valid().

Referenced by mergeCollinearSegments().

Member Data Documentation

◆ m_brd

BOARD* TRACKS_CLEANER::m_brd

private

Definition at line 111 of file tracks_cleaner.h.

Referenced by cleanup(), deleteDanglingTracks(), deleteTracksInPads(), getConnectedItems(), mergeCollinearSegments(), removeItems(), removeShortingTrackSegments(), and testTrackEndpointIsNode().

◆ m_commit

BOARD_COMMIT& TRACKS_CLEANER::m_commit

private

Definition at line 112 of file tracks_cleaner.h.

Referenced by deleteDanglingTracks(), mergeCollinearSegments(), and removeItems().

◆ m_connectedItemsCache

std::map<PCB_TRACK*, std::vector<BOARD_CONNECTED_ITEM*> > TRACKS_CLEANER::m_connectedItemsCache

private

Definition at line 118 of file tracks_cleaner.h.

Referenced by getConnectedItems().

◆ m_dryRun

bool TRACKS_CLEANER::m_dryRun

private

Definition at line 113 of file tracks_cleaner.h.

Referenced by CleanupBoard(), deleteDanglingTracks(), deleteTracksInPads(), mergeCollinearSegments(), and removeShortingTrackSegments().

◆ m_filter

std::function<bool( BOARD_CONNECTED_ITEM* aItem )> TRACKS_CLEANER::m_filter

private

Definition at line 120 of file tracks_cleaner.h.

Referenced by filterItem(), and SetFilter().

◆ m_itemsList

std::vector<std::shared_ptr<CLEANUP_ITEM> >* TRACKS_CLEANER::m_itemsList

private

Definition at line 114 of file tracks_cleaner.h.

Referenced by cleanup(), CleanupBoard(), deleteDanglingTracks(), deleteTracksInPads(), mergeCollinearSegments(), and removeShortingTrackSegments().

◆ m_reporter

REPORTER* TRACKS_CLEANER::m_reporter

private

Definition at line 115 of file tracks_cleaner.h.

Referenced by CleanupBoard().

The documentation for this class was generated from the following files:

TRACKS_CLEANER
Generated on Sun Nov 24 2024 00:05:41 for KiCad PCB EDA Suite by 1.9.6