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
|
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
*
* 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 2
* 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef ARRAY_AXIS__H
#define ARRAY_AXIS__H
#include <kicommon.h>
#include <optional>
#include <wx/string.h>
/**
* Class that contains information about a single array axis and the numbering
* of items along that axis.
*
* For example, a rectangular grid has two axes, X and Y, but a circular array
* has only one, that runs around the circle.
*/
class KICOMMON_API ARRAY_AXIS
{
public:
enum NUMBERING_TYPE
{
NUMBERING_NUMERIC = 0, ///< Arabic numerals: 0,1,2,3,4,5,6,7,8,9,10,11...
NUMBERING_HEX,
/**
* Alphabet, excluding IOSQXZ
*
* Per ASME Y14.35M-1997 sec. 5.2 (previously MIL-STD-100 sec. 406.5) as these can be
* confused with numerals and are often not used for pin numbering on BGAs, etc.
*/
NUMBERING_ALPHA_NO_IOSQXZ,
NUMBERING_ALPHA_FULL, ///< Full 26-character alphabet
};
/**
* Check if a numbering type is a numeric type.
*/
static bool TypeIsNumeric( NUMBERING_TYPE type )
{
return type == NUMBERING_NUMERIC || type == NUMBERING_HEX;
};
ARRAY_AXIS();
/**
* Get the alphabet for the current numbering scheme.
* @param type the numbering scheme.
* @return the alphabet (as a string).
*/
const wxString& GetAlphabet() const;
/**
* Set the axis numbering type.
*/
void SetAxisType( NUMBERING_TYPE aType );
/**
* Set the axis start (as a string, which should decode to a valid index
* in the alphabet),
*/
bool SetOffset( const wxString& aOffsetName );
/**
* Set the start offset for the series (e.g. 0 to start at 0/A, 4 to start
* at 4/E).
*
* @param aOffset offset of the first item in the.
*/
void SetOffset( int aOffset );
/**
* Get the numbering offset for the axis
*
* @return the current offset.
*/
int GetOffset() const;
/**
* Set the skip between consecutive numbers (useful when doing a partial
* array, e.g. only one side of a connector).
*/
void SetStep( int aStep );
/**
* Get the position number (name) for the n'th axis point
*
* @param n array point index, from 0.
* @return the point's name.
*/
wxString GetItemNumber( int n ) const;
private:
/**
* Get the numbering offset for a given numbering string
*
* @param str is a numbering string, say "B" or "5".
* @return the offset, if found, else empty.
*/
std::optional<int> getNumberingOffset( const wxString& str ) const;
NUMBERING_TYPE m_type;
int m_offset;
/// Skip every 'n' numbers.
int m_step;
};
#endif // ARRAY_AXIS__H
|
