Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used more than once and its reference designator is dependent on the sheet path for the same symbol. More...

#include <sch_reference_list.h>

Public Types
typedef std::vector< SCH_REFERENCE >::iterator	iterator

typedef std::vector< SCH_REFERENCE >::const_iterator	const_iterator

Public Member Functions
	SCH_REFERENCE_LIST ()

SCH_REFERENCE &	operator[] (int aIndex)

const SCH_REFERENCE &	operator[] (int aIndex) const

void	Clear ()

size_t	GetCount () const

SCH_REFERENCE &	GetItem (size_t aIdx)

const SCH_REFERENCE &	GetItem (size_t aIdx) const

void	AddItem (const SCH_REFERENCE &aItem)

void	RemoveItem (unsigned int aIndex)
	Remove an item from the list of references.

bool	Contains (const SCH_REFERENCE &aItem) const
	Return true if aItem exists in this list.

void	SplitReferences ()
	Attempt to split all reference designators into a name (U) and number (1).

void	RemoveAnnotation ()
	Treat all symbols in this list as non-annotated.

void	UpdateAnnotation ()
	Update the symbol references for the schematic project (or the current sheet).

void	ReannotateByOptions (ANNOTATE_ORDER_T aSortOption, ANNOTATE_ALGO_T aAlgoOption, int aStartNumber, const SCH_REFERENCE_LIST &aAdditionalRefs, bool aStartAtCurrent, SCH_SHEET_LIST *aHierarchy)
	Forces reannotation of the provided references.

void	ReannotateDuplicates (const SCH_REFERENCE_LIST &aAdditionalReferences)
	Convenience function for the Paste Unique functionality.

void	AnnotateByOptions (enum ANNOTATE_ORDER_T aSortOption, enum ANNOTATE_ALGO_T aAlgoOption, int aStartNumber, const SCH_MULTI_UNIT_REFERENCE_MAP &aLockedUnitMap, const SCH_REFERENCE_LIST &aAdditionalRefs, bool aStartAtCurrent)
	Annotate the references by the provided options.

void	Annotate (bool aUseSheetNum, int aSheetIntervalId, int aStartNumber, const SCH_MULTI_UNIT_REFERENCE_MAP &aLockedUnitMap, const SCH_REFERENCE_LIST &aAdditionalRefs, bool aStartAtCurrent=false)
	Set the reference designators in the list that have not been annotated.

int	CheckAnnotation (ANNOTATION_ERROR_HANDLER aErrorHandler)
	Check for annotations errors.

void	SortByXCoordinate ()
	Sort the list of references by X position.

void	SortByYCoordinate ()
	Sort the list of references by Y position.

void	SortByTimeStamp ()
	Sort the flat list by Time Stamp (sheet path + timestamp).

void	SortByRefAndValue ()
	Sort the list of references by value.

void	SortByReferenceOnly ()
	Sort the list of references by reference.

int	FindRef (const wxString &aPath) const
	Search the list for a symbol with a given reference.

int	FindRefByFullPath (const wxString &aFullPath) const
	Search the list for a symbol with the given KIID path (as string).

void	GetRefsInUse (int aIndex, std::vector< int > &aIdList, int aMinRefId) const
	Add all the reference designator numbers greater than aMinRefId to aIdList skipping the reference at aIndex.

std::vector< int >	GetUnitsMatchingRef (const SCH_REFERENCE &aRef) const
	Return all the unit numbers for a given reference, comparing library reference, value, reference number and reference prefix.

int	FindFirstUnusedReference (const SCH_REFERENCE &aRef, int aMinValue, const std::vector< int > &aRequiredUnits) const
	Return the first unused reference number from the properties given in aRef, ensuring all of the units in aRequiredUnits are also unused.

std::vector< SCH_SYMBOL_INSTANCE >	GetSymbolInstances () const

std::shared_ptr< REFDES_TRACKER >	GetRefDesTracker () const

void	SetRefDesTracker (std::shared_ptr< REFDES_TRACKER > aTracker)

iterator	begin ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

iterator	erase (iterator position)

iterator	erase (iterator first, iterator last)

Static Public Member Functions
static wxString	Shorthand (std::vector< SCH_REFERENCE > aList, const wxString &refDelimiter, const wxString &refRangeDelimiter)
	Return a shorthand string representing all the references in the list.

Static Private Member Functions
static bool	sortByRefAndValue (const SCH_REFERENCE &item1, const SCH_REFERENCE &item2)

