A class to manage Component Classes in a board context. More...

#include <component_class_manager.h>

Public Member Functions
	COMPONENT_CLASS_MANAGER (BOARD *board)

COMPONENT_CLASS *	GetEffectiveStaticComponentClass (const std::unordered_set< wxString > &classNames)
	Gets an effective component class for the given constituent class names.

const COMPONENT_CLASS *	GetNoneComponentClass () const
	Returns the unassigned component class.

void	InitNetlistUpdate ()
	Prepare the manager for a board update Must be called prior to updating the PCB from the netlist.

void	FinishNetlistUpdate ()
	Cleans up the manager after a board update Must be called after updating the PCB from the netlist.

std::unordered_set< wxString >	GetClassNames () const
	Fetches a read-only map of the fundamental component classes.

bool	SyncDynamicComponentClassAssignments (const std::vector< COMPONENT_CLASS_ASSIGNMENT_DATA > &aAssignments, bool aGenerateSheetClasses, const std::unordered_set< wxString > &aNewSheetPaths)
	Synchronises all dynamic component class assignment rules.

const COMPONENT_CLASS *	GetDynamicComponentClassesForFootprint (const FOOTPRINT *footprint)
	Gets the dynamic component classes which match the given footprint.

const COMPONENT_CLASS *	GetCombinedComponentClass (const COMPONENT_CLASS staticClass, const COMPONENT_CLASS dynamicClass)
	Gets the combined component class with the given static and dynamic constituent component classes.

void	ForceComponentClassRecalculation () const
	Forces the component class for all footprints to be recalculated.

long long int	GetTicker () const
	Gets the component class validity ticker Used to check validity of cached component classes.

void	InvalidateComponentClasses ()
	Invalidates any caches component classes and recomputes caches if required.

void	RebuildRequiredCaches (FOOTPRINT *aFootprint=nullptr) const
	Rebuilds any caches that may be required by custom assignment rules.

bool	HasCustomAssignmentConditions () const
	Determines whether any custom dynamic rules have a custom assignment condition.

Static Public Member Functions
static wxString	GetFullClassNameForConstituents (const std::unordered_set< wxString > &classNames)
	Gets the full effective class name for the given set of constituent classes.

static wxString	GetFullClassNameForConstituents (const std::vector< wxString > &classNames)
	Gets the full effective class name for the given set of constituent classes.

static std::shared_ptr< COMPONENT_CLASS_ASSIGNMENT_RULE >	CompileAssignmentRule (const COMPONENT_CLASS_ASSIGNMENT_DATA &aAssignment)

Protected Member Functions
COMPONENT_CLASS *	getOrCreateConstituentClass (const wxString &aClassName, COMPONENT_CLASS::USAGE aContext)
	Returns a constituent component class, re-using an existing instantiation where possible.

COMPONENT_CLASS *	getOrCreateEffectiveClass (const std::vector< wxString > &aClassNames, COMPONENT_CLASS::USAGE aContext)
	Returns an effective component class for the given set of constituent class names Precondition: aClassNames is sorted by sortClassNames.

Static Protected Member Functions
static std::vector< wxString >	sortClassNames (const std::unordered_set< wxString > &classNames)
	Sorts the given class names in to canonical order.

Protected Attributes
BOARD *	m_board
	The board these component classes are assigned to / from.

std::shared_ptr< COMPONENT_CLASS >	m_noneClass
	The class to represent an unassigned component class.

std::unordered_map< wxString, std::unique_ptr< COMPONENT_CLASS > >	m_constituentClasses
	All individual component classes from static assignments.

std::unordered_map< wxString, std::unique_ptr< COMPONENT_CLASS > >	m_effectiveClasses
	Generated effective (composite) static component classes.

std::unordered_set< wxString >	m_staticClassNamesCache
	Cache of in-use static component class names Used for cleanup following netlist updates.

std::vector< std::shared_ptr< COMPONENT_CLASS_ASSIGNMENT_RULE > >	m_assignmentRules
	Active component class assignment rules.

bool	m_hasCustomAssignmentConditions
	Quick lookup of presence of custom dynamic assignment conditions.

long long int	m_ticker { 0 }
	Monotonically increasing ticker to test cached component class validity.

Detailed Description

A class to manage Component Classes in a board context.

