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 (C) 2016-2021 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 const wxString TuningInfo( EDA_UNITS aUnits ) const = 0;

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

 int GetTotalPadToDieLength( const LINE& aLine ) const;

protected:
 void cutTunedLine( const SHAPE_LINE_CHAIN& aOrigin, const VECTOR2I& aTuneStart,
 const VECTOR2I& aCursorPos, SHAPE_LINE_CHAIN& aPre, SHAPE_LINE_CHAIN& aTuned,
 SHAPE_LINE_CHAIN& aPost );

 void tuneLineLength( MEANDERED_LINE& aTuned, long long int aElongation );

 int compareWithTolerance( long long int aValue, long long int aExpected,
 long long int aTolerance = 0 ) const;

 VECTOR2I getSnappedStartPoint( LINKED_ITEM* aStartItem, VECTOR2I aStartPoint );

 long long int lineLength( const ITEM_SET& aLine ) const;

 NODE* m_world;

 int m_padToDieLength;

 int m_currentWidth;

 MEANDER_SETTINGS m_settings;

 VECTOR2I m_currentEnd;
};

}

#endif // __PNS_MEANDER_PLACER_BASE_H