erc.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2009 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef ERC_H
#define ERC_H
 
#include <erc/erc_settings.h>
#include <sch_sheet_path.h>
#include <sch_screen.h>
#include <sch_reference_list.h>
#include <connection_graph.h>
#include <vector>
#include <map>
 
 
class SCHEMATIC;
class DS_PROXY_VIEW_ITEM;
class SCH_EDIT_FRAME;
class PROGRESS_REPORTER;
struct KIFACE;
class PROJECT;
class SCH_RULE_AREA;
 
 
extern const wxString CommentERC_H[];
extern const wxString CommentERC_V[];
 
 
namespace SCH_CONNECTIVITY
{
struct MULTI_UNIT_GROUP;
}

class ERC_TESTER
{
public:
 
    ERC_TESTER( SCHEMATIC* aSchematic, bool aShowAllErrors = false );

    int TestDuplicateSheetNames( bool aCreateMarker );

    int TestPinMap( KIFACE* aCvPcb, PROJECT* aProject );

    void TestTextVars( DS_PROXY_VIEW_ITEM* aDrawingSheet );

    int TestFieldNameWhitespace();

    int TestEmptyLabelNames();

    int TestMultiunitFootprints();

    int TestNoConnectPins();

    int TestPinToPin();

    int TestMultUnitPinConflicts();

    int TestDuplicatePinNets();
 
    // Report enabled checks over owned published connectivity without preparing symbol checks.
    static int TestConnectivity( SCHEMATIC& aSchematic );

    int TestGroundPins();

    int TestStackedPinNotation();

    int TestSameLocalGlobalLabel();

    int TestSimilarLabels();

    int TestFourWayJunction();

    int TestLabelMultipleWires();

    int TestLibSymbolIssues();

    int TestFootprintLinkIssues( KIFACE* aCvPcb, PROJECT* aProject );

    int TestFootprintFilters();

    int TestOffGridEndpoints();

    int TestSimModelIssues();

    int TestMissingUnits();

    int TestMissingNetclasses();

    int TestVariantSymbols();
 
    void RunTests( DS_PROXY_VIEW_ITEM* aDrawingSheet, SCH_EDIT_FRAME* aEditFrame,
                   KIFACE* aCvPcb, PROJECT* aProject, PROGRESS_REPORTER* aProgressReporter );
 
private:
    std::vector<SCH_CONNECTIVITY::MULTI_UNIT_GROUP> multiUnitSources() const;
 
    SCHEMATIC*                   m_schematic;
    ERC_SETTINGS&                m_settings;
    SCH_SHEET_LIST               m_sheetList;
    SCH_SCREENS                  m_screens;
    SCH_MULTI_UNIT_REFERENCE_MAP m_refMap;
    const NET_MAP&               m_nets;
    bool                         m_showAllErrors;
};
 
 
#endif  // ERC_H