This manager owns generated COMPONENT_CLASS objects, and guarantees that pointers to managed objects are valid for the duration of the board lifetime. Note that, in order to maintain this guarantee, there are two methods that must be called when updating the board from the netlist (InitNetlistUpdate and FinishNetlistUpdate).

Definition at line 44 of file component_class_manager.h.

Constructor & Destructor Documentation

◆ COMPONENT_CLASS_MANAGER()

COMPONENT_CLASS_MANAGER::COMPONENT_CLASS_MANAGER ( BOARD * board )

explicit

Definition at line 33 of file component_class_manager.cpp.

References m_noneClass, and COMPONENT_CLASS::STATIC.

Member Function Documentation

◆ CompileAssignmentRule()

std::shared_ptr< COMPONENT_CLASS_ASSIGNMENT_RULE > COMPONENT_CLASS_MANAGER::CompileAssignmentRule ( const COMPONENT_CLASS_ASSIGNMENT_DATA & aAssignment )

static

Definition at line 280 of file component_class_manager.cpp.

References COMPONENT_CLASS_ASSIGNMENT_DATA::GetAssignmentInDRCLanguage(), REPORTER::HasMessageOfSeverity(), DRC_RULES_PARSER::ParseComponentClassAssignmentRules(), and RPT_SEVERITY_ERROR.

Referenced by PANEL_COMPONENT_CLASS_ASSIGNMENT::OnHighlightItemsClick(), SyncDynamicComponentClassAssignments(), and PANEL_ASSIGN_COMPONENT_CLASSES::Validate().

◆ FinishNetlistUpdate()

void COMPONENT_CLASS_MANAGER::FinishNetlistUpdate ( )

Cleans up the manager after a board update Must be called after updating the PCB from the netlist.

Definition at line 96 of file component_class_manager.cpp.

References COMPONENT_CLASS::DYNAMIC, COMPONENT_CLASS::GetUsageContext(), m_constituentClasses, m_effectiveClasses, m_staticClassNamesCache, COMPONENT_CLASS::SetUsageContext(), COMPONENT_CLASS::STATIC, and COMPONENT_CLASS::STATIC_AND_DYNAMIC.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ ForceComponentClassRecalculation()

void COMPONENT_CLASS_MANAGER::ForceComponentClassRecalculation ( ) const

Forces the component class for all footprints to be recalculated.

This should be called before running DRC as checking for valid component class cache entries is threadsafe, but computing them is not. Blocking during this check would be a negative performance impact for DRC computation, so we force recalculation instead.

Definition at line 367 of file component_class_manager.cpp.

References BOARD::Footprints(), and m_board.

Referenced by DRC_ENGINE::RunTests().

◆ GetClassNames()

std::unordered_set< wxString > COMPONENT_CLASS_MANAGER::GetClassNames ( ) const

Fetches a read-only map of the fundamental component classes.

Definition at line 485 of file component_class_manager.cpp.

References m_constituentClasses.

Referenced by DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow().

◆ GetCombinedComponentClass()

const COMPONENT_CLASS * COMPONENT_CLASS_MANAGER::GetCombinedComponentClass	(	const COMPONENT_CLASS *	staticClass,
		const COMPONENT_CLASS *	dynamicClass
	)

Gets the combined component class with the given static and dynamic constituent component classes.

Definition at line 313 of file component_class_manager.cpp.

References COMPONENT_CLASS::EFFECTIVE, COMPONENT_CLASS::GetConstituentClasses(), GetFullClassNameForConstituents(), GetNoneComponentClass(), m_constituentClasses, m_effectiveClasses, and sortClassNames().

Referenced by COMPONENT_CLASS_CACHE_PROXY::RecomputeComponentClass().

◆ GetDynamicComponentClassesForFootprint()

const COMPONENT_CLASS * COMPONENT_CLASS_MANAGER::GetDynamicComponentClassesForFootprint ( const FOOTPRINT * footprint )

Gets the dynamic component classes which match the given footprint.

Definition at line 377 of file component_class_manager.cpp.

References COMPONENT_CLASS::DYNAMIC, GetFullClassNameForConstituents(), getOrCreateConstituentClass(), getOrCreateEffectiveClass(), m_assignmentRules, and sortClassNames().

Referenced by COMPONENT_CLASS_CACHE_PROXY::RecomputeComponentClass().

