CN_ITEM represents a BOARD_CONNETED_ITEM in the connectivity system (ie: a pad, track/arc/via, or zone). More...

#include <connectivity_items.h>

Inheritance diagram for CN_ITEM:

Public Member Functions
void	Dump ()

	CN_ITEM (BOARD_CONNECTED_ITEM *aParent, bool aCanChangeNet, int aAnchorCount=2)

virtual	~CN_ITEM ()

std::shared_ptr< CN_ANCHOR >	AddAnchor (const VECTOR2I &aPos)

std::vector< std::shared_ptr< CN_ANCHOR > > &	Anchors ()

void	SetValid (bool aValid)

bool	Valid () const

void	SetDirty (bool aDirty)

bool	Dirty () const

void	SetLayers (const LAYER_RANGE &aLayers)
	Set the layers spanned by the item to aLayers. More...

void	SetLayer (int aLayer)
	Set the layers spanned by the item to a single layer aLayer. More...

const LAYER_RANGE &	Layers () const
	Return the contiguous set of layers spanned by the item. More...

virtual int	Layer () const
	Return the item's layer, for single-layered items only. More...

const BOX2I &	BBox ()

BOARD_CONNECTED_ITEM *	Parent () const

const std::vector< CN_ITEM * > &	ConnectedItems () const

void	ClearConnections ()

void	SetVisited (bool aVisited)

bool	Visited () const

bool	CanChangeNet () const

void	Connect (CN_ITEM *b)

void	RemoveInvalidRefs ()

virtual int	AnchorCount () const

virtual const VECTOR2I	GetAnchor (int n) const

int	GetAnchorItemCount () const

std::shared_ptr< CN_ANCHOR >	GetAnchorItem (int n) const

int	Net () const
	allow parallel connection threads More...

Protected Attributes
bool	m_dirty
	used to identify recently added item not yet scanned into the connectivity search More...

LAYER_RANGE	m_layers
	layer range over which the item exists More...

BOX2I	m_bbox
	bounding box for the item More...

Private Attributes
BOARD_CONNECTED_ITEM *	m_parent

std::vector< CN_ITEM * >	m_connected
	list of physically touching items More...

std::vector< std::shared_ptr< CN_ANCHOR > >	m_anchors

bool	m_canChangeNet
	can the net propagator modify the netcode? More...

bool	m_visited
	visited flag for the BFS scan More...

bool	m_valid
	used to identify garbage items (we use lazy removal) More...

std::mutex	m_listLock
	mutex protecting this item's connected_items set to More...

Detailed Description

CN_ITEM represents a BOARD_CONNETED_ITEM in the connectivity system (ie: a pad, track/arc/via, or zone).

Definition at line 163 of file connectivity_items.h.

Constructor & Destructor Documentation

◆ CN_ITEM()

CN_ITEM::CN_ITEM	(	BOARD_CONNECTED_ITEM *	aParent,
		bool	aCanChangeNet,
		int	aAnchorCount = `2`
	)

inline

Definition at line 168 of file connectivity_items.h.

 {
 m_parent = aParent;
 m_canChangeNet = aCanChangeNet;
 m_visited = false;
 m_valid = true;
 m_dirty = true;
 m_anchors.reserve( std::max( 6, aAnchorCount ) );
 m_layers = LAYER_RANGE( 0, PCB_LAYER_ID_COUNT );
 m_connected.reserve( 8 );
 }

References m_anchors, m_canChangeNet, m_connected, m_dirty, m_layers, m_parent, m_valid, m_visited, and PCB_LAYER_ID_COUNT.

◆ ~CN_ITEM()

virtual CN_ITEM::~CN_ITEM ( )

inlinevirtual

Definition at line 180 of file connectivity_items.h.

180{};

Member Function Documentation

◆ AddAnchor()

std::shared_ptr< CN_ANCHOR > CN_ITEM::AddAnchor ( const VECTOR2I & aPos )

inline

Definition at line 182 of file connectivity_items.h.

 {
 m_anchors.emplace_back( std::make_shared<CN_ANCHOR>( aPos, this ) );
 return m_anchors.at( m_anchors.size() - 1 );
 }

References m_anchors.

Referenced by CN_LIST::Add().

◆ AnchorCount()

int CN_ITEM::AnchorCount ( ) const

virtual

Reimplemented in CN_ZONE_LAYER.

Definition at line 35 of file connectivity_items.cpp.

