connectivity_data.h

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 2013-2017 CERN
 * Copyright (C) 2018-2023 KiCad Developers, see AUTHORS.txt for contributors.
 * @author Maciej Suminski <[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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef __CONNECTIVITY_DATA_H
#define __CONNECTIVITY_DATA_H
 
#include <core/typeinfo.h>
#include <core/spinlock.h>
 
#include <memory>
#include <mutex>
#include <vector>
#include <wx/string.h>
 
#include <math/vector2d.h>
#include <geometry/shape_poly_set.h>
#include <project/net_settings.h>
#include <zone.h>
 
class FROM_TO_CACHE;
class CN_CLUSTER;
class CN_CONNECTIVITY_ALGO;
class CN_EDGE;
class BOARD;
class BOARD_COMMIT;
class BOARD_CONNECTED_ITEM;
class BOARD_ITEM;
class ZONE;
class RN_DATA;
class RN_NET;
class PCB_TRACK;
class PCB_VIA;
class PAD;
class FOOTPRINT;
class PROGRESS_REPORTER;
 
 
struct CN_DISJOINT_NET_ENTRY
{
    int net;
    BOARD_CONNECTED_ITEM *a, *b;
    VECTOR2I anchorA, anchorB;
};
 
 
struct RN_DYNAMIC_LINE
{
    int netCode;
    VECTOR2I a, b;
};
 
 
enum class PROPAGATE_MODE
{
    SKIP_CONFLICTS,     
    RESOLVE_CONFLICTS   
};
 
 
// a wrapper class encompassing the connectivity computation algorithm and the
class CONNECTIVITY_DATA
{
public:
    CONNECTIVITY_DATA();
    ~CONNECTIVITY_DATA();
 
    CONNECTIVITY_DATA( std::shared_ptr<CONNECTIVITY_DATA> aGlobalConnectivity,
                       const std::vector<BOARD_ITEM*>& aLocalItems, bool                               aSkipRatsnestUpdate = false );
 
    bool Build( BOARD* aBoard, PROGRESS_REPORTER* aReporter = nullptr );
 
    void Build( std::shared_ptr<CONNECTIVITY_DATA>& aGlobalConnectivity,
                const std::vector<BOARD_ITEM*>& aLocalItems );
 
    bool Add( BOARD_ITEM* aItem );
 
    bool Remove( BOARD_ITEM* aItem );
 
    bool Update( BOARD_ITEM* aItem );
 
    void Move( const VECTOR2I& aDelta );
 
    void ClearRatsnest();
 
    int GetNetCount() const;
 
    RN_NET* GetRatsnestForNet( int aNet );
 
    void PropagateNets( BOARD_COMMIT* aCommit = nullptr );
 
    void FillIsolatedIslandsMap( std::map<ZONE*, std::map<PCB_LAYER_ID, ISOLATED_ISLANDS>>& aMap,
                                 bool aConnectivityAlreadyRebuilt = false );
 
    void RecalculateRatsnest( BOARD_COMMIT* aCommit = nullptr );
 
    unsigned int GetUnconnectedCount( bool aVisibileOnly ) const;
 
    bool IsConnectedOnLayer( const BOARD_CONNECTED_ITEM* aItem, int aLayer,
                             const std::initializer_list<KICAD_T>& aTypes = {} ) const;
 
    unsigned int GetNodeCount( int aNet = -1 ) const;
 
    unsigned int GetPadCount( int aNet = -1 ) const;
 
    const std::vector<PCB_TRACK*> GetConnectedTracks( const BOARD_CONNECTED_ITEM* aItem ) const;
 
    const std::vector<PAD*> GetConnectedPads( const BOARD_CONNECTED_ITEM* aItem ) const;
 
    void GetConnectedPads( const BOARD_CONNECTED_ITEM* aItem, std::set<PAD*>* pads ) const;
 
    void GetConnectedPadsAndVias( const BOARD_CONNECTED_ITEM* aItem, std::vector<PAD*>* pads,
                                  std::vector<PCB_VIA*>* vias );
 
    const std::vector<BOARD_CONNECTED_ITEM*>
    GetConnectedItemsAtAnchor( const BOARD_CONNECTED_ITEM* aItem, const VECTOR2I& aAnchor,
                               const std::vector<KICAD_T>& aTypes, const int& aMaxError = 0 ) const;
 
    void RunOnUnconnectedEdges( std::function<bool( CN_EDGE& )> aFunc );
 
    bool TestTrackEndpointDangling( PCB_TRACK* aTrack, bool aIgnoreTracksInPads,
                                    VECTOR2I* aPos = nullptr ) const;
 
    void ClearLocalRatsnest();
 
    void HideLocalRatsnest();
 
    void ComputeLocalRatsnest( const std::vector<BOARD_ITEM*>& aItems,
                               const CONNECTIVITY_DATA* aDynamicData,
                               VECTOR2I aInternalOffset = { 0, 0 } );
 
    const std::vector<RN_DYNAMIC_LINE>& GetLocalRatsnest() const { return m_dynamicRatsnest; }
 
    const std::vector<BOARD_CONNECTED_ITEM*>
    GetConnectedItems( const BOARD_CONNECTED_ITEM* aItem, const std::vector<KICAD_T>& aTypes,
                       bool aIgnoreNetcodes = false ) const;
 
    const std::vector<BOARD_CONNECTED_ITEM*>
    GetNetItems( int aNetCode, const std::vector<KICAD_T>& aTypes ) const;
 
    void BlockRatsnestItems( const std::vector<BOARD_ITEM*>& aItems );
 
    std::shared_ptr<CN_CONNECTIVITY_ALGO> GetConnectivityAlgo() const { return m_connAlgo; }
 
    KISPINLOCK& GetLock() { return m_lock; }
 
    void MarkItemNetAsDirty( BOARD_ITEM* aItem );
    void RemoveInvalidRefs();
 
    void SetProgressReporter( PROGRESS_REPORTER* aReporter );
 
    const NET_SETTINGS* GetNetSettings() const;
 
    bool            HasNetNameForNetCode( int nc ) const { return m_netcodeMap.count( nc ) > 0; }
    const wxString& GetNetNameForNetCode( int nc ) const { return m_netcodeMap.at( nc ); }
 
    void RefreshNetcodeMap( BOARD* aBoard );
 
#ifndef SWIG
    const std::vector<CN_EDGE> GetRatsnestForItems( const std::vector<BOARD_ITEM*>& aItems );
 
    const std::vector<CN_EDGE> GetRatsnestForPad( const PAD* aPad );
 
    const std::vector<CN_EDGE> GetRatsnestForComponent( FOOTPRINT* aComponent,
                                                        bool aSkipInternalConnections = false );
#endif
 
    std::shared_ptr<FROM_TO_CACHE> GetFromToCache() { return m_fromToCache; }
 
private:
 
    void internalRecalculateRatsnest( BOARD_COMMIT* aCommit = nullptr );
    void updateRatsnest();
 
    void addRatsnestCluster( const std::shared_ptr<CN_CLUSTER>& aCluster );
 
private:
    std::shared_ptr<CN_CONNECTIVITY_ALGO> m_connAlgo;
 
    std::shared_ptr<FROM_TO_CACHE>  m_fromToCache;
    std::vector<RN_DYNAMIC_LINE>    m_dynamicRatsnest;
    std::vector<RN_NET*>            m_nets;
 
    bool                            m_skipRatsnestUpdate;
 
    KISPINLOCK                      m_lock;
 
    PROGRESS_REPORTER*              m_progressReporter;
 
    std::weak_ptr<NET_SETTINGS> m_netSettings;
 
    std::map<int, wxString> m_netcodeMap;
};
 
#endif