drill_chart_model.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 DRILL_CHART_MODEL_H
#define DRILL_CHART_MODEL_H
 
#include <string>
#include <vector>
 
#include <drill/drill_operation.h>
#include <drill/drill_chart_template.h>
#include <drill/drill_symbol_profile.h>
 
class BOARD;
 

struct DRILL_CHART_GROUP
{
    std::string m_Key;

    std::string m_SymbolKey;
 
    int      m_Diameter = 0;
    VECTOR2I m_SizeXY;
    bool     m_IsSlot = false;
    bool     m_NotPlated = false;
 
    PCB_LAYER_ID   m_TopLayer = F_Cu;
    PCB_LAYER_ID   m_BottomLayer = B_Cu;
    DRILL_OP_KIND  m_Kind = DRILL_OP_KIND::PRIMARY_DRILL;
    HOLE_ATTRIBUTE m_Attribute = HOLE_ATTRIBUTE::HOLE_UNKNOWN;
 
    std::optional<int>      m_StubLength;
 
    bool m_Filled = false;
    bool m_Capped = false;
    bool m_TopCovered = false;
    bool m_BottomCovered = false;
    bool m_TopPlugged = false;
    bool m_BottomPlugged = false;
    bool m_TopTented = false;
    bool m_BottomTented = false;
 
    DRILL_POST_MACHINING m_FrontPostMachining;
    DRILL_POST_MACHINING m_BackPostMachining;
 
    int m_OperationCount = 0;
    int m_SiteCount = 0;
    int m_SlotCount = 0;
 
    DRILL_SYMBOL_ASSIGNMENT m_Symbol;
 
    std::vector<DRILL_OPERATION_ID> m_Members;

    std::vector<VECTOR2I> m_Sites;
};
 
 
struct DRILL_CHART_TOTALS
{
    int m_Operations = 0;
    int m_Sites = 0;
    int m_Groups = 0;
};
 

struct DRILL_CHART_ROW_SPEC
{
    DRILL_CHART_FILTER m_Filter;
};
 
 
class DRILL_CHART_MODEL
{
public:
    DRILL_CHART_MODEL( const DRILL_SYMBOL_PROFILE& aProfile );
 
    void Build( const BOARD& aBoard, const std::vector<DRILL_SPAN>& aSpans );
 
    void Build( const BOARD& aBoard, const std::vector<DRILL_SPAN>& aSpans,
                const DRILL_CHART_ROW_SPEC& aSpec );
 
    const std::vector<DRILL_CHART_GROUP>& Groups() const { return m_groups; }
    const DRILL_CHART_TOTALS& Totals() const { return m_totals; }
 
private:
    const DRILL_SYMBOL_PROFILE& m_profile;
 
    std::vector<DRILL_CHART_GROUP> m_groups;
    DRILL_CHART_TOTALS             m_totals;
};
 

std::vector<DRILL_SPAN> EnumerateDrillSpans( const BOARD& aBoard );
 
#endif // DRILL_CHART_MODEL_H