{
 if( !m_valid )
 return 0;
 
 switch( m_parent->Type() )
 {
 case PCB_TRACE_T:
 case PCB_ARC_T:
 return 2; // start and end
 default:
 return 1;
 }
}

References m_parent, m_valid, PCB_ARC_T, PCB_TRACE_T, and EDA_ITEM::Type().

Referenced by CN_VISITOR::checkZoneItemConnection(), and CN_ANCHOR::IsDangling().

◆ Anchors()

std::vector< std::shared_ptr< CN_ANCHOR > > & CN_ITEM::Anchors ( )

inline

Definition at line 188 of file connectivity_items.h.

188{ return m_anchors; }

References m_anchors.

Referenced by TRACKS_CLEANER::testTrackEndpointIsNode().

◆ BBox()

const BOX2I & CN_ITEM::BBox ( )

inline

Definition at line 219 of file connectivity_items.h.

 {
 if( m_dirty && m_valid )
 m_bbox = m_parent->GetBoundingBox();
 
 return m_bbox;
 }

References EDA_ITEM::GetBoundingBox(), m_bbox, m_dirty, m_parent, and m_valid.

Referenced by CN_VISITOR::checkZoneZoneConnection(), and CN_LIST::FindNearby().

◆ CanChangeNet()

bool CN_ITEM::CanChangeNet ( ) const

inline

Definition at line 235 of file connectivity_items.h.

235{ return m_canChangeNet; }

References m_canChangeNet.

Referenced by CN_VISITOR::operator()().

◆ ClearConnections()

void CN_ITEM::ClearConnections ( )

inline

Definition at line 230 of file connectivity_items.h.

230{ m_connected.clear(); }

References m_connected.

◆ Connect()

void CN_ITEM::Connect ( CN_ITEM * b )

inline

Definition at line 237 of file connectivity_items.h.

 {
 std::lock_guard<std::mutex> lock( m_listLock );
 
 auto i = std::lower_bound( m_connected.begin(), m_connected.end(), b );
 
 if( i != m_connected.end() && *i == b )
 return;
 
 m_connected.insert( i, b );
 }

References m_connected, and m_listLock.

Referenced by CN_VISITOR::checkZoneItemConnection(), CN_VISITOR::checkZoneZoneConnection(), and CN_VISITOR::operator()().

◆ ConnectedItems()

const std::vector< CN_ITEM * > & CN_ITEM::ConnectedItems ( ) const

inline

Definition at line 229 of file connectivity_items.h.

229{ return m_connected; }

References m_connected.

