board_netlist_updater.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2015 CERN
 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * 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 BOARD_NETLIST_UPDATER_H
#define BOARD_NETLIST_UPDATER_H
 
class BOARD;
class REPORTER;
class NETLIST;
class COMPONENT;
class FOOTPRINT;
class LIB_ID;
class NETINFO_ITEM;
class PAD;
class PCB_EDIT_FRAME;
class PCB_GROUP;
class PCBNEW_SETTINGS;
class TOOL_MANAGER;
 
#include <board_commit.h>

class BOARD_NETLIST_UPDATER
{
public:
    BOARD_NETLIST_UPDATER( PCB_EDIT_FRAME* aFrame, BOARD* aBoard );

    BOARD_NETLIST_UPDATER( TOOL_MANAGER* aToolManager, BOARD* aBoard );
    ~BOARD_NETLIST_UPDATER();

    bool UpdateNetlist( NETLIST& aNetlist );

    static bool fpidsEquivalent( const LIB_ID& aBoardFpid, const LIB_ID& aSchematicFpid );
 
    void SetReporter( REPORTER* aReporter ) { m_reporter = aReporter; }

    void SetIsDryRun( bool aEnabled ) { m_isDryRun = aEnabled; }
 
    void SetReplaceFootprints( bool aEnabled ) { m_replaceFootprints = aEnabled; }
 
    void SetTransferGroups( bool aEnabled ) { m_transferGroups = aEnabled; }
 
    void SetApplyDesignBlockLayouts( bool aEnabled ) { m_applyDesignBlockLayouts = aEnabled; }
 
    void SetOverrideLocks( bool aOverride ) { m_overrideLocks = aOverride; }
 
    void SetDeleteUnusedFootprints( bool aEnabled ) { m_deleteUnusedFootprints = aEnabled; }
 
    void SetLookupByTimestamp( bool aEnabled ) { m_lookupByTimestamp = aEnabled; }
 
    void SetUpdateFields( bool aEnabled ) { m_updateFields = aEnabled; }
 
    void SetRemoveExtraFields( bool aEnabled ) { m_removeExtraFields = aEnabled; }
 
    std::vector<FOOTPRINT*> GetAddedFootprints() const { return m_addedFootprints; }
 
    std::vector<PCB_GROUP*> GetAddedGroups() const { return m_addedGroups; }
 
    int GetErrorCount() const { return m_errorCount; }
 
    int GetWarningCount() const { return m_warningCount; }
 
    int GetNewFootprintCount() const { return m_newFootprintsCount; }

    static void ApplyChainAssignments( BOARD* aBoard, const NETLIST& aNetlist, REPORTER* aReporter,
                                       bool aDryRun );
 
private:
    void cacheNetname( PAD* aPad, const wxString& aNetname );
    wxString getNetname( PAD* aPad );
 
    void cachePinFunction( PAD* aPad, const wxString& aPinFunction );
    wxString getPinFunction( PAD* aPad );
 
    VECTOR2I estimateFootprintInsertionPosition();
 
    FOOTPRINT* addNewFootprint( COMPONENT* aComponent );
    FOOTPRINT* addNewFootprint( COMPONENT* aComponent, const LIB_ID& aFootprintId );
 
    FOOTPRINT* replaceFootprint( NETLIST& aNetlist, FOOTPRINT* aFootprint,
                                 COMPONENT* aNewComponent );
 
    bool updateFootprintParameters( FOOTPRINT* aFootprint, COMPONENT* aNetlistComponent );
 
    bool updateFootprintGroup( FOOTPRINT* aPcbFootprint, COMPONENT* aNetlistComponent );
 
    bool updateComponentPadConnections( FOOTPRINT* aFootprint, COMPONENT* aNewComponent );
 
    bool updateComponentClass( FOOTPRINT* aFootprint, COMPONENT* aNewComponent );
 
    bool updateComponentUnits( FOOTPRINT* aFootprint, COMPONENT* aNewComponent );
 
    void applyComponentVariants( COMPONENT* aComponent,
                                 const std::vector<FOOTPRINT*>& aFootprints,
                                 const LIB_ID& aBaseFpid );
 
    void cacheCopperZoneConnections();
 
    bool updateCopperZoneNets( NETLIST& aNetlist );
 
    bool updateGroups( NETLIST& aNetlist );
 
    bool testConnectivity( NETLIST& aNetlist, std::map<COMPONENT*, FOOTPRINT*>& aFootprintMap );
 
    PCB_EDIT_FRAME*  m_frame;
    PCBNEW_SETTINGS* m_settings;
    BOARD_COMMIT     m_commit;
    BOARD*           m_board;
    REPORTER*        m_reporter;
 
    std::map<ZONE*, std::vector<PAD*>> m_zoneConnectionsCache;
    std::map<wxString, wxString>       m_oldToNewNets;
    std::map<PAD*, wxString>           m_padNets;
    std::map<PAD*, wxString>           m_padPinFunctions;
    std::vector<FOOTPRINT*>            m_addedFootprints;
    std::vector<PCB_GROUP*>            m_addedGroups;
    std::map<wxString, NETINFO_ITEM*>  m_addedNets;
    std::set<wxString>                 m_schematicNetNames;
 
    bool m_deleteUnusedFootprints = false;
    bool m_isDryRun = false;
    bool m_replaceFootprints = true;
    bool m_transferGroups = false; // copy component group associations from schematic to PCB
    bool m_applyDesignBlockLayouts = false;
    bool m_lookupByTimestamp = false;
    bool m_overrideLocks = false;
    bool m_updateFields = false;
    bool m_removeExtraFields = false;
 
    int m_warningCount = 0;
    int m_errorCount = 0;
    int m_newFootprintsCount = 0;   // the count of new footprints
                                    // either really new or replaced by new fp.
};
 
#endif