◆ GetEffectiveStaticComponentClass()

COMPONENT_CLASS * COMPONENT_CLASS_MANAGER::GetEffectiveStaticComponentClass ( const std::unordered_set< wxString > & classNames )

Gets an effective component class for the given constituent class names.

Computes and returns an effective component class for a (possibly empty) set of constituent class names.

Parameters

classNames The names of the constituent component classes

Returns: Effective COMPONENT_CLASS object

This is called by the netlist updater to set static component classes on footprints.

Where constituent or effective component classes already exist, they are re-used. This allows efficient comparison of (effective) component classes by pointer in DRC checks.

Preconditions: InitNetlistUpdate() must be called before invoking this method.

Parameters

classNames The constitent component class names

Returns: A pointer to an effective COMPONENT_CLASS representing all constituent component classes

Definition at line 52 of file component_class_manager.cpp.

References COMPONENT_CLASS::GetConstituentClasses(), GetFullClassNameForConstituents(), getOrCreateConstituentClass(), getOrCreateEffectiveClass(), m_noneClass, m_staticClassNamesCache, sortClassNames(), and COMPONENT_CLASS::STATIC.

Referenced by FOOTPRINT::ResolveComponentClassNames(), and BOARD_NETLIST_UPDATER::updateComponentClass().

◆ GetFullClassNameForConstituents() [1/2]

wxString COMPONENT_CLASS_MANAGER::GetFullClassNameForConstituents ( const std::unordered_set< wxString > & classNames )

static

Gets the full effective class name for the given set of constituent classes.

Definition at line 135 of file component_class_manager.cpp.

References GetFullClassNameForConstituents(), and sortClassNames().

Referenced by GetCombinedComponentClass(), GetDynamicComponentClassesForFootprint(), GetEffectiveStaticComponentClass(), GetFullClassNameForConstituents(), getOrCreateEffectiveClass(), and BOARD_NETLIST_UPDATER::updateComponentClass().

◆ GetFullClassNameForConstituents() [2/2]

wxString COMPONENT_CLASS_MANAGER::GetFullClassNameForConstituents ( const std::vector< wxString > & classNames )

static

Gets the full effective class name for the given set of constituent classes.

Parameters

classNames a sorted vector of consituent class names

Definition at line 145 of file component_class_manager.cpp.

◆ GetNoneComponentClass()

const COMPONENT_CLASS * COMPONENT_CLASS_MANAGER::GetNoneComponentClass ( ) const

inline

Returns the unassigned component class.

Definition at line 64 of file component_class_manager.h.

References m_noneClass.

Referenced by BOARD_NETLIST_UPDATER::addNewFootprint(), GetCombinedComponentClass(), and PCB_IO_KICAD_SEXPR_PARSER::parseFOOTPRINT_unchecked().

◆ getOrCreateConstituentClass()

COMPONENT_CLASS * COMPONENT_CLASS_MANAGER::getOrCreateConstituentClass	(	const wxString &	aClassName,
		COMPONENT_CLASS::USAGE	aContext
	)

protected

Returns a constituent component class, re-using an existing instantiation where possible.

Definition at line 421 of file component_class_manager.cpp.

References COMPONENT_CLASS::EFFECTIVE, COMPONENT_CLASS::GetUsageContext(), m_constituentClasses, m_noneClass, COMPONENT_CLASS::SetUsageContext(), and COMPONENT_CLASS::STATIC_AND_DYNAMIC.

Referenced by GetDynamicComponentClassesForFootprint(), GetEffectiveStaticComponentClass(), getOrCreateEffectiveClass(), and SyncDynamicComponentClassAssignments().

◆ getOrCreateEffectiveClass()

COMPONENT_CLASS * COMPONENT_CLASS_MANAGER::getOrCreateEffectiveClass	(	const std::vector< wxString > &	aClassNames,
		COMPONENT_CLASS::USAGE	aContext
	)

protected

Returns an effective component class for the given set of constituent class names Precondition: aClassNames is sorted by sortClassNames.

Definition at line 452 of file component_class_manager.cpp.

References COMPONENT_CLASS::EFFECTIVE, COMPONENT_CLASS::GetConstituentClasses(), GetFullClassNameForConstituents(), getOrCreateConstituentClass(), m_effectiveClasses, and COMPONENT_CLASS::STATIC_AND_DYNAMIC.

