board_stackup_reporter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2026 Krishna Swaroop <[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_STACKUP_REPORTER_H
#define BOARD_STACKUP_REPORTER_H
 
#include <eda_units.h>
 
class BOARD_STACKUP;

struct STACKUP_CSV_OPTIONS
{
    bool includeColor = true;
    bool includeMaterial = true;
    bool includeThickness = true;
    bool includeEpsilonR = true;
    bool includeLossTangent = true;
    bool includeFinish = true;
    bool includeBoardOptions = true;
};
 
wxString BuildStackupReport( BOARD_STACKUP& aStackup, EDA_UNITS aUnits );
 
wxString BuildStackupCsv( BOARD_STACKUP& aStackup, EDA_UNITS aUnits,
                          const STACKUP_CSV_OPTIONS& aOptions = STACKUP_CSV_OPTIONS() );
 
#endif // #ifndef BOARD_STACKUP_REPORTER_H