pns_routing_settings.h 5.66 KB
Newer Older
1 2 3
/*
 * KiRouter - a push-and-(sometimes-)shove PCB router
 *
4
 * Copyright (C) 2013-2014 CERN
5
 * Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
6
 *
7 8 9 10
 * 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.
11
 *
12 13 14 15
 * 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.
16
 *
17
 * You should have received a copy of the GNU General Public License along
18
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
19
 */
20

21 22
#ifndef __PNS_ROUTING_SETTINGS
#define __PNS_ROUTING_SETTINGS
23

24
#include "time_limit.h"
25 26

class DIRECTION_45;
27
 
28
///> Routing modes
29 30
enum PNS_MODE
{
31 32 33 34
    RM_MarkObstacles = 0,   ///> Ignore collisions, mark obstacles
    RM_Shove,               ///> Only shove
    RM_Walkaround,          ///> Only walkaround
    RM_Smart                ///> Guess what's better, try to make least mess on the PCB
35 36
};

37 38 39
///> Optimization effort
enum PNS_OPTIMIZATION_EFFORT 
{
40 41 42
    OE_LOW = 0,             
    OE_MEDIUM = 1,
    OE_FULL = 2
43 44 45 46 47 48 49 50
};

/**
 * Class PNS_ROUTING_SETTINGS
 *
 * Contains all persistent settings of the router, such as the mode, optimization effort, etc.
 */

51
class PNS_ROUTING_SETTINGS
52
{
53
public:
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
    PNS_ROUTING_SETTINGS();

    ///> Returns the routing mode.
    PNS_MODE Mode() const { return m_routingMode; }

    ///> Sets the routing mode.
    void SetMode( PNS_MODE aMode ) { m_routingMode = aMode; }
    
    ///> Returns the optimizer effort. Bigger means cleaner traces, but slower routing.
    PNS_OPTIMIZATION_EFFORT OptimizerEffort() const { return m_optimizerEffort; }
    
    ///> Sets the optimizer effort. Bigger means cleaner traces, but slower routing.
    void SetOptimizerEffort( PNS_OPTIMIZATION_EFFORT aEffort ) { m_optimizerEffort = aEffort; }
    
    ///> Returns true if shoving vias is enbled.
    bool ShoveVias() const { return m_shoveVias; }

    ///> Enables/disables shoving vias.
    void SetShoveVias( bool aShoveVias ) { m_shoveVias = aShoveVias; }
    
    ///> Returns true if loop (redundant track) removal is on.
    bool RemoveLoops() const { return m_removeLoops; }

    ///> Enables/disables loop (redundant track) removal.
    void SetRemoveLoops( bool aRemoveLoops ) { m_removeLoops = aRemoveLoops; }
    
    ///> Returns true if suggesting the finish of currently placed track is on.
    bool SuggestFinish() { return m_suggestFinish; }
    
    ///> Enables displaying suggestions for finishing the currently placed track.
    void SetSuggestFinish( bool aSuggestFinish ) { m_suggestFinish = aSuggestFinish; }
    
    ///> Returns true if Smart Pads (automatic neckdown) is enabled.
    bool SmartPads () const { return m_smartPads; }
88

89 90 91 92 93 94
    ///> Enables/disables Smart Pads (automatic neckdown).
    void SetSmartPads( bool aSmartPads ) { m_smartPads = aSmartPads; }
    
    ///> Returns true if follow mouse mode is active (permanently on for the moment).
    bool FollowMouse() const 
    { 
95
        return m_followMouse && !( Mode() == RM_MarkObstacles );
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
    }
    
    ///> Returns true if smoothing segments durign dragging is enabled.    
    bool SmoothDraggedSegments() const { return m_smoothDraggedSegments; }

    ///> Enables/disabled smoothing segments during dragging.
    void SetSmoothDraggedSegments( bool aSmooth ) { m_smoothDraggedSegments = aSmooth; }

    ///> Returns true if jumping over unmovable obstacles is on.
    bool JumpOverObstacles() const { return m_jumpOverObstacles; }

    ///> Enables/disables jumping over unmovable obstacles.    
    void SetJumpOverObstacles( bool aJumpOverObstacles ) { m_jumpOverObstacles = aJumpOverObstacles; }
    
    void SetStartDiagonal(bool aStartDiagonal) { m_startDiagonal = aStartDiagonal; }
	
    bool CanViolateDRC() const { return m_canViolateDRC; }
    void SetCanViolateDRC( bool aViolate ) { m_canViolateDRC = aViolate; }

	void SetTrackWidth( int aWidth ) { m_trackWidth = aWidth; }
    int GetTrackWidth() const { return m_trackWidth; }
    void SetViaDiameter( int aDiameter ) { m_viaDiameter = aDiameter; }
    int GetViaDiameter() const { return m_viaDiameter; }
    void SetViaDrill( int aDrill ) { m_viaDrill = aDrill; }
    int GetViaDrill() const { return m_viaDrill; }

122
    const DIRECTION_45 InitialDirection() const;
123 124 125 126 127 128 129

    int ShoveIterationLimit() const;
    TIME_LIMIT ShoveTimeLimit() const;

    int WalkaroundIterationLimit() const { return m_walkaroundIterationLimit; };
    TIME_LIMIT WalkaroundTimeLimit() const;

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
    void SetLayerPair( int aLayer1, int aLayer2 )
    {
        if( aLayer1 > aLayer2 )
        {
            m_layerTop = aLayer1;
            m_layerBottom = aLayer2;
        }
        else
        {
            m_layerBottom = aLayer1;
            m_layerTop = aLayer2;
        }
    }

    int GetLayerTop() const { return m_layerTop; }
    int GetLayerBottom() const { return m_layerBottom; }

147 148 149
private:
    bool m_shoveVias;
    bool m_startDiagonal;
150 151
    bool m_removeLoops;
    bool m_smartPads;
152
    bool m_suggestFinish;
153
    bool m_followMouse;
154 155 156
    bool m_jumpOverObstacles;
    bool m_smoothDraggedSegments;
    bool m_canViolateDRC;
157

158 159 160 161
    PNS_MODE m_routingMode;
    PNS_OPTIMIZATION_EFFORT m_optimizerEffort;
    
    int m_trackWidth;
162 163
    int m_viaDiameter;
    int m_viaDrill;
164

165 166 167
    int m_preferredLayer;
    int m_walkaroundIterationLimit;
    int m_shoveIterationLimit;
168 169
    TIME_LIMIT m_shoveTimeLimit;
    TIME_LIMIT m_walkaroundTimeLimit;
170 171 172 173

    // Routing layers pair
    int m_layerTop;
    int m_layerBottom;
174 175 176
};

#endif