Referenced by GetDynamicComponentClassesForFootprint(), and GetEffectiveStaticComponentClass().

◆ GetTicker()

long long int COMPONENT_CLASS_MANAGER::GetTicker ( ) const

inline

Gets the component class validity ticker Used to check validity of cached component classes.

Definition at line 97 of file component_class_manager.h.

References m_ticker.

Referenced by COMPONENT_CLASS_CACHE_PROXY::GetComponentClass(), and COMPONENT_CLASS_CACHE_PROXY::RecomputeComponentClass().

◆ HasCustomAssignmentConditions()

bool COMPONENT_CLASS_MANAGER::HasCustomAssignmentConditions ( ) const

inline

Determines whether any custom dynamic rules have a custom assignment condition.

Definition at line 108 of file component_class_manager.h.

References m_hasCustomAssignmentConditions.

◆ InitNetlistUpdate()

void COMPONENT_CLASS_MANAGER::InitNetlistUpdate ( )

Prepare the manager for a board update Must be called prior to updating the PCB from the netlist.

Definition at line 81 of file component_class_manager.cpp.

References m_constituentClasses, m_staticClassNamesCache, m_ticker, COMPONENT_CLASS::STATIC, and COMPONENT_CLASS::STATIC_AND_DYNAMIC.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ InvalidateComponentClasses()

void COMPONENT_CLASS_MANAGER::InvalidateComponentClasses ( )

Invalidates any caches component classes and recomputes caches if required.

This will force recomputation of component classes on next access

Definition at line 361 of file component_class_manager.cpp.

References m_ticker.

Referenced by PCB_EDIT_FRAME::OnNetlistChanged(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), and BOARD_COMMIT::Revert().

◆ RebuildRequiredCaches()

void COMPONENT_CLASS_MANAGER::RebuildRequiredCaches ( FOOTPRINT * aFootprint = nullptr ) const

Rebuilds any caches that may be required by custom assignment rules.

Parameters

fp	the footprint to rebuild. If null, rebuilds all footprint caches

Definition at line 496 of file component_class_manager.cpp.

References FOOTPRINT::BuildCourtyardCaches(), BOARD::Footprints(), and m_board.

Referenced by PCB_EDIT_FRAME::OnNetlistChanged(), PCB_EDIT_FRAME::OpenProjectFiles(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), and BOARD_COMMIT::Revert().

◆ sortClassNames()

std::vector< wxString > COMPONENT_CLASS_MANAGER::sortClassNames ( const std::unordered_set< wxString > & classNames )

staticprotected

Sorts the given class names in to canonical order.

Definition at line 406 of file component_class_manager.cpp.

Referenced by GetCombinedComponentClass(), GetDynamicComponentClassesForFootprint(), GetEffectiveStaticComponentClass(), and GetFullClassNameForConstituents().

◆ SyncDynamicComponentClassAssignments()

bool COMPONENT_CLASS_MANAGER::SyncDynamicComponentClassAssignments	(	const std::vector< COMPONENT_CLASS_ASSIGNMENT_DATA > &	aAssignments,
		bool	aGenerateSheetClasses,
		const std::unordered_set< wxString > &	aNewSheetPaths
	)

Synchronises all dynamic component class assignment rules.

Returns: false if rules fail to parse, true if successful

Definition at line 162 of file component_class_manager.cpp.

References CompileAssignmentRule(), COMPONENT_CLASS_ASSIGNMENT_DATA::CUSTOM, COMPONENT_CLASS::DYNAMIC, BOARD::Footprints(), getOrCreateConstituentClass(), COMPONENT_CLASS::GetUsageContext(), m_assignmentRules, m_board, m_constituentClasses, m_effectiveClasses, m_hasCustomAssignmentConditions, m_ticker, COMPONENT_CLASS_ASSIGNMENT_DATA::SetComponentClass(), COMPONENT_CLASS_ASSIGNMENT_DATA::SetCondition(), COMPONENT_CLASS::SetUsageContext(), COMPONENT_CLASS_ASSIGNMENT_DATA::SHEET_NAME, COMPONENT_CLASS::STATIC, and COMPONENT_CLASS::STATIC_AND_DYNAMIC.

Member Data Documentation

