FOOTPRINT_FILTER::ITERATOR Class Reference

Inner iterator class returned by begin() and end(). More...

#include <footprint_filter.h>

Inheritance diagram for FOOTPRINT_FILTER::ITERATOR:

Public Member Functions
	ITERATOR ()
	ITERATOR (const ITERATOR &aOther)
	ITERATOR (FOOTPRINT_FILTER &aFilter)

Private Member Functions
void	increment ()
bool	equal (const ITERATOR &aOther) const
FOOTPRINT_INFO &	dereference () const
bool	FootprintFilterMatch (FOOTPRINT_INFO &aItem)
	Check if the stored component matches an item by footprint filter. More...
bool	PinCountMatch (FOOTPRINT_INFO &aItem)
	Check if the stored component matches an item by pin count. More...

Private Attributes
size_t	m_pos
FOOTPRINT_FILTER *	m_filter

Friends
class	boost::iterator_core_access
class	FOOTPRINT_FILTER

Detailed Description

Inner iterator class returned by begin() and end().

Definition at line 82 of file footprint_filter.h.

Constructor & Destructor Documentation

ITERATOR() [1/3]

FOOTPRINT_FILTER::ITERATOR::ITERATOR

(

)

Definition at line 28 of file footprint_filter.cpp.

                                   : m_pos( 0 ), m_filter( nullptr )
{
}

ITERATOR() [2/3]

FOOTPRINT_FILTER::ITERATOR::ITERATOR

(

const ITERATOR &

aOther

)

Definition at line 33 of file footprint_filter.cpp.

        : m_pos( aOther.m_pos ), m_filter( aOther.m_filter )
{
}

ITERATOR() [3/3]

FOOTPRINT_FILTER::ITERATOR::ITERATOR

(

FOOTPRINT_FILTER &

aFilter

)

Definition at line 39 of file footprint_filter.cpp.

        : m_pos( (size_t) -1 ), m_filter( &aFilter )
{
    increment();
}

References increment().

Member Function Documentation

dereference()

FOOTPRINT_INFO & FOOTPRINT_FILTER_IT::dereference ( ) const

private

Definition at line 118 of file footprint_filter.cpp.

{
    if( m_filter && m_filter->m_list && m_pos < m_filter->m_list->GetCount() )
        return m_filter->m_list->GetItem( m_pos );
    else
        throw std::out_of_range( "Attempt to dereference past FOOTPRINT_FILTER::end()" );
}

References FOOTPRINT_LIST::GetCount(), and FOOTPRINT_FILTER::m_list.

equal()

bool FOOTPRINT_FILTER_IT::equal ( const ITERATOR &  aOther ) const

private

Definition at line 111 of file footprint_filter.cpp.

{
    // Invalid iterators are always equal
    return ( m_pos == aOther.m_pos ) && ( m_filter == aOther.m_filter || m_pos == (size_t) -1 );
}

References m_filter, and m_pos.

FootprintFilterMatch()

bool FOOTPRINT_FILTER_IT::FootprintFilterMatch ( FOOTPRINT_INFO &  aItem )

private

Check if the stored component matches an item by footprint filter.

Definition at line 127 of file footprint_filter.cpp.

{
    if( m_filter->m_footprint_filters.empty() )
        return true;

    // The matching is case insensitive
    wxString name;

    for( auto const& each_filter : m_filter->m_footprint_filters )
    {
        name.Empty();

        // If the filter contains a ':' character, include the library name in the pattern
        if( each_filter->GetPattern().Contains( ":" ) )
        {
            name = aItem.GetLibNickname().Lower() + ":";
        }

        name += aItem.GetFootprintName().Lower();

        if( each_filter->Find( name ) )
        {
            return true;
        }
    }

    return false;
}

References FOOTPRINT_INFO::GetFootprintName(), FOOTPRINT_INFO::GetLibNickname(), and name.

increment()

void FOOTPRINT_FILTER_IT::increment ( )

private

Definition at line 46 of file footprint_filter.cpp.