static bool	sortByXPosition (const SCH_REFERENCE &item1, const SCH_REFERENCE &item2)

static bool	sortByYPosition (const SCH_REFERENCE &item1, const SCH_REFERENCE &item2)

static bool	sortByTimeStamp (const SCH_REFERENCE &item1, const SCH_REFERENCE &item2)

static bool	sortByReferenceOnly (const SCH_REFERENCE &item1, const SCH_REFERENCE &item2)

Private Attributes
std::vector< SCH_REFERENCE >	m_flatList

std::shared_ptr< REFDES_TRACKER >	m_refDesTracker
	A list of previously used reference designators.

Friends
class	BACK_ANNOTATION

class	BACK_ANNOTATE

Detailed Description

Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used more than once and its reference designator is dependent on the sheet path for the same symbol.

This flattened list is used for netlist generation, BOM generation, and schematic annotation.

Definition at line 274 of file sch_reference_list.h.

Member Typedef Documentation

◆ const_iterator

typedef std::vector<SCH_REFERENCE>::const_iterator SCH_REFERENCE_LIST::const_iterator

Definition at line 598 of file sch_reference_list.h.

◆ iterator

typedef std::vector<SCH_REFERENCE>::iterator SCH_REFERENCE_LIST::iterator

Definition at line 597 of file sch_reference_list.h.

Constructor & Destructor Documentation

◆ SCH_REFERENCE_LIST()

SCH_REFERENCE_LIST::SCH_REFERENCE_LIST ( )

inline

Definition at line 277 of file sch_reference_list.h.

Member Function Documentation

◆ AddItem()

void SCH_REFERENCE_LIST::AddItem ( const SCH_REFERENCE & aItem )

inline

Definition at line 300 of file sch_reference_list.h.

References m_flatList.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences(), Annotate(), SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_EDIT_FRAME::AnnotateSymbols(), SCH_SHEET_PATH::AppendSymbol(), TEST_SCH_REFERENCE_LIST_FIXTURE::getAdditionalRefs(), DIALOG_SYMBOL_FIELDS_TABLE::getSymbolReferences(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), and FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences().

◆ Annotate()

void SCH_REFERENCE_LIST::Annotate	(	bool	aUseSheetNum,
		int	aSheetIntervalId,
		int	aStartNumber,
		const SCH_MULTI_UNIT_REFERENCE_MAP &	aLockedUnitMap,
		const SCH_REFERENCE_LIST &	aAdditionalRefs,
		bool	aStartAtCurrent = `false`
	)

Set the reference designators in the list that have not been annotated.

If a the sheet number is 2 and aSheetIntervalId is 100, then the first reference designator would be 201 and the last reference designator would be 299 when no overlap occurs with sheet number 3. If there are 150 items in sheet number 2, then items are referenced U201 to U351, and items in sheet 3 start from U352

Parameters

aUseSheetNum	Set to true to start annotation for each sheet at the sheet number times aSheetIntervalId. Otherwise annotate incrementally.
aSheetIntervalId	The per sheet reference designator multiplier.
aStartNumber	The number to start with if NOT numbering based on sheet number.
aLockedUnitMap	A SCH_MULTI_UNIT_REFERENCE_MAP of reference designator wxStrings to SCH_REFERENCE_LISTs. May be an empty map. If not empty, any multi-unit parts found in this map will be annotated as a group rather than individually.
aAdditionalRefs	Additional references to use for checking that there a reference designator doesn't already exist. The caller must ensure that none of the references in aAdditionalRefs exist in this list.
aStartAtCurrent	Use m_numRef for each reference as the start number (overrides aStartNumber)

Definition at line 389 of file sch_reference_list.cpp.

References AddItem(), buildFullReference(), SCH_REFERENCE::CompareLibName(), SCH_REFERENCE::CompareValue(), FindFirstUnusedReference(), GetCount(), GetUnitsMatchingRef(), SCH_REFERENCE::IsSameInstance(), m_flatList, SCH_REFERENCE::m_isNew, m_refDesTracker, SCH_REFERENCE::m_unit, and SCH_REFERENCE::Split().

Referenced by AnnotateByOptions(), and UpdateAnnotation().

◆ AnnotateByOptions()

