altium_project_variants.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 ALTIUM_PROJECT_VARIANTS_H
#define ALTIUM_PROJECT_VARIANTS_H
 
#include <map>
#include <vector>
#include <wx/string.h>
 
#include <kiid.h>
 
class PROJECT;

struct ALTIUM_VARIANT_ENTRY
{
    wxString                         designator;
 
    // Component's own unique id (final segment of the Altium path); the value used for matching.
    wxString                         uniqueId;
 
    int                              kind = 0;
    std::map<wxString, wxString>     alternateFields;
};
 

struct ALTIUM_PROJECT_VARIANT
{
    wxString                                 name;
    wxString                                 description;
    std::vector<ALTIUM_VARIANT_ENTRY>        variations;
};
 

ALTIUM_VARIANT_ENTRY ParseVariationString( const wxString& aValue );
 

std::vector<ALTIUM_PROJECT_VARIANT> ParseAltiumProjectVariants( const wxString& aPrjPcbPath );
 

std::map<wxString, wxString> ParseAltiumProjectParameters( const wxString& aPrjPcbPath );
 

bool AltiumPowerPortNamesTakePriority( const wxString& aPrjPcbPath );
 

void ApplyAltiumProjectParametersToProject( PROJECT* aProject,
                                            const std::map<wxString, wxString>& aParameters );
 

KIID AltiumUniqueIdToKiid( const wxString& aUniqueId );
 
#endif // ALTIUM_PROJECT_VARIANTS_H