variant_symbol_utils.cpp File Reference

#include "variant_symbol_utils.h"
#include <lib_symbol.h>
#include <pin_type.h>
#include <sch_pin.h>
#include <algorithm>

Go to the source code of this file.

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.

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.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_SYMBOL::GetVariantLibSymbol(), SCH_EDIT_TOOL::SetVariantSymbol(), and ERC_TESTER::TestVariantSymbols().

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().