#include <altium_props_utils.h>

Static Public Member Functions
static int32_t	ConvertToKicadUnit (const double aValue, bool *aOutOfRange=nullptr)
	Convert a value in Altium's internal unit (0.1 uinch) to KiCad IU, clamped to the representable range.

static int	ReadInt (const std::map< wxString, wxString > &aProps, const wxString &aKey, int aDefault)

static double	ReadDouble (const std::map< wxString, wxString > &aProps, const wxString &aKey, double aDefault)

static bool	ReadBool (const std::map< wxString, wxString > &aProps, const wxString &aKey, bool aDefault)

static int32_t	ReadKicadUnit (const std::map< wxString, wxString > &aProps, const wxString &aKey, const wxString &aDefault, bool *aOutOfRange=nullptr)

static wxString	ReadString (const std::map< wxString, wxString > &aProps, const wxString &aKey, const wxString &aDefault)

static wxString	ReadUnicodeString (const std::map< wxString, wxString > &aProps, const wxString &aKey, const wxString &aDefault)

Detailed Description

Definition at line 30 of file altium_props_utils.h.

Member Function Documentation

◆ ConvertToKicadUnit()

int32_t ALTIUM_PROPS_UTILS::ConvertToKicadUnit	(	const double	aValue,
		bool *	aOutOfRange = nullptr )

static

Convert a value in Altium's internal unit (0.1 uinch) to KiCad IU, clamped to the representable range.

Parameters

aValue
aOutOfRange	when given, is set true if `aValue` did not fit and the result is a clamp rather than a conversion. A clamped coordinate names the edge of the int range, not a place on the board, so callers that position geometry must reject it instead of using it.

Definition at line 32 of file altium_props_utils.cpp.

References KiROUND().

Referenced by AREGION6::AREGION6(), ATEXT6::ATEXT6(), BOOST_AUTO_TEST_CASE(), BOOST_DATA_TEST_CASE(), ALTIUM_BINARY_PARSER::ReadKicadUnit(), and ReadKicadUnit().

◆ ReadBool()

bool ALTIUM_PROPS_UTILS::ReadBool	(	const std::map< wxString, wxString > &	aProps,
		const wxString &	aKey,
		bool	aDefault )

static

Definition at line 74 of file altium_props_utils.cpp.

Referenced by ACOMPONENT6::ACOMPONENT6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), ADIMENSION6::ADIMENSION6(), AMODEL::AMODEL(), APOLYGON6::APOLYGON6(), AREGION6::AREGION6(), ARULE6::ARULE6(), ASCH_FILE_NAME::ASCH_FILE_NAME(), ASCH_FILL_INTERFACE::ASCH_FILL_INTERFACE(), ASCH_HARNESS_ENTRY::ASCH_HARNESS_ENTRY(), ASCH_HARNESS_TYPE::ASCH_HARNESS_TYPE(), ASCH_IMAGE::ASCH_IMAGE(), ASCH_IMPLEMENTATION::ASCH_IMPLEMENTATION(), ASCH_LABEL::ASCH_LABEL(), ASCH_NO_ERC::ASCH_NO_ERC(), ASCH_OWNER_INTERFACE::ASCH_OWNER_INTERFACE(), ASCH_PARAMETER::ASCH_PARAMETER(), ASCH_POWER_PORT::ASCH_POWER_PORT(), ASCH_SHEET::ASCH_SHEET(), ASCH_SHEET_FONT::ASCH_SHEET_FONT(), ASCH_SHEET_NAME::ASCH_SHEET_NAME(), ASCH_SHEET_SYMBOL::ASCH_SHEET_SYMBOL(), ASCH_SYMBOL::ASCH_SYMBOL(), ASCH_TEXT_FRAME::ASCH_TEXT_FRAME(), and ASMARTUNION6::ASMARTUNION6().

◆ ReadDouble()

double ALTIUM_PROPS_UTILS::ReadDouble	(	const std::map< wxString, wxString > &	aProps,
		const wxString &	aKey,
		double	aDefault )

static

Definition at line 56 of file altium_props_utils.cpp.

Referenced by ABOARD6_LAYER_STACKUP::ABOARD6_LAYER_STACKUP(), ACOMPONENT6::ACOMPONENT6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), ADIMENSION6::ADIMENSION6(), altium_parse_polygons(), AMODEL::AMODEL(), ASCH_ARC::ASCH_ARC(), ASMARTUNION6::ASMARTUNION6(), and ReadAltiumDielectricLossTangents().

