#include <pns_itemset.h>

Classes
struct	ENTRY

Public Types
typedef std::vector< ENTRY >	ENTRIES

Public Member Functions
	ITEM_SET (ITEM *aInitialItem=nullptr, bool aBecomeOwner=false)

	ITEM_SET (const ITEM_SET &aOther)

	~ITEM_SET ()

ITEM_SET &	operator= (const ITEM_SET &aOther)

int	Count (int aKindMask=-1) const

bool	Empty () const

ENTRIES &	Items ()

const ENTRIES &	CItems () const

ITEM_SET &	FilterLayers (int aStart, int aEnd=-1, bool aInvert=false)

ITEM_SET &	FilterKinds (int aKindMask, bool aInvert=false)

ITEM_SET &	FilterNet (int aNet, bool aInvert=false)

ITEM_SET &	FilterMarker (int aMarker, bool aInvert=false)

ITEM_SET &	ExcludeLayers (int aStart, int aEnd=-1)

ITEM_SET &	ExcludeKinds (int aKindMask)

ITEM_SET &	ExcludeNet (int aNet)

ITEM_SET &	ExcludeItem (const ITEM *aItem)

int	Size () const

void	Add (const LINE &aLine)

void	Prepend (const LINE &aLine)

ITEM *	operator[] (size_t aIndex) const

ENTRIES::iterator	begin ()

ENTRIES::iterator	end ()

ENTRIES::const_iterator	cbegin () const

ENTRIES::const_iterator	cend () const

void	Add (ITEM *aItem, bool aBecomeOwner=false)

void	Prepend (ITEM *aItem, bool aBecomeOwner=false)

void	Clear ()

bool	Contains (ITEM *aItem) const

void	Erase (ITEM *aItem)

template<class T >
T *	FindByKind (ITEM::PnsKind kind, int index=0)

Private Attributes
ENTRIES	m_items

Detailed Description

Definition at line 36 of file pns_itemset.h.

Member Typedef Documentation

◆ ENTRIES

typedef std::vector<ENTRY> PNS::ITEM_SET::ENTRIES

Definition at line 93 of file pns_itemset.h.

Constructor & Destructor Documentation

◆ ITEM_SET() [1/2]

PNS::ITEM_SET::ITEM_SET	(	ITEM *	aInitialItem = `nullptr`,
		bool	aBecomeOwner = `false`
	)

inline

Definition at line 95 of file pns_itemset.h.

 {
 if( aInitialItem )
 m_items.emplace_back( ENTRY( aInitialItem, aBecomeOwner ) );
 }

References m_items.

◆ ITEM_SET() [2/2]

PNS::ITEM_SET::ITEM_SET ( const ITEM_SET & aOther )

inline

Definition at line 101 of file pns_itemset.h.

 {
 m_items = aOther.m_items;
 }

References m_items.

◆ ~ITEM_SET()

PNS::ITEM_SET::~ITEM_SET ( )

Definition at line 27 of file pns_itemset.cpp.

28{

29}

Member Function Documentation

◆ Add() [1/2]

void PNS::ITEM_SET::Add ( const LINE & aLine )

Definition at line 32 of file pns_itemset.cpp.

{
 LINE* copy = aLine.Clone();
 m_items.emplace_back( ENTRY( copy, true ) );
}

References PNS::LINE::Clone(), copy, and m_items.

Referenced by PNS::COMPONENT_DRAGGER::Drag(), PNS::DRAGGER::dragMarkObstacles(), PNS::DRAGGER::dragViaMarkObstacles(), PNS::DRAGGER::dragViaWalkaround(), PNS::DRAGGER::findViaFanoutByHandle(), PNS::TOPOLOGY::followTrivialPath(), PNS::NODE::HitTest(), ROUTER_TOOL::InlineDrag(), PNS::ROUTER::isStartingPointRoutable(), PNS::JOINT::Link(), PNS::JOINT::Merge(), PNS::HIT_VISITOR::operator()(), PNS::DRAGGER::optimizeAndUpdateDraggedLine(), PNS::ROUTER::QueryHoverItems(), PNS::DIFF_PAIR_PLACER::rhShoveOnly(), PNS::SHOVE::ShoveDraggingVia(), PNS::SHOVE::ShoveLines(), PNS::SHOVE::ShoveMultiLines(), PNS::DIFF_PAIR_PLACER::Traces(), and PNS::DP_MEANDER_PLACER::Traces().