Referenced by CN_ANCHOR::ConnectedItemsCount(), CONNECTIVITY_DATA::GetConnectedItemsAtAnchor(), CONNECTIVITY_DATA::GetConnectedPads(), CONNECTIVITY_DATA::GetConnectedTracks(), CONNECTIVITY_DATA::IsConnectedOnLayer(), CN_ANCHOR::IsDangling(), RN_NET::optimizeRNEdges(), CN_CONNECTIVITY_ALGO::SearchClusters(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and uniquePathBetweenNodes().

◆ Dirty()

bool CN_ITEM::Dirty ( ) const

inline

Definition at line 194 of file connectivity_items.h.

194{ return m_dirty; }

References m_dirty.

Referenced by CN_VISITOR::operator()().

◆ Dump()

void CN_ITEM::Dump ( )

Definition at line 78 of file connectivity_items.cpp.

{
 wxLogDebug(" valid: %d, connected: \n", !!Valid());
 
 for( CN_ITEM* i : m_connected )
 {
 PCB_TRACK* t = static_cast<PCB_TRACK*>( i->Parent() );
 wxLogDebug( wxT( " - %p %d\n" ), t, t->Type() );
 }
}

References m_connected, EDA_ITEM::Type(), and Valid().

◆ GetAnchor()

const VECTOR2I CN_ITEM::GetAnchor ( int n ) const

virtual

Reimplemented in CN_ZONE_LAYER.

Definition at line 51 of file connectivity_items.cpp.

{
 if( !m_valid )
 return VECTOR2I();
 
 switch( m_parent->Type() )
 {
 case PCB_PAD_T:
 return static_cast<PAD*>( m_parent )->GetPosition();
 
 case PCB_TRACE_T:
 case PCB_ARC_T:
 if( n == 0 )
 return static_cast<const PCB_TRACK*>( m_parent )->GetStart();
 else
 return static_cast<const PCB_TRACK*>( m_parent )->GetEnd();
 
 case PCB_VIA_T:
 return static_cast<const PCB_VIA*>( m_parent )->GetStart();
 
 default:
 UNIMPLEMENTED_FOR( m_parent->GetClass() );
 return VECTOR2I();
 }
}

References EDA_ITEM::GetClass(), m_parent, m_valid, PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, EDA_ITEM::Type(), and UNIMPLEMENTED_FOR.

Referenced by CN_VISITOR::checkZoneItemConnection().

◆ GetAnchorItem()

std::shared_ptr< CN_ANCHOR > CN_ITEM::GetAnchorItem ( int n ) const

inline

Definition at line 255 of file connectivity_items.h.

255{ return m_anchors[n]; }

References m_anchors.

◆ GetAnchorItemCount()

int CN_ITEM::GetAnchorItemCount ( ) const

inline

Definition at line 254 of file connectivity_items.h.

254{ return m_anchors.size(); }

References m_anchors.

◆ Layer()

virtual int CN_ITEM::Layer ( ) const

inlinevirtual

Return the item's layer, for single-layered items only.

Definition at line 214 of file connectivity_items.h.

 {
 return Layers().Start();
 }

References Layers(), and LAYER_RANGE::Start().

Referenced by RN_NET::optimizeRNEdges().

◆ Layers()

const LAYER_RANGE & CN_ITEM::Layers ( ) const

inline

Return the contiguous set of layers spanned by the item.

Definition at line 209 of file connectivity_items.h.

209{ return m_layers; }

References m_layers.

Referenced by CN_LIST::FindNearby(), and Layer().

◆ Net()

int CN_ITEM::Net ( ) const

inline

allow parallel connection threads

Definition at line 257 of file connectivity_items.h.

References BOARD_CONNECTED_ITEM::GetNetCode(), m_parent, and m_valid.

Referenced by CN_CLUSTER::Add(), CONNECTIVITY_DATA::GetNetItems(), CN_VISITOR::operator()(), NETCODE_CMP_LESS::operator()(), and CN_CONNECTIVITY_ALGO::SearchClusters().

◆ Parent()

BOARD_CONNECTED_ITEM * CN_ITEM::Parent ( ) const

inline

Definition at line 227 of file connectivity_items.h.

227{ return m_parent; }

References m_parent.

Referenced by CN_CLUSTER::Add(), CN_ZONE_LAYER::AnchorCount(), CN_VISITOR::checkZoneItemConnection(), CN_VISITOR::checkZoneZoneConnection(), CN_ZONE_LAYER::GetAnchor(), CONNECTIVITY_DATA::GetNetItems(), CONNECTIVITY_DATA::IsConnectedOnLayer(), CN_VISITOR::operator()(), CN_CLUSTER::OriginNetName(), and CN_ANCHOR::Parent().

◆ RemoveInvalidRefs()

void CN_ITEM::RemoveInvalidRefs ( )

Definition at line 112 of file connectivity_items.cpp.

{
 for( auto it = m_connected.begin(); it != m_connected.end(); /* increment in loop */ )
 {
 if( !(*it)->Valid() )
 it = m_connected.erase( it );
 else
 ++it;
 }
}

References m_connected.

◆ SetDirty()

void CN_ITEM::SetDirty ( bool aDirty )

inline

Definition at line 193 of file connectivity_items.h.

193{ m_dirty = aDirty; }

References m_dirty.

◆ SetLayer()

void CN_ITEM::SetLayer ( int aLayer )

inline

Set the layers spanned by the item to a single layer aLayer.

Definition at line 204 of file connectivity_items.h.

204{ m_layers = LAYER_RANGE( aLayer, aLayer ); }

References m_layers.

Referenced by CN_LIST::Add().

◆ SetLayers()

void CN_ITEM::SetLayers ( const LAYER_RANGE & aLayers )

inline

Set the layers spanned by the item to aLayers.

Definition at line 199 of file connectivity_items.h.

199{ m_layers = aLayers; }

References m_layers.

Referenced by CN_LIST::Add(), and CN_ZONE_LAYER::CN_ZONE_LAYER().

◆ SetValid()

void CN_ITEM::SetValid ( bool aValid )

inline

Definition at line 190 of file connectivity_items.h.

190{ m_valid = aValid; }

References m_valid.

◆ SetVisited()

void CN_ITEM::SetVisited ( bool aVisited )

inline

Definition at line 232 of file connectivity_items.h.

232{ m_visited = aVisited; }

References m_visited.

Referenced by CN_CONNECTIVITY_ALGO::SearchClusters().

◆ Valid()

bool CN_ITEM::Valid ( ) const

inline

Definition at line 191 of file connectivity_items.h.

191{ return m_valid; }

References m_valid.

Referenced by CN_ZONE_LAYER::AnchorCount(), Dump(), CN_ZONE_LAYER::GetAnchor(), CONNECTIVITY_DATA::GetNetItems(), CN_VISITOR::operator()(), CN_CLUSTER::OriginNetName(), CN_ANCHOR::Parent(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), TRACKS_CLEANER::testTrackEndpointIsNode(), and CN_ANCHOR::Valid().

◆ Visited()

bool CN_ITEM::Visited ( ) const

inline

Definition at line 233 of file connectivity_items.h.

233{ return m_visited; }

References m_visited.

Member Data Documentation

◆ m_anchors

std::vector<std::shared_ptr<CN_ANCHOR> > CN_ITEM::m_anchors

private

Definition at line 272 of file connectivity_items.h.

Referenced by AddAnchor(), Anchors(), CN_ITEM(), GetAnchorItem(), and GetAnchorItemCount().

◆ m_bbox

BOX2I CN_ITEM::m_bbox

protected

bounding box for the item

Definition at line 266 of file connectivity_items.h.

Referenced by BBox().

◆ m_canChangeNet

bool CN_ITEM::m_canChangeNet

private

can the net propagator modify the netcode?

Definition at line 274 of file connectivity_items.h.

Referenced by CanChangeNet(), and CN_ITEM().

◆ m_connected

std::vector<CN_ITEM*> CN_ITEM::m_connected

private

list of physically touching items

Definition at line 271 of file connectivity_items.h.

Referenced by ClearConnections(), CN_ITEM(), Connect(), ConnectedItems(), Dump(), and RemoveInvalidRefs().

◆ m_dirty

bool CN_ITEM::m_dirty

protected

used to identify recently added item not yet scanned into the connectivity search

Definition at line 263 of file connectivity_items.h.

Referenced by BBox(), CN_ITEM(), Dirty(), and SetDirty().

◆ m_layers

LAYER_RANGE CN_ITEM::m_layers

protected

layer range over which the item exists

Definition at line 265 of file connectivity_items.h.

Referenced by CN_ITEM(), Layers(), SetLayer(), and SetLayers().

◆ m_listLock

std::mutex CN_ITEM::m_listLock

private

mutex protecting this item's connected_items set to

Definition at line 279 of file connectivity_items.h.

Referenced by Connect().

◆ m_parent

BOARD_CONNECTED_ITEM* CN_ITEM::m_parent

private

Definition at line 269 of file connectivity_items.h.

Referenced by AnchorCount(), BBox(), CN_ITEM(), GetAnchor(), Net(), and Parent().

◆ m_valid

bool CN_ITEM::m_valid

private

used to identify garbage items (we use lazy removal)

Definition at line 277 of file connectivity_items.h.

Referenced by AnchorCount(), BBox(), CN_ITEM(), GetAnchor(), Net(), SetValid(), and Valid().

◆ m_visited

bool CN_ITEM::m_visited

private

visited flag for the BFS scan

Definition at line 276 of file connectivity_items.h.

Referenced by CN_ITEM(), SetVisited(), and Visited().

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

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CN_ITEM()

◆ ~CN_ITEM()

Member Function Documentation

◆ AddAnchor()

◆ AnchorCount()

◆ Anchors()

◆ BBox()

◆ CanChangeNet()

◆ ClearConnections()

◆ Connect()

◆ ConnectedItems()

◆ Dirty()

◆ Dump()

◆ GetAnchor()

◆ GetAnchorItem()

◆ GetAnchorItemCount()

◆ Layer()

◆ Layers()

◆ Net()

◆ Parent()

◆ RemoveInvalidRefs()

◆ SetDirty()

◆ SetLayer()

◆ SetLayers()

◆ SetValid()

◆ SetVisited()

◆ Valid()

◆ Visited()

Member Data Documentation

◆ m_anchors

◆ m_bbox

◆ m_canChangeNet

◆ m_connected

◆ m_dirty

◆ m_layers

◆ m_listLock

◆ m_parent

◆ m_valid

◆ m_visited