{
    if( !m_filter || !m_filter->m_list || m_filter->m_list->GetCount() == 0 )
    {
        m_pos = 0;
        return;
    }

    int             filter_type = m_filter->m_filter_type;
    FOOTPRINT_LIST* list        = m_filter->m_list;
    wxString&       lib_name    = m_filter->m_lib_name;

    for( ++m_pos; m_pos < list->GetCount(); ++m_pos )
    {
        FOOTPRINT_INFO& candidate = list->GetItem( m_pos );

        if( filter_type == FOOTPRINT_FILTER::UNFILTERED_FP_LIST )
            break;

        if( filter_type & FOOTPRINT_FILTER::FILTERING_BY_PIN_COUNT )
        {
            if( !PinCountMatch( candidate ) )
                continue;
        }

        if( filter_type & FOOTPRINT_FILTER::FILTERING_BY_LIBRARY )
        {
            if( !lib_name.IsEmpty() && !candidate.InLibrary( lib_name ) )
                continue;
        }

        if( filter_type & FOOTPRINT_FILTER::FILTERING_BY_COMPONENT_FP_FILTER )
        {
            if( !FootprintFilterMatch( candidate ) )
                continue;
        }

        if( ( filter_type & FOOTPRINT_FILTER::FILTERING_BY_TEXT_PATTERN ) )
        {
            wxString searchStr = wxString::Format( wxT( "%s:%s %s" ),
                                                   candidate.GetLibNickname(),
                                                   candidate.GetFootprintName(),
                                                   candidate.GetSearchText() );
            int      matches, position;
            bool     exclude = false;

            for( auto& matcher : m_filter->m_pattern_filters )
            {
                if( !matcher->Find( searchStr.Lower(), matches, position ) )
                {
                    exclude = true;
                    break;
                }
            }

            if( exclude )
                continue;
        }

        // Candidate passed all filters; exit loop
        break;
    }
}

References FOOTPRINT_FILTER::FILTERING_BY_COMPONENT_FP_FILTER, FOOTPRINT_FILTER::FILTERING_BY_LIBRARY, FOOTPRINT_FILTER::FILTERING_BY_PIN_COUNT, FOOTPRINT_FILTER::FILTERING_BY_TEXT_PATTERN, Format(), FOOTPRINT_LIST::GetCount(), FOOTPRINT_INFO::GetFootprintName(), FOOTPRINT_LIST::GetItem(), FOOTPRINT_INFO::GetLibNickname(), FOOTPRINT_INFO::GetSearchText(), FOOTPRINT_INFO::InLibrary(), FOOTPRINT_LIST::m_list, and FOOTPRINT_FILTER::UNFILTERED_FP_LIST.

Referenced by ITERATOR().

PinCountMatch()

bool FOOTPRINT_FILTER_IT::PinCountMatch ( FOOTPRINT_INFO &  aItem )

private

Check if the stored component matches an item by pin count.

Definition at line 157 of file footprint_filter.cpp.

{
    return m_filter->m_pin_count >= 0 &&
        (unsigned) m_filter->m_pin_count == aItem.GetUniquePadCount();
}

References FOOTPRINT_INFO::GetUniquePadCount().

Friends And Related Function Documentation

boost::iterator_core_access

friend class boost::iterator_core_access

friend

Definition at line 91 of file footprint_filter.h.

FOOTPRINT_FILTER

friend class FOOTPRINT_FILTER

friend

Definition at line 92 of file footprint_filter.h.

Member Data Documentation

m_filter

FOOTPRINT_FILTER* FOOTPRINT_FILTER::ITERATOR::m_filter

private

Definition at line 99 of file footprint_filter.h.

Referenced by equal().

m_pos

size_t FOOTPRINT_FILTER::ITERATOR::m_pos

private

Definition at line 98 of file footprint_filter.h.

Referenced by FOOTPRINT_FILTER::end(), and equal().

---

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

• footprint_filter.h
• footprint_filter.cpp