length_calculation.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 PCBNEW_LENGTH_CALCULATION_H
#define PCBNEW_LENGTH_CALCULATION_H
 
#include <board_design_settings.h>
#include <geometry/shape_line_chain.h>
#include <pad.h>
#include <pcb_track.h>
#include <layer_ids.h>
#include <unordered_set>
#include <connectivity/connectivity_data.h>
 
class BOARD;
 
class LENGTH_CALCULATION_ITEM
{
public:
    enum class TYPE
    {
        UNKNOWN,
        PAD,
        LINE,
        VIA
    };
 
    enum class MERGE_STATUS
    {
        UNMERGED,
        MERGED_IN_USE,
        MERGED_RETIRED
    };
 
    TYPE Type() const { return m_type; };
 
    void SetPad( PAD* aPad )
    {
        m_type = TYPE::PAD;
        m_pad = aPad;
    }
 
    PAD* GetPad() const { return m_pad; }
 
    void SetLine( const SHAPE_LINE_CHAIN& aLine )
    {
        m_type = TYPE::LINE;
        m_line = aLine;
    }
 
    SHAPE_LINE_CHAIN& GetLine() const { return m_line; }
 
    void              SetVia( PCB_VIA* aVia )
    {
        m_type = TYPE::VIA;
        m_via = aVia;
    }
 
    PCB_VIA* GetVia() const { return m_via; }
 
    void     SetLayers( const PCB_LAYER_ID aStart, const PCB_LAYER_ID aEnd = PCB_LAYER_ID::UNDEFINED_LAYER )
    {
        m_layerStart = aStart;
        m_layerEnd = aEnd;
    }
 
    void SetMergeStatus( const MERGE_STATUS aStatus ) { m_mergeStatus = aStatus; }
 
    MERGE_STATUS GetMergeStatus() const { return m_mergeStatus; }
 
    std::tuple<PCB_LAYER_ID, PCB_LAYER_ID> GetLayers() const { return { m_layerStart, m_layerEnd }; }
 
    PCB_LAYER_ID GetStartLayer() const { return m_layerStart; }
 
    PCB_LAYER_ID GetEndLayer() const { return m_layerEnd; }
 
    void CalculateViaLayers( const BOARD* aBoard );
 
protected:
    PAD*                     m_pad{ nullptr };
 
    mutable SHAPE_LINE_CHAIN m_line;
 
    PCB_VIA*                 m_via{ nullptr };
 
    PCB_LAYER_ID             m_layerStart{ PCB_LAYER_ID::UNDEFINED_LAYER };
 
    PCB_LAYER_ID             m_layerEnd{ PCB_LAYER_ID::UNDEFINED_LAYER };
 
    MERGE_STATUS m_mergeStatus{ MERGE_STATUS::UNMERGED };
 
    TYPE m_type{ TYPE::UNKNOWN };
};
 
 
struct LENGTH_DETAILS
{
    int                                              NumPads{ 0 };
    int                                              NumVias{ 0 };
    int                                              ViaLength{ 0 };
    int64_t                                          TrackLength{ 0 };
    int                                              PadToDieLength{ 0 };
    std::unique_ptr<std::map<PCB_LAYER_ID, int64_t>> LayerLengths;
 
    int64_t TotalLength() const { return ViaLength + TrackLength + PadToDieLength; }
};
 
 
struct PATH_OPTIMISATIONS
{
    bool OptimiseViaLayers = false;
 
    bool MergeTracks = false;
 
    bool OptimiseTracesInPads = false;
 
    bool InferViaInPad = false;
};
 
 
class LENGTH_CALCULATION
{
public:
    explicit LENGTH_CALCULATION( BOARD* aBoard ) : m_board( aBoard ) {}
 
    int64_t CalculateLength( std::vector<LENGTH_CALCULATION_ITEM>& aItems, PATH_OPTIMISATIONS aOptimisations,
                             const PAD* aStartPad = nullptr, const PAD* aEndPad = nullptr ) const;
 
    LENGTH_DETAILS CalculateLengthDetails( std::vector<LENGTH_CALCULATION_ITEM>& aItems,
                                           PATH_OPTIMISATIONS aOptimisations, const PAD* aStartPad = nullptr,
                                           const PAD* aEndPad = nullptr, bool aWithLayerLengths = false ) const;
 
    static void OptimiseTraceInPad( SHAPE_LINE_CHAIN& aLine, const PAD* aPad, PCB_LAYER_ID aPcbLayer );
 
    LENGTH_CALCULATION_ITEM GetLengthCalculationItem( BOARD_CONNECTED_ITEM* aBoardItem ) const;
 
protected:
    BOARD* m_board;
 
    enum class MERGE_POINT
    {
        START,
        END
    };
 
    int stackupHeight( PCB_LAYER_ID aFirstLayer, PCB_LAYER_ID aSecondLayer ) const;
 
    static void optimiseTracesInPads( const std::vector<LENGTH_CALCULATION_ITEM*>& aPads,
                                      const std::vector<LENGTH_CALCULATION_ITEM*>& aLines );
 
    static void clipLineToPad( SHAPE_LINE_CHAIN& aLine, const PAD* aPad, PCB_LAYER_ID aLayer, bool aForward = true );
 
    static void
    optimiseViaLayers( const std::vector<LENGTH_CALCULATION_ITEM*>&                            aVias,
                       std::vector<LENGTH_CALCULATION_ITEM*>&                                  aLines,
                       std::map<VECTOR2I, std::unordered_set<LENGTH_CALCULATION_ITEM*>>&       aLinesPositionMap,
                       const std::map<VECTOR2I, std::unordered_set<LENGTH_CALCULATION_ITEM*>>& aPadsPositionMap );
 
    static void mergeLines( std::vector<LENGTH_CALCULATION_ITEM*>&                            aLines,
                            std::map<VECTOR2I, std::unordered_set<LENGTH_CALCULATION_ITEM*>>& aLinesPositionMap );
 
    static void mergeShapeLineChains( SHAPE_LINE_CHAIN& aPrimary, const SHAPE_LINE_CHAIN& aSecondary,
                                      MERGE_POINT aMergePoint );
 
    void inferViaInPad( const PAD* aPad, const LENGTH_CALCULATION_ITEM& aItem, LENGTH_DETAILS& aDetails ) const;
};
 
#endif //PCBNEW_LENGTH_CALCULATION_H