KiCad PCB EDA Suite
drc_provider.cpp
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) 2018 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, 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 #include <drc/drc_provider.h>
25 
26 
27 DRC_PROVIDER::DRC_PROVIDER( const DRC_MARKER_FACTORY& aMarkerMaker, MARKER_HANDLER aMarkerHandler )
28  : m_marker_factory( aMarkerMaker ), m_marker_handler( aMarkerHandler )
29 {
30 }
31 
32 
34 {
35  return m_marker_factory;
36 }
37 
38 
39 void DRC_PROVIDER::HandleMarker( std::unique_ptr<MARKER_PCB> aMarker ) const
40 {
41  // The marker hander currently takes a raw pointer,
42  // but it also assumes ownership
43  m_marker_handler( aMarker.release() );
44 }
const DRC_MARKER_FACTORY & GetMarkerFactory() const
Access to the stored reference to a marker constructor.
void HandleMarker(std::unique_ptr< MARKER_PCB > aMarker) const
Pass a given marker to the marker handler.
MARKER_HANDLER m_marker_handler
The handler for any generated markers.
Definition: drc_provider.h:81
Class that constructs DRC markers of various kinds with messages according to items and error code.
DRC_PROVIDER(const DRC_MARKER_FACTORY &aMarkerMaker, MARKER_HANDLER aMarkerHandler)
const DRC_MARKER_FACTORY & m_marker_factory
A marker generator to make markers in the right context.
Definition: drc_provider.h:78
std::function< void(MARKER_PCB *)> MARKER_HANDLER
A callable that can handle a single generated PCB_MARKER.
Definition: drc_provider.h:46