1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
88
89
90
91
92
93
94
95
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/*
VeroRoute - Qt based Veroboard/Perfboard/PCB layout & routing application.
Copyright (C) 2017 Alex Lawrow ( dralx@users.sourceforge.net )
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/>.
*/
#pragma once
#include "Persist.h"
// A "TrackElement" object provides a local description of the track pattern at a grid point.
// It stores the node ID at a grid point, along with an 8-bit code describing the
// connections to the 8 surrounding points.
// This connection code solves the "competing diagonals" problem.
// So if there are 4 grid points painted with two node IDs (A and B) as follows
// A B
// B A
// then setting the code appropriately at each point will allow
// a single diagonal connection to exist, either (A-A) or (B-B).
Q_DECL_CONSTEXPR static const int NUM_NBRS = 9; // (NBR_L to NBR_LB) + NBR_X
// Indexes for the 8 neighbour elements in the same layer, starting on the left and going clockwise
Q_DECL_CONSTEXPR static const int NBR_L(0), NBR_LT(1), NBR_T(2), NBR_RT(3), // Left, Left-Top, Top, Right-Top,
NBR_R(4), NBR_RB(5), NBR_B(6), NBR_LB(7); // Right, Right-Bottom, Bottom, Left-Bottom
Q_DECL_CONSTEXPR static const int NBR_X(8); // Index for the neighbour element in the layer above/below
Q_DECL_CONSTEXPR static inline int Opposite(int NBR) // Helper to get opposite neighbour index
{
return ( NBR == NBR_X ) ? NBR_X : ( ( NBR + 4 ) % 8 );
}
// Functions for mapping NBR indices to "code bits" and manipulating them
Q_DECL_CONSTEXPR static inline bool ReadCodeBit(int NBR, int iCode) { return ( iCode & (1<<NBR) ) != 0; }
static inline void SetCodeBit(int NBR, int& iCode) { iCode |= (1<<NBR); }
static inline void ClearCodeBit(int NBR, int& iCode) { iCode &= ~(1<<NBR); }
static inline void ToggleCodeBit(int NBR, int& iCode) { iCode ^= (1<<NBR); }
Q_DECL_CONSTEXPR static const int CODEBITS_DIAGS = 0xAA; // All diagonal neighbours in same layer
Q_DECL_CONSTEXPR static const int CODEBITS_LYR = 0xFF; // All neighbours in same layer
Q_DECL_CONSTEXPR static const int CODEBITS_ALL = 0x1FF; // All neighbours in same layer + the neighbour in the layer above/below
// Flag is a bitfield describing the status of the nodeId at point.
// USERSET points will not have their nodeId modified during the auto-routing.
// The algorithm will change the flag from USERSET to AUTOKEPT if it thinks the point is useful.
// On hitting "Tidy", only AUTOKEPT and AUTOSET points are kept, and any USERSET
// points will be wiped (if they are not component pins).
Q_DECL_CONSTEXPR static const char USERSET = 1; // ==> user assigned the nodeId
Q_DECL_CONSTEXPR static const char AUTOSET = 2; // ==> routing algorithm assigned the nodeId
Q_DECL_CONSTEXPR static const char AUTOKEPT = (USERSET | AUTOSET); // ==> user assigned the nodeId, and routing algorithm agrees it is useful
Q_DECL_CONSTEXPR static const char VEROSET = 4; // ==> auto assigned to create Vero strips
Q_DECL_CONSTEXPR static const char RECTSET = 8; // ==> is within a user-defined rect
Q_DECL_CONSTEXPR static const int BAD_NODEID = 0; // Invalid node ID (i.e. netlist ID)
class TrackElement : public Persist, public Merge
{
friend class Element;
public:
TrackElement() {}
TrackElement(const TrackElement& o) { *this = o; }
virtual ~TrackElement() {}
TrackElement& operator=(const TrackElement& o)
{
m_nodeId = o.m_nodeId;
m_iCode = o.m_iCode;
m_flag = o.m_flag;
return *this;
}
bool operator==(const TrackElement& o) const // Compare persisted info
{
return m_nodeId == o.m_nodeId
&& m_iCode == o.m_iCode
&& m_flag == o.m_flag;
}
bool operator!=(const TrackElement& o) const
{
return !(*this == o);
}
void SetNodeId(int i) { m_nodeId = i; }
void SetCode(int i) { m_iCode = i; }
void SetFlag(char i) { m_flag = i; }
const int& GetNodeId() const { return m_nodeId; }
const int& GetCode() const { return m_iCode; }
const char& GetFlag() const { return m_flag; }
// Connectivity helpers
void SetUsed(int iNbr, bool b) { if ( b ) SetCodeBit(iNbr, m_iCode); else ClearCodeBit(iNbr, m_iCode); }
bool GetUsed(int iNbr) const { return ReadCodeBit(iNbr, m_iCode); }
bool IsClash(int nodeId) const { return nodeId != BAD_NODEID && m_nodeId != BAD_NODEID && nodeId != m_nodeId; }
int GetPerimeterCode(bool bDiagsOK, bool bMinDiags) const // Helper for the GUI "blobs"
{
int iCode = GetCode() & CODEBITS_LYR; // Take a copy of the connection code, and restrict to same-layer neighbours
// Enforce any restrictions on diagonal connections acccording to the GUI options on diagonals
const bool bL( ReadCodeBit(NBR_L, iCode) ), bT( ReadCodeBit(NBR_T, iCode) ),
bR( ReadCodeBit(NBR_R, iCode) ), bB( ReadCodeBit(NBR_B, iCode) );
if ( ( !bDiagsOK && !(bL && bT) ) || ( bMinDiags && (bL != bT) ) ) ClearCodeBit(NBR_LT, iCode);
if ( ( !bDiagsOK && !(bR && bT) ) || ( bMinDiags && (bR != bT) ) ) ClearCodeBit(NBR_RT, iCode);
if ( ( !bDiagsOK && !(bL && bB) ) || ( bMinDiags && (bL != bB) ) ) ClearCodeBit(NBR_LB, iCode);
if ( ( !bDiagsOK && !(bR && bB) ) || ( bMinDiags && (bR != bB) ) ) ClearCodeBit(NBR_RB, iCode);
return iCode;
}
// Flag Helpers
bool ReadFlagBits(char i) const { return ( m_flag & i ) != 0; }
void MarkFlagBits(char i) { m_flag |= i; }
void WipeFlagBits(char i) { m_flag &= ~i; }
// Merge interface functions
virtual void UpdateMergeOffsets(MergeOffsets& o) override
{
if ( m_nodeId != BAD_NODEID ) o.deltaNodeId = std::max(o.deltaNodeId, m_nodeId + 1);
}
virtual void ApplyMergeOffsets(const MergeOffsets& o) override
{
if ( m_nodeId != BAD_NODEID ) m_nodeId += o.deltaNodeId;
}
void Merge(const TrackElement& o) { *this = o; }
// Persist interface functions
virtual void Load(DataStream& inStream) override
{
inStream.Load(m_nodeId);
inStream.Load(m_iCode);
inStream.Load(m_flag);
if ( inStream.GetVersion() < VRT_VERSION_11 )
ConvertLegacyFlag();
}
virtual void Save(DataStream& outStream) override
{
outStream.Save(m_nodeId);
outStream.Save(m_iCode);
outStream.Save(m_flag);
}
private:
void ConvertLegacyFlag() // Map legacy flag values to new bitfield based values
{
switch( m_flag )
{
case 0: m_flag = USERSET; break;
case 1: m_flag = AUTOKEPT; break;
case 2: m_flag = AUTOSET; break;
case 3: m_flag = VEROSET; break;
default: assert(0);
}
}
private:
int m_nodeId = BAD_NODEID; // The netlist value assigned to the element (or BAD_NODEID if not set)
int m_iCode = 0; // An 8-bit code describing connections to the 8 same-layer neighbours. Bit set ==> connection used
char m_flag = USERSET; // For routing: USERSET/AUTOKEPT/AUTOSET/VEROSET/RECTSET
};
|