void SCH_REFERENCE_LIST::AnnotateByOptions	(	enum ANNOTATE_ORDER_T	aSortOption,
		enum ANNOTATE_ALGO_T	aAlgoOption,
		int	aStartNumber,
		const SCH_MULTI_UNIT_REFERENCE_MAP &	aLockedUnitMap,
		const SCH_REFERENCE_LIST &	aAdditionalRefs,
		bool	aStartAtCurrent
	)

Annotate the references by the provided options.

Parameters

aSortOption	Define the annotation order. See ANNOTATE_ORDER_T.
aAlgoOption	Define the annotation style. See ANNOTATE_ALGO_T.
aStartNumber	The start number for non-sheet-based annotation styles.
appendUndo	True if the annotation operation should be added to an existing undo, false if it should be separately undo-able.
aLockedUnitMap	A SCH_MULTI_UNIT_REFERENCE_MAP of reference designator wxStrings to SCH_REFERENCE_LISTs. May be an empty map. If not empty, any multi-unit parts found in this map will be annotated as a group rather than individually.
aAdditionalReferences	Additional references to check for duplicates
aStartAtCurrent	Use m_numRef for each reference as the start number (overrides aStartNumber)

Definition at line 347 of file sch_reference_list.cpp.

References Annotate(), INCREMENTAL_BY_REF, SHEET_NUMBER_X_100, SHEET_NUMBER_X_1000, SORT_BY_X_POSITION, SORT_BY_Y_POSITION, SortByXCoordinate(), and SortByYCoordinate().

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), and ReannotateByOptions().

◆ begin() [1/2]

iterator SCH_REFERENCE_LIST::begin ( )

inline

Definition at line 600 of file sch_reference_list.h.

References m_flatList.

Referenced by SCHEMATIC::Contains(), and FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol().

◆ begin() [2/2]

const_iterator SCH_REFERENCE_LIST::begin ( ) const

inline

Definition at line 604 of file sch_reference_list.h.

References m_flatList.

◆ CheckAnnotation()

int SCH_REFERENCE_LIST::CheckAnnotation ( ANNOTATION_ERROR_HANDLER aErrorHandler )

Check for annotations errors.

The following annotation error conditions are tested:

Symbols not annotated.
Symbols having the same reference designator (duplicates).
Symbols with multiple parts per package having different reference designators.
Symbols with multiple parts per package with invalid part count.

Parameters

aErrorHandler A handler for errors.

Returns: The number of errors found.

Definition at line 594 of file sch_reference_list.cpp.

References _, SCH_REFERENCE::CompareRef(), SCH_REFERENCE::CompareValue(), ERCE_DIFFERENT_UNIT_VALUE, ERCE_DUPLICATE_REFERENCE, ERCE_EXTRA_UNITS, ERCE_UNANNOTATED, SCH_REFERENCE::GetLibPart(), SCH_REFERENCE::GetRef(), SCH_REFERENCE::GetSymbol(), SCH_REFERENCE::GetUnit(), LIB_SYMBOL::GetUnitCount(), m_flatList, SCH_REFERENCE::m_numRef, SCH_REFERENCE::m_numRefStr, SCH_REFERENCE::m_unit, SCH_REFERENCE::m_value, SortByRefAndValue(), SplitReferences(), and SCH_SYMBOL::SubReference().

Referenced by SCH_EDIT_FRAME::CheckAnnotate(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), and EESCHEMA_JOBS_HANDLER::JobExportPythonBom().

◆ Clear()

void SCH_REFERENCE_LIST::Clear ( )

inline

Definition at line 290 of file sch_reference_list.h.

References m_flatList.