◆ m_assignmentRules

std::vector<std::shared_ptr<COMPONENT_CLASS_ASSIGNMENT_RULE> > COMPONENT_CLASS_MANAGER::m_assignmentRules

protected

Active component class assignment rules.

Definition at line 144 of file component_class_manager.h.

Referenced by GetDynamicComponentClassesForFootprint(), and SyncDynamicComponentClassAssignments().

◆ m_board

BOARD* COMPONENT_CLASS_MANAGER::m_board

protected

The board these component classes are assigned to / from.

Definition at line 127 of file component_class_manager.h.

Referenced by ForceComponentClassRecalculation(), RebuildRequiredCaches(), and SyncDynamicComponentClassAssignments().

◆ m_constituentClasses

std::unordered_map<wxString, std::unique_ptr<COMPONENT_CLASS> > COMPONENT_CLASS_MANAGER::m_constituentClasses

protected

All individual component classes from static assignments.

Definition at line 133 of file component_class_manager.h.

Referenced by FinishNetlistUpdate(), GetClassNames(), GetCombinedComponentClass(), getOrCreateConstituentClass(), InitNetlistUpdate(), and SyncDynamicComponentClassAssignments().

◆ m_effectiveClasses

std::unordered_map<wxString, std::unique_ptr<COMPONENT_CLASS> > COMPONENT_CLASS_MANAGER::m_effectiveClasses

protected

Generated effective (composite) static component classes.

Definition at line 136 of file component_class_manager.h.

Referenced by FinishNetlistUpdate(), GetCombinedComponentClass(), getOrCreateEffectiveClass(), and SyncDynamicComponentClassAssignments().

◆ m_hasCustomAssignmentConditions

bool COMPONENT_CLASS_MANAGER::m_hasCustomAssignmentConditions

protected

Quick lookup of presence of custom dynamic assignment conditions.

Definition at line 147 of file component_class_manager.h.

Referenced by HasCustomAssignmentConditions(), and SyncDynamicComponentClassAssignments().

◆ m_noneClass

std::shared_ptr<COMPONENT_CLASS> COMPONENT_CLASS_MANAGER::m_noneClass

protected

The class to represent an unassigned component class.

Definition at line 130 of file component_class_manager.h.

Referenced by COMPONENT_CLASS_MANAGER(), GetEffectiveStaticComponentClass(), GetNoneComponentClass(), and getOrCreateConstituentClass().

◆ m_staticClassNamesCache

std::unordered_set<wxString> COMPONENT_CLASS_MANAGER::m_staticClassNamesCache

protected

Cache of in-use static component class names Used for cleanup following netlist updates.

Definition at line 140 of file component_class_manager.h.

Referenced by FinishNetlistUpdate(), GetEffectiveStaticComponentClass(), and InitNetlistUpdate().

◆ m_ticker

long long int COMPONENT_CLASS_MANAGER::m_ticker { 0 }

protected

Monotonically increasing ticker to test cached component class validity.

Definition at line 150 of file component_class_manager.h.

Referenced by GetTicker(), InitNetlistUpdate(), InvalidateComponentClasses(), and SyncDynamicComponentClassAssignments().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ COMPONENT_CLASS_MANAGER()

Member Function Documentation

◆ CompileAssignmentRule()

◆ FinishNetlistUpdate()

◆ ForceComponentClassRecalculation()

◆ GetClassNames()

◆ GetCombinedComponentClass()

◆ GetDynamicComponentClassesForFootprint()

◆ GetEffectiveStaticComponentClass()

◆ GetFullClassNameForConstituents() [1/2]

◆ GetFullClassNameForConstituents() [2/2]

◆ GetNoneComponentClass()

◆ getOrCreateConstituentClass()

◆ getOrCreateEffectiveClass()

◆ GetTicker()

◆ HasCustomAssignmentConditions()

◆ InitNetlistUpdate()

◆ InvalidateComponentClasses()

◆ RebuildRequiredCaches()

◆ sortClassNames()

◆ SyncDynamicComponentClassAssignments()

Member Data Documentation

◆ m_assignmentRules

◆ m_board

◆ m_constituentClasses

◆ m_effectiveClasses

◆ m_hasCustomAssignmentConditions

◆ m_noneClass

◆ m_staticClassNamesCache

◆ m_ticker