pcb_drill_chart.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 PCB_DRILL_CHART_H
#define PCB_DRILL_CHART_H
 
#include <map>
#include <optional>
#include <vector>
 
#include <board_tables/generated_table_refresh.h>
#include <drill/drill_chart_model.h>
#include <drill/drill_chart_template.h>
#include <drill/drill_span.h>
#include <drill/drill_symbol_profile.h>
#include <pcb_generated_table.h>
 

struct DRILL_CHART_CONTENT : GENERATED_TABLE_CONTENT
{
    std::vector<std::optional<int>> m_RowShapes; 
    int                             m_SymbolColumn = -1;
};
 

struct DRILL_PROFILE_PENDING : GENERATED_TABLE_PENDING
{
    explicit DRILL_PROFILE_PENDING( BOARD& aBoard );
 
    void Commit( BOARD& aBoard ) override;
 
    DRILL_SYMBOL_PROFILE m_Profile;
};
 

class PCB_DRILL_CHART : public PCB_GENERATED_TABLE
{
public:
    PCB_DRILL_CHART( BOARD_ITEM* aParent );
 
    PCB_DRILL_CHART( const PCB_DRILL_CHART& aOther );
 
    ~PCB_DRILL_CHART() override = default;
 
    PCB_DRILL_CHART& operator=( const PCB_DRILL_CHART& ) = delete;
 
    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && PCB_DRILL_CHART_T == aItem->Type();
    }
 
    wxString GetClass() const override { return wxT( "PCB_DRILL_CHART" ); }
 
    EDA_ITEM* Clone() const override { return new PCB_DRILL_CHART( *this ); }
 
    const GENERATED_TABLE_SCHEMA& Schema() const override { return DrillChartSchema(); }
 
    DRILL_CHART_FILTER& Filter() { return m_filter; }
    const DRILL_CHART_FILTER& Filter() const { return m_filter; }
 
    bool GetShowTotals() const { return m_showTotals; }
    void SetShowTotals( bool aShow ) { m_showTotals = aShow; }

    uint64_t GetBuiltGeneration() const { return m_builtGeneration; }

    void ApplyTemplate( const DRILL_CHART_TEMPLATE& aTemplate );

    bool IsStale( const BOARD& aBoard ) const override;

    const std::map<int, int>& RowShapes() const { return m_rowShapes; }
    std::map<int, int>& RowShapes() { return m_rowShapes; }

    bool IsDataRow( int aRow ) const override;

    int GetSymbolColumn() const { return m_symbolColumn; }
    void SetSymbolColumn( int aCol ) { m_symbolColumn = aCol; }
 
    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
 
    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
    double Similarity( const BOARD_ITEM& aOther ) const override;
 
    bool operator==( const BOARD_ITEM& aOther ) const override;
 
    void Serialize( google::protobuf::Any& aContainer ) const override;
    bool Deserialize( const google::protobuf::Any& aContainer ) override;
 
protected:
    std::unique_ptr<GENERATED_TABLE_CONTENT> generate( const BOARD&             aBoard,
                                                       GENERATED_TABLE_REFRESH* aRefresh ) const override;
 
    void onRebuilt( const BOARD& aBoard, const GENERATED_TABLE_CONTENT& aContent ) override;
 
    void swapData( BOARD_ITEM* aImage ) override;
 
private:
    std::vector<DRILL_CHART_GROUP> buildGroups( const BOARD& aBoard, const DRILL_SYMBOL_PROFILE& aProfile ) const;

    DRILL_CHART_COLUMN_ID columnId( int aCol ) const;
 
    DRILL_CHART_FILTER m_filter;
 
    bool m_showTotals;
 
    std::map<int, int> m_rowShapes;
    int                m_symbolColumn;
 
    uint64_t m_builtGeneration;
};
 
#endif // PCB_DRILL_CHART_H