KiCad PCB EDA Suite
drc_rule_condition.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) 2020 KiCad Developers, see change_log.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, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #ifndef DRC_RULE_CONDITION_H
25 #define DRC_RULE_CONDITION_H
26 
27 #include <core/typeinfo.h>
29 
30 class BOARD_ITEM;
31 class PCB_EXPR_UCODE;
32 class REPORTER;
33 
34 
36 {
37 public:
38  DRC_RULE_CONDITION( const wxString& aExpression = "" );
40 
41  bool EvaluateFor( const BOARD_ITEM* aItemA, const BOARD_ITEM* aItemB, PCB_LAYER_ID aLayer,
42  REPORTER* aReporter = nullptr );
43 
44  bool Compile( REPORTER* aReporter, int aSourceLine = 0, int aSourceOffset = 0 );
45 
46  void SetExpression( const wxString& aExpression ) { m_expression = aExpression; }
47  wxString GetExpression() const { return m_expression; }
48 
49 private:
50  wxString m_expression;
51  std::unique_ptr<PCB_EXPR_UCODE> m_ucode;
52 };
53 
54 
55 #endif // DRC_RULE_CONDITION_H
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:82
void SetExpression(const wxString &aExpression)
DRC_RULE_CONDITION(const wxString &aExpression="")
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:64
wxString GetExpression() const
PCB_LAYER_ID
A quick note on layer IDs:
std::unique_ptr< PCB_EXPR_UCODE > m_ucode
bool EvaluateFor(const BOARD_ITEM *aItemA, const BOARD_ITEM *aItemB, PCB_LAYER_ID aLayer, REPORTER *aReporter=nullptr)
Board layer functions and definitions.
bool Compile(REPORTER *aReporter, int aSourceLine=0, int aSourceOffset=0)