pns_meander_placer_base.h

Go to the documentation of this file.

/*
 * KiRouter - a push-and-(sometimes-)shove PCB router
 *
 * Copyright (C) 2013-2015 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @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 3 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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef __PNS_MEANDER_PLACER_BASE_H
#define __PNS_MEANDER_PLACER_BASE_H
 
#include <math/vector2d.h>
 
#include <geometry/shape_line_chain.h>
 
#include "pns_node.h"
#include "pns_line.h"
#include "pns_placement_algo.h"
#include "pns_meander.h"
 
namespace PNS {
 
class ROUTER;
class SHOVE;
class OPTIMIZER;

class MEANDER_PLACER_BASE : public PLACEMENT_ALGO
{
public:
    enum TUNING_STATUS {
        TOO_SHORT = 0,
        TOO_LONG,
        TUNED
    };
 
    MEANDER_PLACER_BASE( ROUTER* aRouter );
    virtual ~MEANDER_PLACER_BASE();

    virtual long long int TuningLengthResult() const = 0;

    virtual int64_t TuningDelayResult() const { return 0; };
 
    bool HasBaseline() const { return m_baselineLength != 0 || m_baselineDelay != 0; }
 
    long long int TuningLengthDelta() const { return TuningLengthResult() - m_baselineLength; }
    int64_t TuningDelayDelta() const { return TuningDelayResult() - m_baselineDelay; }

    virtual TUNING_STATUS TuningStatus() const = 0;

    virtual void AmplitudeStep( int aSign );

    virtual void SpacingStep( int aSign );

    virtual int Clearance();

    virtual const MEANDER_SETTINGS& MeanderSettings() const;
 
    /*
     * Set the current meandering configuration.
     *
     * @param aSettings the settings.
     */
    virtual void UpdateSettings( const MEANDER_SETTINGS& aSettings);

    virtual bool CheckFit( MEANDER_SHAPE* aShape )
    {
        return false;
    }
 
    virtual const ITEM_SET TunedPath() = 0;
 
protected:
    void tuneLineLength( MEANDERED_LINE& aTuned, long long int aElongation );
 
    VECTOR2I getSnappedStartPoint( LINKED_ITEM* aStartItem, VECTOR2I aStartPoint );

    long long int lineLength( const ITEM_SET& aLine, const SOLID* aStartPad, const SOLID* aEndPad ) const;

    int64_t lineDelay( const ITEM_SET& aLine, const SOLID* aStartPad, const SOLID* aEndPad ) const;

    void initChainExtras();

    long long int chainNarrowingOffset() const;

    long long int m_baselineLength = 0;
    int64_t       m_baselineDelay = 0;

    long long int m_chainExtrasLength = 0;
    long long int m_chainExtrasDelay = 0;
    bool          m_chainExtrasValid = false;

    NODE* m_world;

    int m_currentWidth;

    MEANDER_SETTINGS m_settings;

    VECTOR2I m_currentEnd;
 
    SOLID*   m_startPad_p;
    SOLID*   m_endPad_p;
    SOLID*   m_startPad_n;
    SOLID*   m_endPad_n;
};
 
}
 
#endif    // __PNS_MEANDER_PLACER_BASE_H