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 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 EXPORT_FOOTPRINTS_PLACEFILE_H
#define EXPORT_FOOTPRINTS_PLACEFILE_H
 
 
#include <board.h>

 
 
class PLACE_FILE_EXPORTER
{
public:

    PLACE_FILE_EXPORTER( BOARD* aBoard, bool aUnitsMM, bool aOnlySMD, bool aExcludeAllTH,
                         bool aExcludeDNP, bool aExcludeBOM, bool aTopSide, bool aBottomSide,
                         bool aFormatCSV, bool aUseAuxOrigin, bool aNegateBottomX );

    std::string GenPositionData();

    std::string GenReportData();

    int GetFootprintCount() { return m_fpCount; }

    void SetVariant( const wxString& aVariant ) { m_variant = aVariant; }
 
    // 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" ); }
 
    static wxString DecorateFilename( const wxString& aBaseName, bool aFront, bool aBack );
 
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_excludeBOM;      // Exclude components flagged exclude from BOM
    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.
    wxString m_variant;         // Variant name for variant-aware field values and filtering
};
 
#endif      // #ifndef EXPORT_FOOTPRINTS_PLACEFILE_H