place_file_exporter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015-2022 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 EXPORT_FOOTPRINTS_PLACEFILE_H
#define EXPORT_FOOTPRINTS_PLACEFILE_H
 
 
#include <board.h>
#include <footprint.h>
 
class PLACE_FILE_EXPORTER
{
public:
 
 PLACE_FILE_EXPORTER( BOARD* aBoard, bool aUnitsMM, bool aOnlySMD, bool aExcludeAllTH,
 bool aExcludeDNP, bool aTopSide, bool aBottomSide, bool aFormatCSV,
 bool aUseAuxOrigin, bool aNegateBottomX );
 
 std::string GenPositionData();
 
 std::string GenReportData();
 
 int GetFootprintCount() { return m_fpCount; }
 
 // Use standard board side name. do not translate them,
 // they are keywords in place file
 static std::string GetFrontSideName() { return std::string( "top" ); }
 static std::string GetBackSideName() { return std::string( "bottom" ); }
 
private:
 BOARD* m_board;
 bool m_unitsMM; // true for mm, false for inches
 bool m_onlySMD; // Include only SMD components
 bool m_excludeDNP; // Exclude DNP components
 bool m_excludeAllTH; // Exclude any footprints with through-hole pads
 int m_side; // PCB_BACK_SIDE, PCB_FRONT_SIDE, PCB_BOTH_SIDES
 bool m_formatCSV; // true for csv format, false for ascii (utf8) format
 bool m_negateBottomX; // true to negate X coordinate on bottom side
 int m_fpCount; // Number of footprints in list, for info
 VECTOR2I m_place_Offset; // Offset for coordinates in generated data.
};
 
#endif // #ifndef EXPORT_FOOTPRINTS_PLACEFILE_H