Referenced by TEST_SCH_REFERENCE_LIST_FIXTURE::loadTestCase(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ Contains()

bool SCH_REFERENCE_LIST::Contains ( const SCH_REFERENCE & aItem ) const

Return true if aItem exists in this list.

Parameters

aItem Reference to check.

Returns: true if aItem exists in this list.

Definition at line 53 of file sch_reference_list.cpp.

References GetCount(), and m_flatList.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences(), SCH_EDIT_FRAME::AnnotateSymbols(), TEST_SCH_REFERENCE_LIST_FIXTURE::getAdditionalRefs(), and FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences().

◆ end() [1/2]

iterator SCH_REFERENCE_LIST::end ( )

inline

Definition at line 602 of file sch_reference_list.h.

References m_flatList.

Referenced by SCHEMATIC::Contains(), and FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol().

◆ end() [2/2]

const_iterator SCH_REFERENCE_LIST::end ( ) const

inline

Definition at line 606 of file sch_reference_list.h.

References m_flatList.

◆ erase() [1/2]

iterator SCH_REFERENCE_LIST::erase	(	iterator	first,
		iterator	last
	)

inline

Definition at line 610 of file sch_reference_list.h.

References m_flatList.

◆ erase() [2/2]

iterator SCH_REFERENCE_LIST::erase ( iterator position )

inline

Definition at line 608 of file sch_reference_list.h.

References m_flatList.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol().

◆ FindFirstUnusedReference()

int SCH_REFERENCE_LIST::FindFirstUnusedReference	(	const SCH_REFERENCE &	aRef,
		int	aMinValue,
		const std::vector< int > &	aRequiredUnits
	)		const

Return the first unused reference number from the properties given in aRef, ensuring all of the units in aRequiredUnits are also unused.

Parameters

aIndex	The index of the reference item used for the search pattern.
aMinValue	The minimum value for the current search.
aRequiredUnits	List of units to ensure are free

Definition at line 241 of file sch_reference_list.cpp.

References m_flatList, and m_refDesTracker.

Referenced by Annotate().

◆ FindRef()

int SCH_REFERENCE_LIST::FindRef ( const wxString & aPath ) const

Search the list for a symbol with a given reference.

Definition at line 171 of file sch_reference_list.cpp.

References m_flatList.

Referenced by BACK_ANNOTATE::getChangeList().

◆ FindRefByFullPath()

int SCH_REFERENCE_LIST::FindRefByFullPath ( const wxString & aFullPath ) const

Search the list for a symbol with the given KIID path (as string).

Parameters

aFullPath is the path of the symbol item to search.

Returns: an index in m_flatList if found or -1 if not found.

Definition at line 159 of file sch_reference_list.cpp.

References m_flatList.

Referenced by BACK_ANNOTATE::getChangeList(), and FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences().

◆ GetCount()

size_t SCH_REFERENCE_LIST::GetCount ( ) const

inline

Definition at line 295 of file sch_reference_list.h.

References m_flatList.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), Annotate(), SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_EDIT_FRAME::CheckAnnotate(), BACK_ANNOTATE::checkForUnusedSymbols(), CollectOtherUnits(), Contains(), SCHEMATIC::ConvertRefsToKIIDs(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), findSymbolsAndPins(), TEST_SCH_REFERENCE_LIST_FIXTURE::getAdditionalRefs(), BACK_ANNOTATE::getChangeList(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TABLECELL_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), FIELDS_EDITOR_GRID_DATA_MODEL::GetDataWidth(), DIALOG_SYMBOL_FIELDS_TABLE::getSymbolReferences(), DIALOG_EDIT_SYMBOLS_LIBID::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_FIELD::OnScintillaCharAdded(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), ReannotateByOptions(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), RemoveAnnotation(), FIELDS_EDITOR_GRID_DATA_MODEL::RemoveColumn(), FIELDS_EDITOR_GRID_DATA_MODEL::RenameColumn(), sheetContainsOnlyWantedItems(), SplitReferences(), ERC_TESTER::TestMissingUnits(), ERC_TESTER::TestMultiunitFootprints(), and UpdateAnnotation().

◆ GetItem() [1/2]

SCH_REFERENCE & SCH_REFERENCE_LIST::GetItem ( size_t aIdx )

inline

Definition at line 297 of file sch_reference_list.h.

References m_flatList.

Referenced by ERC_TESTER::TestMissingUnits(), and ERC_TESTER::TestMultiunitFootprints().

◆ GetItem() [2/2]

const SCH_REFERENCE & SCH_REFERENCE_LIST::GetItem ( size_t aIdx ) const

inline

Definition at line 298 of file sch_reference_list.h.

References m_flatList.

◆ GetRefDesTracker()

std::shared_ptr< REFDES_TRACKER > SCH_REFERENCE_LIST::GetRefDesTracker ( ) const

inline

Definition at line 585 of file sch_reference_list.h.

References m_refDesTracker.

◆ GetRefsInUse()

void SCH_REFERENCE_LIST::GetRefsInUse	(	int	aIndex,
		std::vector< int > &	aIdList,
		int	aMinRefId
	)		const

Add all the reference designator numbers greater than aMinRefId to aIdList skipping the reference at aIndex.

Parameters

aIndex	is the current symbol's index to use for reference prefix filtering.
aIdList	is the buffer to fill.
aMinRefId	is the minimum ID value to store. All values < aMinRefId are ignored.

