length_delay_calculation_item.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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef PCBNEW_LENGTH_DELAY_CALCULATION_ITEM_H
#define PCBNEW_LENGTH_DELAY_CALCULATION_ITEM_H
 
#include <geometry/shape_line_chain.h>
#include <layer_ids.h>
#include <pad.h>
#include <pcb_track.h>

class LENGTH_DELAY_CALCULATION_ITEM
{
public:
    enum class TYPE
    {
        UNKNOWN,
        PAD,
        LINE,
        VIA
    };

    enum class MERGE_STATUS
    {
        UNMERGED,
        MERGED_IN_USE,
        MERGED_RETIRED
    };

    TYPE Type() const { return m_type; };

    void SetPad( const PAD* aPad )
    {
        m_type = TYPE::PAD;
        m_pad = aPad;
    }

    const PAD* GetPad() const { return m_pad; }

    void SetLine( const SHAPE_LINE_CHAIN& aLine )
    {
        m_type = TYPE::LINE;
        m_line = aLine;
    }

    SHAPE_LINE_CHAIN& GetLine() const { return m_line; }

    void SetVia( const PCB_VIA* aVia )
    {
        m_type = TYPE::VIA;
        m_via = aVia;
    }

    const PCB_VIA* GetVia() const { return m_via; }

    void SetLayers( const PCB_LAYER_ID aStart, const PCB_LAYER_ID aEnd = PCB_LAYER_ID::UNDEFINED_LAYER )
    {
        if( aEnd != UNDEFINED_LAYER && IsCopperLayerLowerThan( aStart, aEnd ) )
        {
            m_layerStart = aEnd;
            m_layerEnd = aStart;
        }
        else
        {
            m_layerStart = aStart;
            m_layerEnd = aEnd;
        }
    }

    void SetMergeStatus( const MERGE_STATUS aStatus ) { m_mergeStatus = aStatus; }

    MERGE_STATUS GetMergeStatus() const { return m_mergeStatus; }

    std::tuple<PCB_LAYER_ID, PCB_LAYER_ID> GetLayers() const { return { m_layerStart, m_layerEnd }; }

    PCB_LAYER_ID GetStartLayer() const { return m_layerStart; }

    PCB_LAYER_ID GetEndLayer() const { return m_layerEnd; }

    void CalculateViaLayers( const BOARD* aBoard );

    void SetEffectiveNetClass( const NETCLASS* aNetClass ) { m_netClass = aNetClass; }

    const NETCLASS* GetEffectiveNetClass() const { return m_netClass; }
 
protected:
    const PAD* m_pad{ nullptr };

    mutable SHAPE_LINE_CHAIN m_line;

    const PCB_VIA* m_via{ nullptr };

    PCB_LAYER_ID m_layerStart{ PCB_LAYER_ID::UNDEFINED_LAYER };

    PCB_LAYER_ID m_layerEnd{ PCB_LAYER_ID::UNDEFINED_LAYER };

    MERGE_STATUS m_mergeStatus{ MERGE_STATUS::UNMERGED };

    TYPE m_type{ TYPE::UNKNOWN };

    const NETCLASS* m_netClass{ nullptr };
};
 
#endif //PCBNEW_LENGTH_DELAY_CALCULATION_ITEM_H