◆ Add() [2/2]

void PNS::ITEM_SET::Add	(	ITEM *	aItem,
		bool	aBecomeOwner = `false`
	)

inline

Definition at line 178 of file pns_itemset.h.

 {
 m_items.emplace_back( ENTRY( aItem, aBecomeOwner ) );
 }

References m_items.

◆ begin()

ENTRIES::iterator PNS::ITEM_SET::begin ( )

inline

Definition at line 173 of file pns_itemset.h.

173{ return m_items.begin(); }

References m_items.

◆ cbegin()

ENTRIES::const_iterator PNS::ITEM_SET::cbegin ( ) const

inline

Definition at line 175 of file pns_itemset.h.

175{ return m_items.cbegin(); }

References m_items.

◆ cend()

ENTRIES::const_iterator PNS::ITEM_SET::cend ( ) const

inline

Definition at line 176 of file pns_itemset.h.

176{ return m_items.cend(); }

References m_items.

◆ CItems()

const ENTRIES & PNS::ITEM_SET::CItems ( ) const

inline

Definition at line 136 of file pns_itemset.h.

136{ return m_items; }

References m_items.

Referenced by PNS::NODE::CheckColliding(), PNS::MEANDER_PLACER_BASE::Clearance(), PNS::MEANDER_PLACER::doMove(), PNS::JOINT::IsLineCorner(), PNS::JOINT::LinkList(), PNS::DP_MEANDER_PLACER::Move(), PNS::MEANDER_SKEW_PLACER::Move(), PNS::ROUTER::movePlacing(), and PNS::SHOVE::ShoveMultiLines().

◆ Clear()

void PNS::ITEM_SET::Clear ( )

inline

Definition at line 188 of file pns_itemset.h.

 {
 m_items.clear();
 }

References m_items.

Referenced by PNS::COMPONENT_DRAGGER::Drag(), PNS::DRAGGER::dragMarkObstacles(), PNS::DRAGGER::dragShove(), PNS::DRAGGER::dragViaMarkObstacles(), PNS::DRAGGER::dragViaWalkaround(), PNS::DRAGGER::optimizeAndUpdateDraggedLine(), and PNS::DRAGGER::Start().

◆ Contains()

bool PNS::ITEM_SET::Contains ( ITEM * aItem ) const

inline

Definition at line 193 of file pns_itemset.h.

 {
 const ENTRY ent( aItem );
 return alg::contains( m_items, ent );
 }

References alg::contains(), and m_items.

Referenced by PNS::JOINT::Link(), PNS::ROUTER::markViolations(), and PNS::COMPONENT_DRAGGER::Start().

◆ Count()

int PNS::ITEM_SET::Count ( int aKindMask = -1 ) const

inline

Definition at line 114 of file pns_itemset.h.

 {
 int n = 0;
 
 if( aKindMask == -1 || aKindMask == ITEM::ANY_T )
 return static_cast<int>( m_items.size() );
 
 for( ITEM* item : m_items )
 {
 if( item->Kind() & aKindMask )
 n++;
 }
 
 return n;
 }

References PNS::ITEM::ANY_T, and m_items.

Referenced by PNS::JOINT::IsLineCorner(), PNS::JOINT::IsNonFanoutVia(), PNS::JOINT::IsStitchingVia(), PNS::JOINT::IsTraceWidthChange(), PNS::JOINT::LinkCount(), and PNS::ROUTER::StartDragging().

◆ Empty()

bool PNS::ITEM_SET::Empty ( ) const

inline

Definition at line 130 of file pns_itemset.h.

 {
 return m_items.empty();
 }

References m_items.

Referenced by PNS::DRAGGER::dragViaMarkObstacles(), PNS::DRAGGER::dragViaWalkaround(), PNS::MEANDER_PLACER_BASE::lineLength(), PNS::TOOL_BASE::pickSingleItem(), PNS::DRAGGER::Start(), and PNS::ROUTER::StartDragging().

◆ end()

ENTRIES::iterator PNS::ITEM_SET::end ( )

inline

Definition at line 174 of file pns_itemset.h.

174{ return m_items.end(); }

References m_items.

◆ Erase()