◆ ReadInt()

int ALTIUM_PROPS_UTILS::ReadInt	(	const std::map< wxString, wxString > &	aProps,
		const wxString &	aKey,
		int	aDefault )

static

Definition at line 48 of file altium_props_utils.cpp.

Referenced by ABOARD6::ABOARD6(), ABOARD6_LAYER_STACKUP::ABOARD6_LAYER_STACKUP(), ACLASS6::ACLASS6(), ACOMPONENT6::ACOMPONENT6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), ADIMENSION6::ADIMENSION6(), AEXTENDED_PRIMITIVE_INFORMATION::AEXTENDED_PRIMITIVE_INFORMATION(), ALIBRARY::ALIBRARY(), altium_parse_polygons(), altiumCollectSchematicNetNames(), AMODEL::AMODEL(), APOLYGON6::APOLYGON6(), AREGION6::AREGION6(), ARULE6::ARULE6(), ASCH_BEZIER::ASCH_BEZIER(), ASCH_BORDER_INTERFACE::ASCH_BORDER_INTERFACE(), ASCH_BUS::ASCH_BUS(), ASCH_DESIGNATOR::ASCH_DESIGNATOR(), ASCH_FILL_INTERFACE::ASCH_FILL_INTERFACE(), ASCH_HARNESS_CONNECTOR::ASCH_HARNESS_CONNECTOR(), ASCH_HARNESS_ENTRY::ASCH_HARNESS_ENTRY(), ASCH_HARNESS_TYPE::ASCH_HARNESS_TYPE(), ASCH_IMPLEMENTATION::ASCH_IMPLEMENTATION(), ASCH_LABEL::ASCH_LABEL(), ASCH_OWNER_INTERFACE::ASCH_OWNER_INTERFACE(), ASCH_PARAMETER::ASCH_PARAMETER(), ASCH_PIN::ASCH_PIN(), ASCH_POLYGON::ASCH_POLYGON(), ASCH_POLYLINE::ASCH_POLYLINE(), ASCH_PORT::ASCH_PORT(), ASCH_SHEET::ASCH_SHEET(), ASCH_SHEET_FONT::ASCH_SHEET_FONT(), ASCH_SHEET_SYMBOL::ASCH_SHEET_SYMBOL(), ASCH_SIGNAL_HARNESS::ASCH_SIGNAL_HARNESS(), ASCH_STORAGE_FILE::ASCH_STORAGE_FILE(), ASCH_SYMBOL::ASCH_SYMBOL(), ASCH_TEXT_FRAME::ASCH_TEXT_FRAME(), ASCH_WIRE::ASCH_WIRE(), ASMARTUNION6::ASMARTUNION6(), SCH_IO_ALTIUM::ParseAdditional(), SCH_IO_ALTIUM::ParseLibFile(), SCH_IO_ALTIUM::ParseRecord(), SCH_IO_ALTIUM::ParseStorage(), ReadEnum(), ReadKiCadUnitFrac(), ReadKiCadUnitFrac1(), ReadOwnerIndex(), ReadOwnerPartId(), and ReadRecord().

◆ ReadKicadUnit()

int32_t ALTIUM_PROPS_UTILS::ReadKicadUnit	(	const std::map< wxString, wxString > &	aProps,
		const wxString &	aKey,
		const wxString &	aDefault,
		bool *	aOutOfRange = nullptr )

static

Parameters

aProps
aKey
aDefault
aOutOfRange	is forwarded to ConvertToKicadUnit(); it stays false for a missing or unparseable property, which yields zero rather than a clamp.

Definition at line 86 of file altium_props_utils.cpp.

References ConvertToKicadUnit(), and ReadString().

Referenced by ABOARD6::ABOARD6(), ABOARD6_LAYER_STACKUP::ABOARD6_LAYER_STACKUP(), ACOMPONENT6::ACOMPONENT6(), ACOMPONENTBODY6::ACOMPONENTBODY6(), ADIMENSION6::ADIMENSION6(), AEXTENDED_PRIMITIVE_INFORMATION::AEXTENDED_PRIMITIVE_INFORMATION(), altium_parse_polygons(), APOLYGON6::APOLYGON6(), ARULE6::ARULE6(), ASMARTUNION6::ASMARTUNION6(), BOOST_AUTO_TEST_CASE(), BOOST_DATA_TEST_CASE(), and ReadAltiumDielectricLossTangents().