net_chain_bridging.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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef PCBNEW_NET_CHAIN_BRIDGING_H
#define PCBNEW_NET_CHAIN_BRIDGING_H
 
#include <algorithm>
#include <limits>
#include <set>
#include <tuple>
#include <vector>
 
#include <wx/string.h>
 
class BOARD;
class FOOTPRINT;
class PAD;
 
 
constexpr double DEFAULT_PROPAGATION_DELAY_PS_PER_MM = 5.9;  // 150 ps/in fallback when no track delay sample is available
 

double FootprintChainBridgingLength( const FOOTPRINT* aFootprint, const wxString& aNetChain );
 

double BoardChainBridgingLength( const BOARD* aBoard, const wxString& aNetChain );
 

double ChainBridgingDelayPerMm( const BOARD* aBoard, const wxString& aNetChain );
 

std::tuple<double, double> BoardChainBridging( const BOARD* aBoard, const wxString& aNetChain );
 

inline int SubtractBridgingClamped( int aValue, long long aDelta )
{
    long long adjusted = static_cast<long long>( aValue ) - aDelta;
 
    return static_cast<int>( std::clamp( adjusted,
                                         0LL,
                                         static_cast<long long>( std::numeric_limits<int>::max() ) ) );
}
 

struct CHAIN_BRIDGE
{
    PAD*   padA;
    PAD*   padB;
    double length;
    double delay;
};
 

std::vector<CHAIN_BRIDGE> EnumerateChainBridges( const BOARD* aBoard, const wxString& aNetChain );
 

enum class NET_CHAIN_PARTITION_STATUS
{
    OK,
    INVALID_INPUT,            // null board, equal pads, etc.
    QUERY_NET_NOT_IN_CHAIN,   // aQueryNet has no chain assignment
    START_PAD_NOT_ON_QUERY,   // aStartPad's netcode != aQueryNet
    END_PAD_NOT_ON_QUERY,
    NO_CHAIN_BRIDGES,         // the query net has no series-passive bridge in the chain
    AMBIGUOUS_OVERLAP         // the two sides share at least one netcode (cycle)
};
 

struct NET_CHAIN_PARTITION
{
    NET_CHAIN_PARTITION_STATUS status = NET_CHAIN_PARTITION_STATUS::INVALID_INPUT;
    std::set<int>              beforeStart;
    std::set<int>              afterEnd;
};
 

NET_CHAIN_PARTITION PartitionNetChainAroundNet( const BOARD* aBoard, int aQueryNet,
                                                const PAD* aStartPad, const PAD* aEndPad );
 
 
#endif // PCBNEW_NET_CHAIN_BRIDGING_H