pns_link_holder.h

Go to the documentation of this file.

/*
 * KiRouter - a push-and-(sometimes-)shove PCB router
 *
 * Copyright (C) 2019 CERN
 * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * Author: Seth Hillbrand <[email protected]>
 * Author: Tomasz Wlostowski <[email protected]>
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef PCBNEW_ROUTER_PNS_LINK_HOLDER_H_
#define PCBNEW_ROUTER_PNS_LINK_HOLDER_H_
 
#include <core/kicad_algo.h>
#include "pns_item.h"
#include "pns_linked_item.h"
 
namespace PNS
{
class LINK_HOLDER : public ITEM
{
public:
    LINK_HOLDER( PnsKind aKind ) : ITEM( aKind )
    {}
 
    void Link( LINKED_ITEM* aLink )
    {
        wxCHECK_MSG( !alg::contains( m_links, aLink ), /* void */,
                     "Trying to link an item that is already linked" );
        m_links.push_back( aLink );
    }
 
    void Unlink( const LINKED_ITEM* aLink )
    {
        wxCHECK_MSG( alg::contains( m_links, aLink ), /* void */,
                     "Trying to unlink an item that is not linked" );
        alg::delete_matching( m_links, aLink );
    }
 
    std::vector<LINKED_ITEM*>& Links() { return m_links; }
    const std::vector<LINKED_ITEM*>& Links() const { return m_links; }
 
    bool IsLinked() const
    {
        return m_links.size() != 0;
    }
 
    bool ContainsLink( const LINKED_ITEM* aItem ) const
    {
        return alg::contains( m_links, aItem );
    }
 
    LINKED_ITEM* GetLink( int aIndex ) const
    {
        if( aIndex < 0 )
            aIndex += m_links.size();
        return m_links[aIndex];
    }
 
    virtual void ClearLinks()
    {
        m_links.clear();
    }
 
    int LinkCount() const
    {
        return m_links.size();
    }
 
    void ShowLinks() const
    {
#if 0 
        if( !IsLinked() )
        {
            wxLogTrace( wxT( "PNS" ), wxT( "item %p: no links" ), this );
            return;
        }
 
        wxLogTrace( wxT( "PNS" ), wxT( "item %p: %d links" ), this, (int) m_links.size() );
 
        for( int i = 0; i < (int) m_links.size(); i++ )
            wxLogTrace( wxT( "PNS" ), wxT( "item %d: %p\n" ), i, m_links[i] );
#endif
    }
 
protected:
    void copyLinks( const LINK_HOLDER* aParent )
    {
        m_links = aParent->m_links;
    }
 
    std::vector<LINKED_ITEM*> m_links;
};
 
} // namespace PNS
#endif /* PCBNEW_ROUTER_PNS_LINK_HOLDER_H_ */