odb_export_job.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 3 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/>.
 */
 
#pragma once
 
#include <functional>
#include <vector>
 
#include <wx/string.h>
#include <layer_ids.h>
#include <exporters/fab_model/fab_sections.h>
 
class BOARD;
class JOB_EXPORT_PCB_ODB;
class PCB_EDIT_FRAME;
class PROGRESS_REPORTER;
class REPORTER;
 
 
struct ODB_EXPORT_RESULT
{
    bool                  m_ok = false;
    std::vector<wxString> m_outputs;
};

struct ODB_MATRIX_ROW
{
    int      m_row = 0;
    wxString m_context;
    wxString m_type;
    wxString m_name;
    wxString m_polarity;
    wxString m_startName;
    wxString m_endName;
    wxString m_addType;
    wxString m_id;
    wxString m_ref;
    wxString m_cuTop;
    wxString m_cuBottom;
    wxString m_dielectricType;
};

struct ODB_MATRIX_PREVIEW_ROW
{
    ODB_MATRIX_ROW m_matrix;
    PCB_LAYER_ID   m_boardLayer = UNDEFINED_LAYER;
    wxString       m_displayLayer;
    bool           m_editable = false;
};
 

ODB_EXPORT_RESULT GenerateODBPPFiles( const JOB_EXPORT_PCB_ODB& aJob, BOARD* aBoard,
                                      PCB_EDIT_FRAME*    aParentFrame = nullptr,
                                      PROGRESS_REPORTER* aProgressReporter = nullptr, REPORTER* aReporter = nullptr );

std::vector<ODB_MATRIX_PREVIEW_ROW> PreviewOdbMatrix( BOARD* aBoard, const JOB_EXPORT_PCB_ODB& aJob );

wxString UpdateOdbVariantOutputPath( const wxString& aPath, bool aDirectory, bool aSeparate,
                                     bool aRemoveAutomaticSuffix );

wxString OdbSectionKeyForSelection( FAB::MODE aMode, const FAB::SECTION_SET& aSelection );

FAB::SECTION_SET OdbDefaultSections( FAB::MODE aMode );

wxString OdbPreviewReferenceName( const wxString& aReference, const std::vector<ODB_MATRIX_PREVIEW_ROW>& aRows );

bool OdbVariantFileTokensCollide( const std::vector<wxString>&                      aTokens,
                                  const std::function<wxString( const wxString& )>& aLocaleFold );