altium_project_variants.h File Reference

#include <map>
#include <vector>
#include <wx/string.h>
#include <kiid.h>

Go to the source code of this file.

Classes
struct	ALTIUM_VARIANT_ENTRY
	A single component variation within an Altium project variant. More...
struct	ALTIUM_PROJECT_VARIANT
	A project-level assembly variant parsed from an Altium .PrjPcb file. More...

Functions
std::vector< ALTIUM_PROJECT_VARIANT >	ParseAltiumProjectVariants (const wxString &aPrjPcbPath)
	Parse all [ProjectVariantN] sections from an Altium .PrjPcb project file.
std::map< wxString, wxString >	ParseAltiumProjectParameters (const wxString &aPrjPcbPath)
	Parse all [ParameterN] sections from an Altium .PrjPcb project file.
KIID	AltiumUniqueIdToKiid (const wxString &aUniqueId)
	Derive a stable KIID from an Altium component unique id.

Function Documentation

AltiumUniqueIdToKiid()

KIID AltiumUniqueIdToKiid

(

const wxString &

aUniqueId

)

Derive a stable KIID from an Altium component unique id.

Altium unique ids are not hexadecimal, so KIID's string constructor cannot parse them and returns a fresh random uuid each call. This maps equal id strings to equal KIIDs.

Parameters

aUniqueId

Altium component unique id.

Returns

A KIID that is identical for identical input strings.

Definition at line 34 of file altium_project_variants.cpp.

Referenced by ApplyAltiumProjectVariantsToBoard(), and ALTIUM_PCB::ParseComponents6Data().

ParseAltiumProjectParameters()

std::map< wxString, wxString > ParseAltiumProjectParameters

(

const wxString &

aPrjPcbPath

)

Parse all [ParameterN] sections from an Altium .PrjPcb project file.

Altium stores project-wide special strings (PCB_Revision, Company_Name, ...) here as Name/Value pairs. They are what board text such as ".PCB_Revision" resolves against, so they map to KiCad project text variables.

Parameters

aPrjPcbPath

Full path to the .PrjPcb file.

Returns

Map of upper-cased parameter name to value, matching the case-insensitive variable references emitted by AltiumPcbSpecialStringsToKiCadStrings.

Definition at line 132 of file altium_project_variants.cpp.

References config, and name.

Referenced by PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), and PCB_IO_SOLIDWORKS::LoadBoard().

ParseAltiumProjectVariants()

std::vector< ALTIUM_PROJECT_VARIANT > ParseAltiumProjectVariants

(

const wxString &

aPrjPcbPath

)

Parse all [ProjectVariantN] sections from an Altium .PrjPcb project file.

Parameters

aPrjPcbPath

Full path to the .PrjPcb file.

Returns

Vector of project variants with their per-component entries.

Definition at line 175 of file altium_project_variants.cpp.

References config, ALTIUM_PROJECT_VARIANT::description, ALTIUM_VARIANT_ENTRY::designator, ALTIUM_PROJECT_VARIANT::name, ParseVariationString(), and ALTIUM_PROJECT_VARIANT::variations.

Referenced by PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), and SCH_IO_ALTIUM::LoadSchematicFile().