tuning_profile_parameters_user_defined.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 PCB_NEW_TUNING_PROFILE_PARAMETERS_USER_DEFINED_H
#define PCB_NEW_TUNING_PROFILE_PARAMETERS_USER_DEFINED_H
 
 
#include <length_delay_calculation/tuning_profile_parameters_iface.h>
#include <project/tuning_profiles.h>
 
class TUNING_PROFILE_PARAMETERS_USER_DEFINED final : public TUNING_PROFILE_PARAMETERS_IFACE
{
public:
    explicit TUNING_PROFILE_PARAMETERS_USER_DEFINED( BOARD* aBoard, LENGTH_DELAY_CALCULATION* aCalculation ) :
            TUNING_PROFILE_PARAMETERS_IFACE( aBoard, aCalculation )
    {
    }

    void OnSettingsChanged() override;

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

    int64_t GetPropagationDelay( const LENGTH_DELAY_CALCULATION_ITEM&   aItem,
                                 const TUNING_PROFILE_GEOMETRY_CONTEXT& aContext ) override;

    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 override;

    int64_t GetTrackLengthForPropagationDelay( int64_t                                aDelay,
                                               const TUNING_PROFILE_GEOMETRY_CONTEXT& aContext ) override;

    bool CanCalculateLengthForDelay( const TUNING_PROFILE_GEOMETRY_CONTEXT& aContext ) const override;

    int64_t CalculatePropagationDelayForShapeLineChain( const SHAPE_LINE_CHAIN&                aShape,
                                                        const TUNING_PROFILE_GEOMETRY_CONTEXT& aContext ) override;
 
private:
    void rebuildCaches();

    struct VIA_OVERRIDE_CACHE_KEY
    {
        PCB_LAYER_ID SignalStart;
        PCB_LAYER_ID SignalEnd;
        PCB_LAYER_ID ViaStart;
        PCB_LAYER_ID ViaEnd;
 
        bool operator<( const VIA_OVERRIDE_CACHE_KEY& aOther ) const
        {
            if( SignalStart < aOther.SignalStart )
                return true;
            if( aOther.SignalStart < SignalStart )
                return false;
            if( SignalEnd < aOther.SignalEnd )
                return true;
            if( aOther.SignalEnd < SignalEnd )
                return false;
            if( ViaStart < aOther.ViaStart )
                return true;
            if( aOther.ViaStart < ViaStart )
                return false;
            return ViaEnd < aOther.ViaEnd;
        }
    };

    int64_t getPropagationDelay( const LENGTH_DELAY_CALCULATION_ITEM&   aItem,
                                 const TUNING_PROFILE_GEOMETRY_CONTEXT& aContext,
                                 const TUNING_PROFILE*                  aDelayProfile ) const;

    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* aTuningProfile ) const;

    const TUNING_PROFILE* GetTuningProfile( const wxString& aDelayProfileName ) const;

    double getTrackDelayPerMM( const TUNING_PROFILE_GEOMETRY_CONTEXT& aContext ) const;

    std::map<wxString, const TUNING_PROFILE*> m_delayProfilesCache;

    std::map<wxString, std::map<VIA_OVERRIDE_CACHE_KEY, int64_t>> m_viaOverridesCache;
};
 
#endif //PCB_NEW_TUNING_PROFILE_PARAMETERS_USER_DEFINED_H