KiCad PCB EDA Suite
Loading...
Searching...
No Matches
drc_re_permitted_layers_constraint_data.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 (C) 2024 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#ifndef DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA_H_
21#define DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA_H_
22
24
25
27{
28public:
30
32 const DRC_RE_BASE_CONSTRAINT_DATA& aBaseData ) :
34 {
35 }
36
37 explicit DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA( int aId, const wxString& aRuleName, bool aTopLayer,
38 bool aBottomLayer ) :
39 DRC_RE_BASE_CONSTRAINT_DATA( aId, aRuleName ),
40 m_topLayer( aTopLayer ),
41 m_bottomLayer( aBottomLayer )
42 {
43 }
44
46
48
49 std::vector<DRC_RE_FIELD_POSITION> GetFieldPositions() const override
50 {
51 // Positions measured from constraint_permitted_layers.png (~300x170)
52 // Format: { xStart, xEnd, yCenter }
53 return {
54 { 150, 365, 52, _( "Allow top Layer" ), LABEL_POSITION::RIGHT,
55 _( "Allow matched items on the front copper layer" ) }, // top layer checkbox (upper left)
56 { 150, 365, 212, _( "Allow bottom Layer" ), LABEL_POSITION::RIGHT,
57 _( "Allow matched items on the back copper layer" ) }, // bot layer checkbox (lower left)
58 };
59 }
60
61 std::vector<wxString> GetConstraintClauses( const RULE_GENERATION_CONTEXT& aContext ) const override
62 {
63 wxArrayString terms;
64
65 if( m_topLayer )
66 terms.Add( wxS( "A.Layer == 'F.Cu'" ) );
67
68 if( m_bottomLayer )
69 terms.Add( wxS( "A.Layer == 'B.Cu'" ) );
70
71 if( terms.IsEmpty() )
72 return {};
73
74 wxString expr = wxJoin( terms, '|' );
75 expr.Replace( wxS( "|" ), wxS( " || " ) );
76
77 return { wxString::Format( wxS( "(constraint assertion \"%s\")" ), expr ) };
78 }
79
80 wxString GenerateRule( const RULE_GENERATION_CONTEXT& aContext ) override
81 {
82 return buildRule( aContext, GetConstraintClauses( aContext ) );
83 }
84
85 VALIDATION_RESULT Validate() const override
86 {
88
89 if( !m_topLayer && !m_bottomLayer )
90 result.AddError( _( "At least one layer must be selected" ) );
91
92 return result;
93 }
94
95 bool GetTopLayerEnabled() { return m_topLayer; }
96
97 void SetTopLayerEnabled( bool aTopLayer ) { m_topLayer = aTopLayer; }
98
100
101 void SetBottomLayerEnabled( bool aBottomLayer ) { m_bottomLayer = aBottomLayer; }
102
103 void CopyFrom( const ICopyable& aSource ) override
104 {
105 const auto& source =
106 dynamic_cast<const DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA&>( aSource );
107
109
110 m_topLayer = source.m_topLayer;
111 m_bottomLayer = source.m_bottomLayer;
112 }
113
114private:
115 bool m_topLayer{ false };
116 bool m_bottomLayer{ false };
117};
118
119#endif // DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA_H_
BITMAPS
A list of all bitmap identifiers.
@ constraint_permitted_layers
wxString buildRule(const RULE_GENERATION_CONTEXT &aContext, const std::vector< wxString > &aConstraintClauses) const
void CopyFrom(const ICopyable &aSource) override
std::vector< wxString > GetConstraintClauses(const RULE_GENERATION_CONTEXT &aContext) const override
Returns just the constraint clauses without the rule wrapper.
std::vector< DRC_RE_FIELD_POSITION > GetFieldPositions() const override
Returns the field positions for controls overlaid on the constraint bitmap.
virtual ~DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA()=default
BITMAPS GetOverlayBitmap() const override
Returns the bitmap to use for the overlay panel background.
wxString GenerateRule(const RULE_GENERATION_CONTEXT &aContext) override
DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA(const DRC_RE_BASE_CONSTRAINT_DATA &aBaseData)
VALIDATION_RESULT Validate() const override
Validates the constraint data.
DRC_RE_PERMITTED_LAYERS_CONSTRAINT_DATA(int aId, const wxString &aRuleName, bool aTopLayer, bool aBottomLayer)
Abstract interface class to enable polymorphic copying between objects.
@ RIGHT
Label to the right of the field.
#define _(s)
std::string source
Result of a validation operation.
wxString result
Test unit parsing edge cases and error handling.