TMATCH::COMPONENT Class Reference

#include <topo_match.h>

Public Member Functions
	COMPONENT (const wxString &aRef, FOOTPRINT *aParentFp, std::optional< VECTOR2I > aRaOffset=std::optional< VECTOR2I >())
	~COMPONENT ()
bool	IsSameKind (const COMPONENT &b) const
void	AddPin (PIN *p)
int	GetPinCount () const
bool	MatchesWith (COMPONENT *b, TOPOLOGY_MISMATCH_REASON &aDetail)
std::vector< PIN * > &	Pins ()
FOOTPRINT *	GetParent () const
bool	HasRAOffset () const
const VECTOR2I	GetRAOffset () const

Private Member Functions
void	sortPinsByName ()

Static Private Member Functions
static bool	isChannelSuffix (const wxString &aSuffix)
	Check if a suffix looks like a channel identifier.
static bool	prefixesShareCommonBase (const wxString &aPrefixA, const wxString &aPrefixB)
	Check if two prefixes share a common starting sequence.

Private Attributes
std::optional< VECTOR2I >	m_raOffset
wxString	m_reference
wxString	m_prefix
FOOTPRINT *	m_parentFootprint = nullptr
std::vector< PIN * >	m_pins

Friends
class	PIN
class	CONNECTION_GRAPH

Detailed Description

Definition at line 52 of file topo_match.h.

Constructor & Destructor Documentation

COMPONENT()

COMPONENT::COMPONENT	(	const wxString &	aRef,
		FOOTPRINT *	aParentFp,
		std::optional< VECTOR2I >	aRaOffset = std::optional<VECTOR2I>() )

Definition at line 670 of file topo_match.cpp.

References UTIL::GetRefDesPrefix(), m_parentFootprint, m_prefix, m_raOffset, and m_reference.

Referenced by CONNECTION_GRAPH, IsSameKind(), and MatchesWith().

~COMPONENT()

COMPONENT::~COMPONENT

(

)

Definition at line 846 of file topo_match.cpp.

References m_pins, and PIN.

Member Function Documentation

AddPin()

void COMPONENT::AddPin

(

PIN *

p

)

Definition at line 725 of file topo_match.cpp.

References m_pins, PIN, and TMATCH::PIN::SetParent().

GetParent()

FOOTPRINT * TMATCH::COMPONENT::GetParent ( ) const

inline

Definition at line 66 of file topo_match.h.

References m_parentFootprint.

Referenced by TMATCH::checkIfPadNetsMatch(), TMATCH::CONNECTION_GRAPH::findMatchingComponents(), TMATCH::PIN::IsIsomorphic(), and MatchesWith().

GetPinCount()

int TMATCH::COMPONENT::GetPinCount ( ) const

inline

Definition at line 63 of file topo_match.h.

References m_pins.

Referenced by MatchesWith().

GetRAOffset()

const VECTOR2I TMATCH::COMPONENT::GetRAOffset ( ) const

inline

Definition at line 69 of file topo_match.h.

References m_raOffset.

HasRAOffset()

bool TMATCH::COMPONENT::HasRAOffset ( ) const

inline

Definition at line 68 of file topo_match.h.

References m_raOffset.

isChannelSuffix()

bool COMPONENT::isChannelSuffix ( const wxString & aSuffix )

staticprivate

Check if a suffix looks like a channel identifier.

Channel identifiers contain no letters, only digits and separator symbols (dots, underscores, hyphens, etc.).

Definition at line 679 of file topo_match.cpp.

Referenced by prefixesShareCommonBase().

IsSameKind()

bool COMPONENT::IsSameKind

(

const COMPONENT &

b

)

const

Definition at line 715 of file topo_match.cpp.

References COMPONENT(), empty(), LIB_ID::empty(), FOOTPRINT::GetFPID(), m_parentFootprint, m_prefix, and prefixesShareCommonBase().

Referenced by MatchesWith().

MatchesWith()

bool COMPONENT::MatchesWith	(	COMPONENT *	b,
		TOPOLOGY_MISMATCH_REASON &	aDetail )

Definition at line 732 of file topo_match.cpp.

References _, COMPONENT(), FOOTPRINT::GetFPIDAsString(), GetParent(), GetPinCount(), FOOTPRINT::GetReferenceAsString(), IsSameKind(), TMATCH::TOPOLOGY_MISMATCH_REASON::m_candidate, m_pins, m_prefix, TMATCH::TOPOLOGY_MISMATCH_REASON::m_reason, TMATCH::TOPOLOGY_MISMATCH_REASON::m_reference, pin, and prefixesShareCommonBase().

Referenced by TMATCH::CONNECTION_GRAPH::findMatchingComponents().

Pins()

std::vector< PIN * > & TMATCH::COMPONENT::Pins ( )

inline

Definition at line 65 of file topo_match.h.

References m_pins.

Referenced by TMATCH::checkIfPadNetsMatch().

prefixesShareCommonBase()

bool COMPONENT::prefixesShareCommonBase ( const wxString & aPrefixA, const wxString & aPrefixB )

staticprivate

Check if two prefixes share a common starting sequence.

The remaining parts after the common prefix must be valid channel suffixes (no letters). This handles multi-channel designs where components have hierarchical reference designators like TRIM_1.1 and TRIM_2.1.

Definition at line 694 of file topo_match.cpp.

References isChannelSuffix().

Referenced by IsSameKind(), and MatchesWith().

sortPinsByName()

void COMPONENT::sortPinsByName ( )

private

Definition at line 341 of file topo_match.cpp.

References m_pins, and PIN.

Friends And Related Symbol Documentation

CONNECTION_GRAPH

friend class CONNECTION_GRAPH

friend

Definition at line 55 of file topo_match.h.

References COMPONENT(), CONNECTION_GRAPH, and PIN.

Referenced by CONNECTION_GRAPH.

PIN

friend class PIN

friend

Definition at line 54 of file topo_match.h.

References PIN.

Referenced by AddPin(), CONNECTION_GRAPH, PIN, sortPinsByName(), and ~COMPONENT().

Member Data Documentation

m_parentFootprint

FOOTPRINT* TMATCH::COMPONENT::m_parentFootprint = nullptr

private

Definition at line 94 of file topo_match.h.

Referenced by COMPONENT(), GetParent(), and IsSameKind().

m_pins

std::vector<PIN*> TMATCH::COMPONENT::m_pins

private

Definition at line 95 of file topo_match.h.

Referenced by AddPin(), TMATCH::CONNECTION_GRAPH::findMatchingComponents(), GetPinCount(), MatchesWith(), Pins(), sortPinsByName(), and ~COMPONENT().

m_prefix

wxString TMATCH::COMPONENT::m_prefix

private

Definition at line 93 of file topo_match.h.

Referenced by COMPONENT(), IsSameKind(), and MatchesWith().

m_raOffset

std::optional<VECTOR2I> TMATCH::COMPONENT::m_raOffset

private

Definition at line 91 of file topo_match.h.

Referenced by COMPONENT(), GetRAOffset(), and HasRAOffset().

m_reference

wxString TMATCH::COMPONENT::m_reference

private

Definition at line 92 of file topo_match.h.

Referenced by COMPONENT(), TMATCH::CONNECTION_GRAPH::findMatchingComponents(), and TMATCH::PIN::IsIsomorphic().

---

The documentation for this class was generated from the following files:

• topo_match.h
• topo_match.cpp