KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pad_utils.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20#pragma once
21
22#include <functional>
23
24#include <wx/string.h>
25
26#include <layer_ids.h>
27
28class PAD;
29class PADSTACK;
30class UNITS_PROVIDER;
31
32enum class PAD_ATTRIB;
33
34
35namespace PAD_UTILS
36{
37
42bool PadHasMeaningfulRoundingRadius( const PAD& aPad, PCB_LAYER_ID aLayer );
43
44
50double GetDefaultIpcRoundingRatio( const PAD& aPad, PCB_LAYER_ID aLayer );
51
52
57void RemoveAllDrillsFromPadstack( PADSTACK& aPadstack );
58
59
67wxString GetPadAttributeString( PAD_ATTRIB aAttrib );
68
116
117
126
127
128using PAD_CHECK_HANDLER = std::function<void( const PAD_CHECK_RESULT& )>;
129
130
143void CheckPad( const PAD& aPad, const UNITS_PROVIDER& aUnitsProvider, bool aForPadProperties,
144 const PAD_CHECK_HANDLER& aErrorHandler );
145
146} // namespace PAD_UTILS
A PADSTACK defines the characteristics of a single or multi-layer pad, in the IPC sense of the word.
Definition padstack.h:161
Definition pad.h:61
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:56
wxString GetPadAttributeString(PAD_ATTRIB aAttrib)
Get the human-readable string for a pad attribute.
Definition pad_utils.cpp:68
bool PadHasMeaningfulRoundingRadius(const PAD &aPad, PCB_LAYER_ID aLayer)
Returns true if the pad's rounding ratio is valid (i.e.
Definition pad_utils.cpp:51
void RemoveAllDrillsFromPadstack(PADSTACK &aPadstack)
Remove the primary drill, the secondary and tertiary drills, and any post-machining operations from a...
Definition pad_utils.cpp:58
double GetDefaultIpcRoundingRatio(const PAD &aPad, PCB_LAYER_ID aLayer)
Get a sensible default for a rounded rectangle pad's rounding ratio.
Definition pad_utils.cpp:37
void CheckPad(const PAD &aPad, const UNITS_PROVIDER &aUnitsProvider, bool aForPadProperties, const PAD_CHECK_HANDLER &aErrorHandler)
Run non-board-specific checks on a pad.
std::function< void(const PAD_CHECK_RESULT &)> PAD_CHECK_HANDLER
Definition pad_utils.h:128
PAD_CHECK_CODE
A specific pad check finding reason.
Definition pad_utils.h:82
PAD_ATTRIB
The set of pad shapes, used with PAD::{Set,Get}Attribute().
Definition padstack.h:98
A single finding from CheckPad().
Definition pad_utils.h:122