void PNS::ITEM_SET::Erase ( ITEM * aItem )

inline

Definition at line 199 of file pns_itemset.h.

 {
 ENTRY ent( aItem );
 ENTRIES::iterator f = std::find( m_items.begin(), m_items.end(), ent );
 
 if( f != m_items.end() )
 m_items.erase( f );
 }

References m_items.

Referenced by PNS::JOINT::Unlink().

◆ ExcludeItem()

ITEM_SET & PNS::ITEM_SET::ExcludeItem ( const ITEM * aItem )

Definition at line 116 of file pns_itemset.cpp.

{
 ENTRIES newItems;
 
 for( const ENTRY& ent : m_items )
 {
 if( ent.item != aItem )
 newItems.push_back( ent );
 }
 
 m_items = newItems;
 
 return *this;
}

References m_items.

Referenced by PNS_KICAD_IFACE_BASE::inheritTrackWidth().

◆ ExcludeKinds()

ITEM_SET & PNS::ITEM_SET::ExcludeKinds ( int aKindMask )

inline

Definition at line 148 of file pns_itemset.h.

 {
 return FilterKinds( aKindMask, true );
 }

References FilterKinds().

◆ ExcludeLayers()

ITEM_SET & PNS::ITEM_SET::ExcludeLayers	(	int	aStart,
		int	aEnd = `-1`
	)

inline

Definition at line 143 of file pns_itemset.h.

 {
 return FilterLayers( aStart, aEnd, true );
 }

References FilterLayers().

◆ ExcludeNet()

ITEM_SET & PNS::ITEM_SET::ExcludeNet ( int aNet )

inline

Definition at line 153 of file pns_itemset.h.

 {
 return FilterNet( aNet, true );
 }

References FilterNet().

◆ FilterKinds()

ITEM_SET & PNS::ITEM_SET::FilterKinds	(	int	aKindMask,
		bool	aInvert = `false`
	)

Definition at line 68 of file pns_itemset.cpp.

{
 ENTRIES newItems;
 
 for( const ENTRY& ent : m_items )
 {
 if( ent.item->OfKind( aKindMask ) ^ aInvert )
 newItems.push_back( ent );
 }
 
 m_items = newItems;
 
 return *this;
}

References m_items.

Referenced by ExcludeKinds(), and PNS_KICAD_IFACE_BASE::inheritTrackWidth().

◆ FilterLayers()

ITEM_SET & PNS::ITEM_SET::FilterLayers	(	int	aStart,
		int	aEnd = `-1`,
		bool	aInvert = `false`
	)

Definition at line 46 of file pns_itemset.cpp.

{
 ENTRIES newItems;
 LAYER_RANGE l;
 
 if( aEnd < 0 )
 l = LAYER_RANGE( aStart );
 else
 l = LAYER_RANGE( aStart, aEnd );
 
 for( const ENTRY& ent : m_items )
 {
 if( ent.item->Layers().Overlaps( l ) ^ aInvert )
 newItems.push_back( ent );
 }
 
 m_items = newItems;
 
 return *this;
}

References m_items.

Referenced by ExcludeLayers().

◆ FilterMarker()

ITEM_SET & PNS::ITEM_SET::FilterMarker	(	int	aMarker,
		bool	aInvert = `false`
	)

Definition at line 84 of file pns_itemset.cpp.

{
 ENTRIES newItems;
 
 for( const ENTRY& ent : m_items )
 {
 if( ent.item->Marker() & aMarker )
 newItems.push_back( ent );
 }
 
 m_items = newItems;
 
 return *this;
}

References m_items.

◆ FilterNet()

ITEM_SET & PNS::ITEM_SET::FilterNet	(	int	aNet,
		bool	aInvert = `false`
	)

Definition at line 100 of file pns_itemset.cpp.

{
 ENTRIES newItems;
 
 for( const ENTRY& ent : m_items )
 {
 if( ( ent.item->Net() == aNet ) ^ aInvert )
 newItems.push_back( ent );
 }
 
 m_items = newItems;
 
 return *this;
}

References m_items.

Referenced by ExcludeNet().

◆ FindByKind()

template<class T >

T * PNS::ITEM_SET::FindByKind	(	ITEM::PnsKind	kind,
		int	index = `0`
	)

inline