Definition at line 183 of file sch_reference_list.cpp.

References m_flatList, and alg::remove_duplicates().

◆ GetSymbolInstances()

std::vector< SCH_SYMBOL_INSTANCE > SCH_REFERENCE_LIST::GetSymbolInstances ( ) const

Definition at line 264 of file sch_reference_list.cpp.

References m_flatList, SCH_SYMBOL_INSTANCE::m_Path, SCH_SYMBOL_INSTANCE::m_Reference, and SCH_SYMBOL_INSTANCE::m_Unit.

◆ GetUnitsMatchingRef()

std::vector< int > SCH_REFERENCE_LIST::GetUnitsMatchingRef ( const SCH_REFERENCE & aRef ) const

Return all the unit numbers for a given reference, comparing library reference, value, reference number and reference prefix.

Parameters

aRef	is the index of a symbol to use for reference prefix and number filtering.

Definition at line 203 of file sch_reference_list.cpp.

References m_flatList, SCH_REFERENCE::m_numRef, SCH_REFERENCE::m_unit, and alg::remove_duplicates().

Referenced by Annotate().

◆ operator[]() [1/2]

SCH_REFERENCE & SCH_REFERENCE_LIST::operator[] ( int aIndex )

inline

Definition at line 280 of file sch_reference_list.h.

References m_flatList.

◆ operator[]() [2/2]

const SCH_REFERENCE & SCH_REFERENCE_LIST::operator[] ( int aIndex ) const

inline

Definition at line 285 of file sch_reference_list.h.

References m_flatList.

◆ ReannotateByOptions()

void SCH_REFERENCE_LIST::ReannotateByOptions	(	ANNOTATE_ORDER_T	aSortOption,
		ANNOTATE_ALGO_T	aAlgoOption,
		int	aStartNumber,
		const SCH_REFERENCE_LIST &	aAdditionalRefs,
		bool	aStartAtCurrent,
		SCH_SHEET_LIST *	aHierarchy
	)

Forces reannotation of the provided references.

Will also reannotate associated multi-unit symbols.

Parameters

aSortOption	Define the annotation order. See ANNOTATE_ORDER_T.
aAlgoOption	Define the annotation style. See ANNOTATE_ALGO_T.
aStartNumber	The start number for non-sheet-based annotation styles.
aAdditionalReferences	Additional references to check for duplicates
aStartAtCurrent	Use m_numRef for each reference as the start number (overrides aStartNumber)
aHierarchy	Optional sheet path hierarchy for resetting the references' sheet numbers based on their sheet's place in the hierarchy. Set nullptr if not desired.

Definition at line 297 of file sch_reference_list.cpp.

References AnnotateByOptions(), SCH_SHEET_LIST::FindSheetForPath(), GetCount(), SCH_SYMBOL::GetRef(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), m_flatList, SCH_REFERENCE::m_isNew, path, SCH_REFERENCE::SetSheetNumber(), and SplitReferences().

Referenced by SCH_DRAWING_TOOLS::PlaceSymbol(), and ReannotateDuplicates().

◆ ReannotateDuplicates()

void SCH_REFERENCE_LIST::ReannotateDuplicates ( const SCH_REFERENCE_LIST & aAdditionalReferences )

Convenience function for the Paste Unique functionality.

Note: Do not use as a general reannotation method.

Replaces any duplicate reference designators with the next available number after the present number regardless of configured annotation options.

Multi-unit symbols are reannotated together.

Definition at line 341 of file sch_reference_list.cpp.

References INCREMENTAL_BY_REF, ReannotateByOptions(), and UNSORTED.

◆ RemoveAnnotation()

void SCH_REFERENCE_LIST::RemoveAnnotation ( )

inline

Treat all symbols in this list as non-annotated.

Does not update annotation state of the symbols.

See also: SCH_REFERENCE_LIST::UpdateAnnotation()

Definition at line 345 of file sch_reference_list.h.

References GetCount(), and m_flatList.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols().

◆ RemoveItem()

void SCH_REFERENCE_LIST::RemoveItem ( unsigned int aIndex )

Remove an item from the list of references.

Parameters

aIndex is the index of the item to be removed.

Definition at line 46 of file sch_reference_list.cpp.

References m_flatList.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences().

◆ SetRefDesTracker()

