#include <functional>
#include <vector>
#include <wx/string.h>

Classes
struct	VARIANT_COMPAT_RESULT

Typedefs
using	SYMBOL_COMPAT_FUNC = std::function<std::vector<VARIANT_COMPAT_RESULT>( const LIB_ID& )>
	Callback that evaluates variant symbol compatibility for a given candidate LIB_ID.

Enumerations
enum class	VARIANT_COMPAT_ERROR { NONE , MISSING_PIN_NUMBER , EXTRA_PIN_NUMBER , PIN_POSITION_MISMATCH , PIN_TYPE_MISMATCH , INSUFFICIENT_UNITS , MISSING_BODY_STYLE }
	Describes a single pin compatibility problem found when comparing a candidate symbol against a base symbol for use as a variant symbol override. More...

Functions
bool	VariantSymbolPinsMatch (const SCH_PIN &aBase, const SCH_PIN &aCandidate)
	Check whether two graphical pins occupy the same variant-symbol connection slot.

std::vector< VARIANT_COMPAT_RESULT >	ValidateVariantSymbolCompatibility (const LIB_SYMBOL &aBase, const LIB_SYMBOL &aCandidate)
	Check whether aCandidate can be used as a variant symbol override for aBase.

Typedef Documentation

◆ SYMBOL_COMPAT_FUNC

using SYMBOL_COMPAT_FUNC = std::function<std::vector<VARIANT_COMPAT_RESULT>( const LIB_ID& )>

Callback that evaluates variant symbol compatibility for a given candidate LIB_ID.

Returns an empty vector when the candidate is fully compatible with the base symbol.

Definition at line 72 of file variant_symbol_utils.h.

Enumeration Type Documentation

◆ VARIANT_COMPAT_ERROR

enum class VARIANT_COMPAT_ERROR

strong

Describes a single pin compatibility problem found when comparing a candidate symbol against a base symbol for use as a variant symbol override.

Enumerator
NONE
MISSING_PIN_NUMBER	A base pin number is absent from the candidate for a given unit/body style.
EXTRA_PIN_NUMBER	Candidate has a pin occurrence that is absent from the base.
PIN_POSITION_MISMATCH	A matching pin number has a different position in library coordinates.
PIN_TYPE_MISMATCH	A matching pin number has a different electrical type.
INSUFFICIENT_UNITS	Candidate has fewer units than the base.
MISSING_BODY_STYLE	Base uses alternate body styles but candidate does not.

Definition at line 40 of file variant_symbol_utils.h.

Function Documentation

◆ ValidateVariantSymbolCompatibility()

std::vector< VARIANT_COMPAT_RESULT > ValidateVariantSymbolCompatibility	(	const LIB_SYMBOL &	aBase,
		const LIB_SYMBOL &	aCandidate )

Check whether aCandidate can be used as a variant symbol override for aBase.

The returned vector lists every issue found and an empty vector means fully compatible. Every graphical pin occurrence must have a one-to-one match with the same number, unit, body style, position, and electrical type. The candidate must have at least as many units as the base and must provide alternate body styles when the base has them. Pin names, symbol body graphics, field names and counts are not checked.

Parameters

aBase	the base symbol whose pin layout must be preserved.
aCandidate	the proposed alternate symbol.

Returns: a vector of all compatibility issues found; empty if the symbols are compatible.

Definition at line 42 of file variant_symbol_utils.cpp.

References _, EXTRA_PIN_NUMBER, SCH_ITEM::GetBodyStyle(), LIB_SYMBOL::GetBodyStyleCount(), GetCanonicalElectricalTypeName(), LIB_SYMBOL::GetGraphicalPins(), SCH_PIN::GetNumber(), SCH_PIN::GetPosition(), SCH_PIN::GetType(), SCH_ITEM::GetUnit(), LIB_SYMBOL::GetUnitCount(), INSUFFICIENT_UNITS, MISSING_BODY_STYLE, MISSING_PIN_NUMBER, PIN_POSITION_MISMATCH, PIN_TYPE_MISMATCH, result, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ VariantSymbolPinsMatch()

bool VariantSymbolPinsMatch	(	const SCH_PIN &	aBase,
		const SCH_PIN &	aCandidate )

Check whether two graphical pins occupy the same variant-symbol connection slot.

Definition at line 33 of file variant_symbol_utils.cpp.

References SCH_ITEM::GetBodyStyle(), SCH_PIN::GetNumber(), SCH_PIN::GetPosition(), and SCH_ITEM::GetUnit().

Referenced by SCH_SYMBOL::MapLibPins().

Classes

Typedefs

Enumerations