drc_chain_topology.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 PCBNEW_DRC_CHAIN_TOPOLOGY_H
#define PCBNEW_DRC_CHAIN_TOPOLOGY_H
 
#include <set>
#include <vector>
 
#include <wx/string.h>
 
#include <layer_ids.h>
#include <math/vector2d.h>
 
class BOARD;
class BOARD_CONNECTED_ITEM;
 

class CHAIN_TOPOLOGY
{
public:
    struct STUB
    {
        VECTOR2I                           branchPoint;
        PCB_LAYER_ID                       branchLayer;
        std::vector<BOARD_CONNECTED_ITEM*> items;
        double                             length;
        double                             delay;
    };
 
    enum class STATUS
    {
        OK,
        NO_ITEMS,
        NO_TERMINAL_PADS,
        DISCONNECTED,
        CYCLE_DETECTED
    };
 
    CHAIN_TOPOLOGY( BOARD* aBoard, const wxString& aChainName, const std::set<BOARD_CONNECTED_ITEM*>& aChainItems,
                    double aDefaultUnitDelay = 0.0 );
 
    STATUS GetStatus() const { return m_status; }
    bool   IsValid() const { return m_status == STATUS::OK; }
 
    double TrunkLength() const { return m_trunkLength; }
    double TrunkDelay() const { return m_trunkDelay; }
 
    const std::vector<STUB>& Stubs() const { return m_stubs; }
 
    const wxString& GetChainName() const { return m_chainName; }
 
private:
    wxString          m_chainName;
    STATUS            m_status = STATUS::NO_ITEMS;
    double            m_trunkLength = 0.0;
    double            m_trunkDelay = 0.0;
    std::vector<STUB> m_stubs;
};
 
#endif // PCBNEW_DRC_CHAIN_TOPOLOGY_H