gerber_jobfile_writer.h

Go to the documentation of this file.

 
/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2018 Jean_Pierre Charras <jp.charras at wanadoo.fr>
 * Copyright (C) 1992-2018 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 GERBER_JOBFILE_WRITER_H
#define GERBER_JOBFILE_WRITER_H
 
#include <nlohmann/json.hpp>
 
 
// A helper enum to handle sides of some layers (silk, mask)
enum ONSIDE
{
 SIDE_NONE = 0, // layers not present
 SIDE_TOP = 1, // top layer only
 SIDE_BOTTOM = 2, // bottom layer only
 SIDE_BOTH = SIDE_TOP|SIDE_BOTTOM // both layers
};
 
class BOARD;
 
class JOBFILE_PARAMS
{
public:
 wxArrayString m_GerberFileList; // the list of gerber filenames (without path)
 std::vector<PCB_LAYER_ID> m_LayerId; // the list of corresponding layer id
};
 
 
class GERBER_JOBFILE_WRITER
{
public:
 GERBER_JOBFILE_WRITER( BOARD* aPcb, REPORTER* aReporter = nullptr );
 
 virtual ~GERBER_JOBFILE_WRITER()
 {
 }
 
 void AddGbrFile( PCB_LAYER_ID aLayer, wxString& aFilename )
 {
 m_params.m_GerberFileList.Add( aFilename );
 m_params.m_LayerId.push_back( aLayer );
 }
 
 bool CreateJobFile( const wxString& aFullFilename );
 
 bool WriteJSONJobFile( const wxString& aFullFilename );
 
private:
 enum ONSIDE hasSilkLayers();
 
 enum ONSIDE hasSolderMasks();
 
 const char* sideKeyValue( enum ONSIDE aValue );
 
 void addJSONHeader();
 
 void addJSONGeneralSpecs();
 
 void addJSONFilesAttributes();
 
 void addJSONMaterialStackup();
 
 void addJSONDesignRules();
 
 std::string formatStringFromUTF32( const wxString& aText );
 
 double mapValue( double aUiValue );
 
private:
 BOARD* m_pcb; // The board
 REPORTER* m_reporter; // a reporter for messages (can be null)
 JOBFILE_PARAMS m_params; // the list of various prms and data to write in a job file
 double m_conversionUnits; // scaling factor to convert brd units to gerber units (mm)
 nlohmann::ordered_json m_json; // json document built by this class
};
 
#endif // #ifndef GERBER_JOBFILE_WRITER_H