Definition at line 209 of file pns_itemset.h.

 {
 int n = 0;
 
 for( const ITEM* item : m_items )
 {
 if( item->OfKind( kind ) )
 {
 if( index == n )
 return static_cast<T*>( item );
 else
 n++;
 }
 }
 
 return nullptr;
 }

References m_items.

◆ Items()

ENTRIES & PNS::ITEM_SET::Items ( )

inline

Definition at line 135 of file pns_itemset.h.

135{ return m_items; }

References m_items.

Referenced by PNS::TOPOLOGY::AssembleTrivialPath(), PNS::COMPONENT_DRAGGER::Drag(), PNS::DRAGGER::dragViaMarkObstacles(), PNS::DRAGGER::dragViaWalkaround(), PNS::TOPOLOGY::followTrivialPath(), PNS::NODE::HitTest(), PNS_KICAD_IFACE_BASE::inheritTrackWidth(), PNS::ROUTER::isStartingPointRoutable(), PNS::ROUTER::markViolations(), PNS::TOOL_BASE::pickSingleItem(), PNS::COMPONENT_DRAGGER::Start(), and PNS::JOINT::Via().

◆ operator=()

ITEM_SET & PNS::ITEM_SET::operator= ( const ITEM_SET & aOther )

inline

Definition at line 108 of file pns_itemset.h.

 {
 m_items = aOther.m_items;
 return *this;
 }

References m_items.

◆ operator[]()

ITEM * PNS::ITEM_SET::operator[] ( size_t aIndex ) const

inline

Definition at line 168 of file pns_itemset.h.

 {
 return m_items[aIndex].item;
 }

References m_items.

◆ Prepend() [1/2]

void PNS::ITEM_SET::Prepend ( const LINE & aLine )

Definition at line 39 of file pns_itemset.cpp.

{
 LINE* copy = aLine.Clone();
 m_items.emplace( m_items.begin(), ENTRY( copy, true ) );
}

References PNS::LINE::Clone(), copy, and m_items.

Referenced by PNS::TOPOLOGY::followTrivialPath().

◆ Prepend() [2/2]

void PNS::ITEM_SET::Prepend	(	ITEM *	aItem,
		bool	aBecomeOwner = `false`
	)

inline

Definition at line 183 of file pns_itemset.h.

 {
 m_items.emplace( m_items.begin(), ENTRY( aItem, aBecomeOwner ) );
 }

References m_items.

◆ Size()

int PNS::ITEM_SET::Size ( ) const

inline

Definition at line 160 of file pns_itemset.h.

 {
 return static_cast<int>( m_items.size() );
 }

References m_items.

Referenced by PNS::TOPOLOGY::AssembleTuningPath(), PNS::JOINT::IsLineCorner(), PNS::JOINT::IsNonFanoutVia(), PNS::JOINT::IsStitchingVia(), PNS::JOINT::IsTraceWidthChange(), PNS::MEANDER_PLACER_BASE::lineLength(), PNS::ROUTER::StartDragging(), and PNS::JOINT::Unlink().

Member Data Documentation

◆ m_items

ENTRIES PNS::ITEM_SET::m_items

private

Definition at line 228 of file pns_itemset.h.

Referenced by Add(), begin(), cbegin(), cend(), CItems(), Clear(), Contains(), Count(), Empty(), end(), Erase(), ExcludeItem(), FilterKinds(), FilterLayers(), FilterMarker(), FilterNet(), FindByKind(), ITEM_SET(), Items(), operator=(), operator[](), Prepend(), and Size().

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

Classes

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ENTRIES

Constructor & Destructor Documentation

◆ ITEM_SET() [1/2]

◆ ITEM_SET() [2/2]

◆ ~ITEM_SET()

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ begin()

◆ cbegin()

◆ cend()

◆ CItems()

◆ Clear()

◆ Contains()

◆ Count()

◆ Empty()

◆ end()

◆ Erase()

◆ ExcludeItem()

◆ ExcludeKinds()

◆ ExcludeLayers()

◆ ExcludeNet()

◆ FilterKinds()

◆ FilterLayers()

◆ FilterMarker()

◆ FilterNet()

◆ FindByKind()

◆ Items()

◆ operator=()

◆ operator[]()

◆ Prepend() [1/2]

◆ Prepend() [2/2]

◆ Size()

Member Data Documentation

◆ m_items