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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/*
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"
// "Pin" is a base class for "CompElement" and "Element".
// A component's spatial layout (or "Footprint") is a two-dimensional array of "CompElement" objects.
// The "Board" object used for designing a circuit is a two-dimensional array of "Element" objects.
//
// There are 4 parts to the description of a "Pin":
//
// 1) The pin character "m_pinChar" is just a pinIndex in the range 0 to 254.
// Places with no pin (e.g. the middle of a resistor) have m_pinChar of 255 and an invalid pinIndex.
//
// 2) The surface occupancy "m_surface" models the interaction between a component and the board surface.
//
// SURFACE_FREE ==> the board surface is not occupied.
// SURFACE_GAP ==> the gap between IC pins.
// SURFACE_WIRE_END ==> a wire (endpoint).
// SURFACE_WIRE ==> a wire (not endpoint).
// SURFACE_PLUG ==> e.g. resistor/diode/pad etc. Can be placed in a "GAP".
// SURFACE_FULL ==> the board surface is fully occupied. Nothing else can be placed there.
// SURFACE_NOPAINT ==> If this bit is set, then no paint can be applied.
// SURFACE_HOLE ==> SURFACE_FULL + SURFACE_NOPAINT
//
// 3) The hole occupancy "m_holeUse" models the interaction between a component and the board holes.
//
// HOLE_FREE ==> the hole is not occupied.
// HOLE_WIRE ==> the hole is occupied by one wire.
// HOLE_FULL ==> the hole is fully occupied. (By a regular component pin, or by 2 wires).
//
// 4) SOIC bitfield. We store this info on the base layer of the grid, but it refers to whatever
// layer displays the SOIC pattern (i.e. "the SOIC layer").
//
// SOIC_FREE ==> No pads and no SOIC pattern.
// SOIC_PATTERN ==> No pads but have SOIC pattern (so point is not paintable on the SOIC layer).
// SOIC_THL ==> One through-hole component or wire. Regular components/wires use this with their pins.
// SOIC_THL_2 ==> Two through-hole components (i.e. wires sharing a hole on the board).
// SOIC_PAD ==> SOIC pad and no SOIC pattern. SOIC components use this with their pins.
// SOIC_FULL ==> Cannot place any more parts at the location.
Q_DECL_CONSTEXPR static const uchar BAD_PINCHAR = 255;
Q_DECL_CONSTEXPR static const size_t BAD_PININDEX = static_cast<size_t>(-1);
Q_DECL_CONSTEXPR static const uchar SURFACE_FREE = 0;
Q_DECL_CONSTEXPR static const uchar SURFACE_GAP = 1;
Q_DECL_CONSTEXPR static const uchar SURFACE_WIRE_END = 2; // Hence: "SURFACE_WIRE_END + SURFACE_WIRE_END == SURFACE_WIRE"
Q_DECL_CONSTEXPR static const uchar SURFACE_WIRE = 4; // Hence: "SURFACE_WIRE + SURFACE_WIRE == SURFACE_PLUG"
Q_DECL_CONSTEXPR static const uchar SURFACE_PLUG = 8;
Q_DECL_CONSTEXPR static const uchar SURFACE_FULL = 9; // Hence: "SURFACE_PLUG + SURFACE_GAP == SURFACE_FULL"
Q_DECL_CONSTEXPR static const uchar SURFACE_NOPAINT = 16; // Should only be used as part of SURFACE_HOLE
Q_DECL_CONSTEXPR static const uchar SURFACE_HOLE = 25; // Hence: "SURFACE_FULL + SURFACE_NOPAINT = SURFACE_HOLE"
Q_DECL_CONSTEXPR static const uchar HOLE_FREE = 0;
Q_DECL_CONSTEXPR static const uchar HOLE_WIRE = 1; // Hence: "HOLE_WIRE + HOLE_WIRE == HOLE_FULL"
Q_DECL_CONSTEXPR static const uchar HOLE_FULL = 2;
Q_DECL_CONSTEXPR static const uchar SOIC_FREE = 0; // Free space
Q_DECL_CONSTEXPR static const uchar SOIC_TRACKS_TOP = 1; // Pattern of SOIC tracks on top layer
Q_DECL_CONSTEXPR static const uchar SOIC_TRACKS_BOT = 2; // Pattern of SOIC tracks on top layer
Q_DECL_CONSTEXPR static const uchar SOIC_THL_COMP = 4; // A through-hole component pin (not a wire)
Q_DECL_CONSTEXPR static const uchar SOIC_THL_WIRE = 8; // A wire end
Q_DECL_CONSTEXPR static const uchar SOIC_THL_WIRES = 16; // 2 wire-ends sharing a hole
Q_DECL_CONSTEXPR static const uchar SOIC_THL = SOIC_THL_COMP | SOIC_THL_WIRE | SOIC_THL_WIRES;
Q_DECL_CONSTEXPR static const uchar SOIC_PAD = 32; // An SOIC pad
Q_DECL_CONSTEXPR static const uchar SOIC_FULL = SOIC_PAD | SOIC_THL_COMP; // Hence can handle at most (1xSOIC_THL_COMP + 1xSOIC_PAD) not (2xSOIC_PADs). (2xSOIC_THL_COMP is blocked by the SURFACE and HOLE info).
Q_DECL_CONSTEXPR static size_t GetPinIndexFromLegacyPinChar(uchar c) // Legacy VRT format had messy mapping of pinChar to pinIndex
{
return ( c < '1' ) ? BAD_PININDEX // Handles the '.', '-', '+' characters used by GetMakeInstructions()
: ( c <= '9' ) ? ( c - '1') // Char '1' to '9' ==> Index 0 to 8
: ( c <= '@' ) ? (61 + c - ':') // Char ':' to '@' ==> Index 61 to 67
: ( c <= 'Z' ) ? (9 + c - 'A') // Char 'A' to 'Z' ==> Index 9 to 34
: ( c <= '`' ) ? (68 + c - '[') // Char '[' to '`' ==> Index 68 to 73
: ( c <= 'z' ) ? (35 + c - 'a') // Char 'a' to 'z' ==> Index 35 to 60
: (74 + c - '{'); // Char '{' to 255 ==> Index 74 to 206
}
static uchar GetSurfaceFromLegacySurfaceChar(uchar c)
{
// The following are the old SURFACE codes before the introduction of SURFACE_WIRE_END and SURFACE_WIRE
switch( c )
{
case 0: return SURFACE_FREE;
case 1: return SURFACE_GAP;
case 2: return SURFACE_PLUG;
case 3: return SURFACE_FULL;
case 4: return SURFACE_NOPAINT;
case 7: return SURFACE_HOLE;
default: assert(0); return SURFACE_FREE;
}
}
class Pin : public Persist, public Merge
{
public:
Pin(uchar pinChar = BAD_PINCHAR, uchar surface = SURFACE_FREE, uchar holeUse = HOLE_FREE, uchar soicChar = SOIC_FREE)
: m_pinChar(pinChar)
, m_surface(surface)
, m_holeUse(holeUse)
, m_soicChar(soicChar)
{}
Pin(const Pin& o) { *this = o; }
virtual ~Pin() {}
Pin& operator=(const Pin& o)
{
m_pinChar = o.m_pinChar;
m_surface = o.m_surface;
m_holeUse = o.m_holeUse;
m_soicChar = o.m_soicChar;
return *this;
}
bool operator==(const Pin& o) const // Compare persisted info
{
return m_pinChar == o.m_pinChar
&& m_surface == o.m_surface
&& m_holeUse == o.m_holeUse
&& m_soicChar == o.m_soicChar;
}
bool operator!=(const Pin& o) const
{
return !(*this == o);
}
void SetPinIndex(size_t i) { m_pinChar = ( i >= BAD_PINCHAR ) ? BAD_PINCHAR : static_cast<uchar> (i); }
void SetSurface(uchar c) { m_surface = c; }
void SetHoleUse(uchar c) { m_holeUse = c; }
void SetSoicChar(uchar c) { m_soicChar = c; }
void SetOccupancyTH(bool bWire) // Helper for TH components
{
if ( bWire )
{
SetSurface( GetIsPin() ? SURFACE_WIRE_END : SURFACE_WIRE ); // Set surface occupancy for pins/non-pins
SetHoleUse( GetIsPin() ? HOLE_WIRE : HOLE_FREE ); // Set hole occupancy for pins/non-pins
SetSoicChar( GetIsPin() ? SOIC_THL_WIRE : SOIC_FREE ); // Set SOIC code for pins/non-pins
}
else
{
SetHoleUse( GetIsPin() ? HOLE_FULL : HOLE_FREE ); // Set hole occupancy for pins/non-pins
SetSoicChar( GetIsPin() ? SOIC_THL_COMP : SOIC_FREE ); // Set SOIC code for pins/non-pins
}
}
void SetOccupancySOIC() // Helper for SOIC components
{
SetHoleUse(HOLE_FREE);
if ( GetIsPin() )
{
SetSurface(SURFACE_FREE);
SetSoicChar(SOIC_PAD);
}
}
size_t GetPinIndex() const { return ( m_pinChar == BAD_PINCHAR ) ? BAD_PININDEX : m_pinChar; }
const uchar& GetSurface() const { return m_surface; }
const uchar& GetHoleUse() const { return m_holeUse; }
const uchar& GetSoicChar() const { return m_soicChar; }
bool GetIsPin() const { return m_pinChar != BAD_PINCHAR; }
bool GetIsHole() const { return m_surface == SURFACE_HOLE; }
static const std::map<uchar, std::string>& GetMapSurfaceStrings()
{
static std::map<uchar, std::string> mapSurfaceToStr; // Mapping of SURFACE to strings for Component Editor
if ( mapSurfaceToStr.empty() )
{
mapSurfaceToStr[SURFACE_FULL] = "Full";
mapSurfaceToStr[SURFACE_FREE] = "Free";
mapSurfaceToStr[SURFACE_HOLE] = "Hole";
}
return mapSurfaceToStr;
}
static const std::list<std::string>& GetListSurfaceStrings()
{
static std::list<std::string> listSurfaceStr; // Use for populating combo boxes in Component Editor
if ( listSurfaceStr.empty() )
{
listSurfaceStr.push_back("Full");
listSurfaceStr.push_back("Free");
listSurfaceStr.push_back("Hole");
}
return listSurfaceStr;
}
// Merge interface functions
virtual void UpdateMergeOffsets(MergeOffsets&) override {}
virtual void ApplyMergeOffsets(const MergeOffsets&) override {}
void Merge(const Pin& o) { *this = o; }
// Persist interface functions
virtual void Load(DataStream& inStream) override
{
inStream.Load(m_pinChar);
inStream.Load(m_surface);
if ( inStream.GetVersion() < VRT_VERSION_4 ) // Remap m_pinChar if file is older than VRT_VERSION_4
SetPinIndex( GetPinIndexFromLegacyPinChar(m_pinChar) );
if ( inStream.GetVersion() < VRT_VERSION_26 ) // Remap m_surface if file is older than VRT_VERSION_26
SetSurface( GetSurfaceFromLegacySurfaceChar(m_surface) );
m_holeUse = GetIsPin() ? HOLE_FULL : HOLE_FREE;
if ( inStream.GetVersion() >= VRT_VERSION_26 )
inStream.Load(m_holeUse); // Added in VRT_VERSION_26
if ( inStream.GetVersion() <= VRT_VERSION_39 )
if ( GetIsPin() && m_holeUse == HOLE_FREE ) m_holeUse = HOLE_FULL; // Bug-fix non-wire hole-use
m_soicChar = SOIC_FREE; // Can't set a default for all legacy cases here. Need to handle things in Component::Load() and Board::Load()
if ( inStream.GetVersion() >= VRT_VERSION_55 )
inStream.Load(m_soicChar); // Added in VRT_VERSION_55
}
virtual void Save(DataStream& outStream) override
{
outStream.Save(m_pinChar); // New mapping from VRT_VERSION_4
outStream.Save(m_surface); // New mapping from VRT_VERSION_26
outStream.Save(m_holeUse); // Added in VRT_VERSION_26
outStream.Save(m_soicChar); // Added in VRT_VERSION_55
}
private:
// Data
uchar m_pinChar;
uchar m_surface;
uchar m_holeUse;
uchar m_soicChar;
};
|
