tuning_profile_parameters_iface.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_TUNING_PROFILE_PARAMETERS_IFACE_H
#define PCBNEW_TUNING_PROFILE_PARAMETERS_IFACE_H
 
#include <length_delay_calculation/length_delay_calculation_item.h>
#include <netclass.h>
 
class BOARD;
class LENGTH_DELAY_CALCULATION;

struct TUNING_PROFILE_GEOMETRY_CONTEXT
{
    const NETCLASS* NetClass;

    PCB_LAYER_ID Layer;

    int64_t Width;

    bool IsDiffPairCoupled{ false };

    int64_t DiffPairCouplingGap{ 0 };
};
 

class TUNING_PROFILE_PARAMETERS_IFACE
{
public:
    explicit TUNING_PROFILE_PARAMETERS_IFACE( BOARD* aBoard, LENGTH_DELAY_CALCULATION* aCalculation ) :
            m_board{ aBoard },
            m_lengthCalculation{ aCalculation }
    {
    }
 
    virtual ~TUNING_PROFILE_PARAMETERS_IFACE() = default;

    virtual void OnStackupChanged() {};

    virtual void OnSettingsChanged() {};

    virtual std::vector<int64_t> GetPropagationDelays( const std::vector<LENGTH_DELAY_CALCULATION_ITEM>& aItems,
                                                       const TUNING_PROFILE_GEOMETRY_CONTEXT&            aContext ) = 0;

    virtual int64_t GetPropagationDelay( const LENGTH_DELAY_CALCULATION_ITEM&   aItem,
                                         const TUNING_PROFILE_GEOMETRY_CONTEXT& aContext ) = 0;

    virtual int64_t GetViaPropagationDelay( const PCB_LAYER_ID aSignalStartLayer, const PCB_LAYER_ID aSignalEndLayer,
                                            const PCB_LAYER_ID aViaStartLayer, const PCB_LAYER_ID aViaEndLayer,
                                            const TUNING_PROFILE_GEOMETRY_CONTEXT& aContext ) const = 0;

    virtual int64_t GetTrackLengthForPropagationDelay( int64_t                                aDelay,
                                                       const TUNING_PROFILE_GEOMETRY_CONTEXT& aContext ) = 0;

    virtual bool CanCalculateLengthForDelay( const TUNING_PROFILE_GEOMETRY_CONTEXT& aContext ) const = 0;

    virtual int64_t CalculatePropagationDelayForShapeLineChain( const SHAPE_LINE_CHAIN&                aShape,
                                                                const TUNING_PROFILE_GEOMETRY_CONTEXT& aContext ) = 0;
 
protected:
    BOARD* m_board;

    LENGTH_DELAY_CALCULATION* m_lengthCalculation;
};
 
#endif //PCBNEW_TUNING_PROFILE_PARAMETERS_IFACE_H