KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pns_link_holder.h
Go to the documentation of this file.
1/*
2 * KiRouter - a push-and-(sometimes-)shove PCB router
3 *
4 * Copyright (C) 2019 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * Author: Seth Hillbrand <[email protected]>
8 * Author: Tomasz Wlostowski <[email protected]>
9 *
10 * This program is free software: you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation, either version 3 of the License, or (at your
13 * option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License along
21 * with this program. If not, see <http://www.gnu.org/licenses/>.
22 */
23
24#ifndef PCBNEW_ROUTER_PNS_LINK_HOLDER_H_
25#define PCBNEW_ROUTER_PNS_LINK_HOLDER_H_
26
27#include <core/kicad_algo.h>
28#include <algorithm>
29#include "pns_item.h"
30#include "pns_linked_item.h"
31
32namespace PNS
33{
34class LINK_HOLDER : public ITEM
35{
36public:
38 ITEM( aKind )
39 {}
40
42 void Link( LINKED_ITEM* aLink )
43 {
44 wxCHECK_MSG( !alg::contains( m_links, aLink ), /* void */,
45 "Trying to link an item that is already linked" );
46 m_links.push_back( aLink );
47 }
48
49 void Unlink( const LINKED_ITEM* aLink )
50 {
51 wxCHECK_MSG( alg::contains( m_links, aLink ), /* void */,
52 "Trying to unlink an item that is not linked" );
53 std::erase( m_links, aLink );
54 }
55
58 std::vector<LINKED_ITEM*>& Links() { return m_links; }
59 const std::vector<LINKED_ITEM*>& Links() const { return m_links; }
60
61 bool IsLinked() const
62 {
63 return m_links.size() != 0;
64 }
65
67 bool ContainsLink( const LINKED_ITEM* aItem ) const
68 {
69 return alg::contains( m_links, aItem );
70 }
71
72 LINKED_ITEM* GetLink( int aIndex ) const
73 {
74 if( aIndex < 0 )
75 aIndex += m_links.size();
76
77 return m_links[aIndex];
78 }
79
81 virtual void ClearLinks()
82 {
83 m_links.clear();
84 }
85
87 int LinkCount() const
88 {
89 return m_links.size();
90 }
91
92 void ShowLinks() const
93 {
94#if 0
95 if( !IsLinked() )
96 {
97 wxLogTrace( wxT( "PNS" ), wxT( "item %p: no links" ), this );
98 return;
99 }
100
101 wxLogTrace( wxT( "PNS" ), wxT( "item %p: %d links" ), this, (int) m_links.size() );
102
103 for( int i = 0; i < (int) m_links.size(); i++ )
104 wxLogTrace( wxT( "PNS" ), wxT( "item %d: %p\n" ), i, m_links[i] );
105#endif
106 }
107
108protected:
110 void copyLinks( const LINK_HOLDER* aParent )
111 {
112 m_links = aParent->m_links;
113 }
114
117 std::vector<LINKED_ITEM*> m_links;
118};
119
120} // namespace PNS
121#endif /* PCBNEW_ROUTER_PNS_LINK_HOLDER_H_ */
Base class for PNS router board items.
Definition: pns_item.h:98
PnsKind
< Supported item types
Definition: pns_item.h:102
Push and Shove diff pair dimensions (gap) settings dialog.
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:100