void SCH_REFERENCE_LIST::SetRefDesTracker ( std::shared_ptr< REFDES_TRACKER > aTracker )

inline

Definition at line 590 of file sch_reference_list.h.

References m_refDesTracker.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BOOST_AUTO_TEST_CASE(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ Shorthand()

wxString SCH_REFERENCE_LIST::Shorthand	(	std::vector< SCH_REFERENCE >	aList,
		const wxString &	refDelimiter,
		const wxString &	refRangeDelimiter
	)

static

Return a shorthand string representing all the references in the list.

For instance, "R1, R2, R4 - R7, U1"

Parameters

spaced Add spaces between references

Definition at line 861 of file sch_reference_list.cpp.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::GetValue().

◆ SortByRefAndValue()

void SCH_REFERENCE_LIST::SortByRefAndValue ( )

inline

Sort the list of references by value.

Symbols are sorted in the following order:

Numeric value of reference designator.
Value of symbol.
Unit number when symbol has multiple parts.
Sheet number.
X coordinate position.
Y coordinate position.

Definition at line 512 of file sch_reference_list.h.

References m_flatList, and sortByRefAndValue().

Referenced by CheckAnnotation().

◆ sortByRefAndValue()

bool SCH_REFERENCE_LIST::sortByRefAndValue	(	const SCH_REFERENCE &	item1,
		const SCH_REFERENCE &	item2
	)

staticprivate

Definition at line 105 of file sch_reference_list.cpp.

References SCH_REFERENCE::CompareRef(), SCH_REFERENCE::CompareValue(), SCH_REFERENCE::m_sheetNum, SCH_REFERENCE::m_symbolPos, SCH_REFERENCE::m_symbolUuid, SCH_REFERENCE::m_unit, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SortByRefAndValue().

◆ SortByReferenceOnly()

void SCH_REFERENCE_LIST::SortByReferenceOnly ( )

inline

Sort the list of references by reference.

Symbols are sorted in the following order:

Numeric value of reference designator.
Unit number when symbol has multiple parts.

Definition at line 524 of file sch_reference_list.h.

References m_flatList, and sortByReferenceOnly().

Referenced by SCH_EDITOR_CONTROL::Paste(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ sortByReferenceOnly()

bool SCH_REFERENCE_LIST::sortByReferenceOnly	(	const SCH_REFERENCE &	item1,
		const SCH_REFERENCE &	item2
	)

staticprivate

Definition at line 132 of file sch_reference_list.cpp.

References SCH_REFERENCE::GetRef(), SCH_REFERENCE::m_symbolUuid, SCH_REFERENCE::m_unit, and StrNumCmp().

Referenced by SortByReferenceOnly().

◆ SortByTimeStamp()

void SCH_REFERENCE_LIST::SortByTimeStamp ( )

inline

Sort the flat list by Time Stamp (sheet path + timestamp).

Useful to detect duplicate Time Stamps

Definition at line 496 of file sch_reference_list.h.

References m_flatList, and sortByTimeStamp().

Referenced by BACK_ANNOTATE::checkForUnusedSymbols().

◆ sortByTimeStamp()

bool SCH_REFERENCE_LIST::sortByTimeStamp	(	const SCH_REFERENCE &	item1,
		const SCH_REFERENCE &	item2
	)

staticprivate

Definition at line 147 of file sch_reference_list.cpp.

References SCH_SHEET_PATH::Cmp(), SCH_REFERENCE::m_sheetPath, and SCH_REFERENCE::m_symbolUuid.

Referenced by SortByTimeStamp().

◆ SortByXCoordinate()

void SCH_REFERENCE_LIST::SortByXCoordinate ( )

inline

Sort the list of references by X position.

Symbols are sorted as follows:

Numeric value of reference designator.
Sheet number.
X coordinate position.
Y coordinate position.
Time stamp.

Definition at line 471 of file sch_reference_list.h.

References m_flatList, and sortByXPosition().

Referenced by AnnotateByOptions().

◆ sortByXPosition()

bool SCH_REFERENCE_LIST::sortByXPosition	(	const SCH_REFERENCE &	item1,
		const SCH_REFERENCE &	item2
	)

staticprivate

Definition at line 65 of file sch_reference_list.cpp.

References SCH_REFERENCE::CompareRef(), SCH_REFERENCE::m_sheetNum, SCH_REFERENCE::m_symbolPos, SCH_REFERENCE::m_symbolUuid, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SortByXCoordinate().

◆ SortByYCoordinate()

void SCH_REFERENCE_LIST::SortByYCoordinate ( )

inline

Sort the list of references by Y position.

Symbols are sorted as follows:

Numeric value of reference designator.
Sheet number.
Y coordinate position.
X coordinate position.
Time stamp.

Definition at line 486 of file sch_reference_list.h.

References m_flatList, and sortByYPosition().

Referenced by AnnotateByOptions().

◆ sortByYPosition()

bool SCH_REFERENCE_LIST::sortByYPosition	(	const SCH_REFERENCE &	item1,
		const SCH_REFERENCE &	item2
	)

staticprivate

Definition at line 85 of file sch_reference_list.cpp.

References SCH_REFERENCE::CompareRef(), SCH_REFERENCE::m_sheetNum, SCH_REFERENCE::m_symbolPos, SCH_REFERENCE::m_symbolUuid, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SortByYCoordinate().

◆ SplitReferences()

void SCH_REFERENCE_LIST::SplitReferences ( )

inline

Attempt to split all reference designators into a name (U) and number (1).

If the last character is '?' or not a digit, the reference is tagged as not annotated. For symbols with multiple parts, keeps the unit number intact

See also: SCH_REFERENCE::Split()

Definition at line 333 of file sch_reference_list.h.

References GetCount(), and m_flatList.

Referenced by SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_EDIT_FRAME::AnnotateSymbols(), CheckAnnotation(), FIELDS_EDITOR_GRID_DATA_MODEL::FIELDS_EDITOR_GRID_DATA_MODEL(), SCH_EDITOR_CONTROL::IncrementAnnotations(), and ReannotateByOptions().

◆ UpdateAnnotation()

void SCH_REFERENCE_LIST::UpdateAnnotation ( )

inline

Update the symbol references for the schematic project (or the current sheet).

Note: This function does not calculate the reference numbers stored in m_numRef so it must be called after calculation of new reference numbers.

See also: SCH_REFERENCE::Annotate()

Definition at line 359 of file sch_reference_list.h.

References Annotate(), GetCount(), and m_flatList.

Referenced by SCH_DRAWING_TOOLS::PlaceSymbol().

Friends And Related Function Documentation

◆ BACK_ANNOTATE

friend class BACK_ANNOTATE

friend

Definition at line 624 of file sch_reference_list.h.

◆ BACK_ANNOTATION

friend class BACK_ANNOTATION

friend

Definition at line 595 of file sch_reference_list.h.

Member Data Documentation

◆ m_flatList

std::vector<SCH_REFERENCE> SCH_REFERENCE_LIST::m_flatList

private

◆ m_refDesTracker

std::shared_ptr<REFDES_TRACKER> SCH_REFERENCE_LIST::m_refDesTracker

private

A list of previously used reference designators.

Definition at line 628 of file sch_reference_list.h.

Referenced by Annotate(), FindFirstUnusedReference(), GetRefDesTracker(), and SetRefDesTracker().

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

Public Types

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ SCH_REFERENCE_LIST()

Member Function Documentation

◆ AddItem()

◆ Annotate()

◆ AnnotateByOptions()

◆ begin() [1/2]

◆ begin() [2/2]

◆ CheckAnnotation()

◆ Clear()

◆ Contains()

◆ end() [1/2]

◆ end() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ FindFirstUnusedReference()

◆ FindRef()

◆ FindRefByFullPath()

◆ GetCount()

◆ GetItem() [1/2]

◆ GetItem() [2/2]

◆ GetRefDesTracker()

◆ GetRefsInUse()

◆ GetSymbolInstances()

◆ GetUnitsMatchingRef()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ ReannotateByOptions()

◆ ReannotateDuplicates()

◆ RemoveAnnotation()

◆ RemoveItem()

◆ SetRefDesTracker()

◆ Shorthand()

◆ SortByRefAndValue()

◆ sortByRefAndValue()

◆ SortByReferenceOnly()

◆ sortByReferenceOnly()

◆ SortByTimeStamp()

◆ sortByTimeStamp()

◆ SortByXCoordinate()

◆ sortByXPosition()

◆ SortByYCoordinate()

◆ sortByYPosition()

◆ SplitReferences()

◆ UpdateAnnotation()

Friends And Related Function Documentation

◆ BACK_ANNOTATE

◆ BACK_ANNOTATION

Member Data Documentation

◆ m_flatList

◆ m_refDesTracker