KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SCH_REFERENCE_LIST Class Reference

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_REFERENCEoperator[] (int aIndex)
 
const SCH_REFERENCEoperator[] (int aIndex) const
 
void Clear ()
 
size_t GetCount () const
 
SCH_REFERENCEGetItem (int aIdx)
 
const SCH_REFERENCEGetItem (int aIdx) const
 
void AddItem (const SCH_REFERENCE &aItem)
 
void RemoveItem (unsigned int aIndex)
 Remove an item from the list of references. More...
 
bool Contains (const SCH_REFERENCE &aItem) const
 Return true if aItem exists in this list. More...
 
void SplitReferences ()
 Attempt to split all reference designators into a name (U) and number (1). More...
 
void RemoveAnnotation ()
 Treat all symbols in this list as non-annotated. More...
 
void UpdateAnnotation ()
 Update the symbol references for the schematic project (or the current sheet). More...
 
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. More...
 
void ReannotateDuplicates (const SCH_REFERENCE_LIST &aAdditionalReferences)
 Convenience function for the Paste Unique functionality. More...
 
void AnnotateByOptions (enum ANNOTATE_ORDER_T aSortOption, enum ANNOTATE_ALGO_T aAlgoOption, int aStartNumber, SCH_MULTI_UNIT_REFERENCE_MAP aLockedUnitMap, const SCH_REFERENCE_LIST &aAdditionalRefs, bool aStartAtCurrent)
 Annotate the references by the provided options. More...
 
void Annotate (bool aUseSheetNum, int aSheetIntervalId, int aStartNumber, 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. More...
 
int CheckAnnotation (ANNOTATION_ERROR_HANDLER aErrorHandler)
 Check for annotations errors. More...
 
void SortByXCoordinate ()
 Sort the list of references by X position. More...
 
void SortByYCoordinate ()
 Sort the list of references by Y position. More...
 
void SortByTimeStamp ()
 Sort the flat list by Time Stamp (sheet path + timestamp). More...
 
void SortByRefAndValue ()
 Sort the list of references by value. More...
 
void SortByReferenceOnly ()
 Sort the list of references by reference. More...
 
int FindRef (const wxString &aPath) const
 Search the list for a symbol with a given reference. More...
 
int FindRefByFullPath (const wxString &aFullPath) const
 Search the list for a symbol with the given KIID path (as string). More...
 
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. More...
 
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. More...
 
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. More...
 
std::vector< SCH_SYMBOL_INSTANCEGetSymbolInstances () const
 
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. More...
 

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)
 
static int createFirstFreeRefId (std::vector< int > &aIdList, int aFirstValue)
 Search for the first free reference number in aListId of reference numbers in use. More...
 

Private Attributes

std::vector< SCH_REFERENCEm_flatList
 

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 272 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 583 of file sch_reference_list.h.

◆ iterator

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

Definition at line 582 of file sch_reference_list.h.

Constructor & Destructor Documentation

◆ SCH_REFERENCE_LIST()

SCH_REFERENCE_LIST::SCH_REFERENCE_LIST ( )
inline

Definition at line 275 of file sch_reference_list.h.

Member Function Documentation

◆ AddItem()

◆ Annotate()

void SCH_REFERENCE_LIST::Annotate ( bool  aUseSheetNum,
int  aSheetIntervalId,
int  aStartNumber,
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
aUseSheetNumSet to true to start annotation for each sheet at the sheet number times aSheetIntervalId. Otherwise annotate incrementally.
aSheetIntervalIdThe per sheet reference designator multiplier.
aStartNumberThe number to start with if NOT numbering based on sheet number.
aLockedUnitMapA 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.
aAdditionalRefsAdditional 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.
aStartAtCurrentUse m_numRef for each reference as the start number (overrides aStartNumber)

Definition at line 447 of file sch_reference_list.cpp.

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

Referenced by AnnotateByOptions(), SCH_SHEET_LIST::AnnotatePowerSymbols(), and UpdateAnnotation().

◆ AnnotateByOptions()

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

Annotate the references by the provided options.

Parameters
aSortOptionDefine the annotation order. See ANNOTATE_ORDER_T.
aAlgoOptionDefine the annotation style. See ANNOTATE_ALGO_T.
aStartNumberThe start number for non-sheet-based annotation styles.
appendUndoTrue if the annotation operation should be added to an existing undo, false if it should be separately undo-able.
aLockedUnitMapA 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.
aAdditionalReferencesAdditional references to check for duplicates
aStartAtCurrentUse m_numRef for each reference as the start number (overrides aStartNumber)

Definition at line 405 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 585 of file sch_reference_list.h.

References m_flatList.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol().

◆ begin() [2/2]

const_iterator SCH_REFERENCE_LIST::begin ( ) const
inline

Definition at line 589 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
aErrorHandlerA handler for errors.
Returns
The number of errors found.

Definition at line 646 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_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

◆ Contains()

bool SCH_REFERENCE_LIST::Contains ( const SCH_REFERENCE aItem) const

Return true if aItem exists in this list.

Parameters
aItemReference to check
Returns
true if aItem exists in this list

Definition at line 52 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().

◆ createFirstFreeRefId()

int SCH_REFERENCE_LIST::createFirstFreeRefId ( std::vector< int > &  aIdList,
int  aFirstValue 
)
staticprivate

Search for the first free reference number in aListId of reference numbers in use.

This function just searches for a hole in a list of incremented numbers, this list must be sorted by increasing values and each value can be stored only once. The new value is added to the list.

See also
BuildRefIdInUseList to prepare this list
Parameters
aIdListThe buffer that contains the reference numbers in use.
aFirstValueThe first expected free value
Returns
The first free (not yet used) value.

Definition at line 307 of file sch_reference_list.cpp.

Referenced by Annotate().

◆ end() [1/2]

iterator SCH_REFERENCE_LIST::end ( )
inline

Definition at line 587 of file sch_reference_list.h.

References m_flatList.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol().

◆ end() [2/2]

const_iterator SCH_REFERENCE_LIST::end ( ) const
inline

Definition at line 591 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 595 of file sch_reference_list.h.

References m_flatList.

◆ erase() [2/2]

iterator SCH_REFERENCE_LIST::erase ( iterator  position)
inline

Definition at line 593 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
aIndexThe index of the reference item used for the search pattern.
aMinValueThe minimum value for the current search.
aRequiredUnitsList of units to ensure are free

Definition at line 240 of file sch_reference_list.cpp.

References m_flatList.

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 170 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
aFullPathis the path of the symbol item to search.
Returns
an index in m_flatList if found or -1 if not found.

Definition at line 158 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

◆ GetItem() [1/2]

SCH_REFERENCE & SCH_REFERENCE_LIST::GetItem ( int  aIdx)
inline

◆ GetItem() [2/2]

const SCH_REFERENCE & SCH_REFERENCE_LIST::GetItem ( int  aIdx) const
inline

Definition at line 297 of file sch_reference_list.h.

References m_flatList.

◆ 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
aIndexis the current symbol's index to use for reference prefix filtering.
aIdListis the buffer to fill.
aMinRefIdis the minimum ID value to store. All values < aMinRefId are ignored.

Definition at line 182 of file sch_reference_list.cpp.

References m_flatList, and alg::remove_duplicates().

Referenced by Annotate().

◆ GetSymbolInstances()

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

◆ 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
aRefis the index of a symbol to use for reference prefix and number filtering.

Definition at line 202 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 279 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 284 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
aSortOptionDefine the annotation order. See ANNOTATE_ORDER_T.
aAlgoOptionDefine the annotation style. See ANNOTATE_ALGO_T.
aStartNumberThe start number for non-sheet-based annotation styles.
aAdditionalReferencesAdditional references to check for duplicates
aStartAtCurrentUse m_numRef for each reference as the start number (overrides aStartNumber)
aHierarchyOptional 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 357 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.

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 399 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 342 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
aIndexis the index of the item to be removed.

Definition at line 45 of file sch_reference_list.cpp.

References m_flatList.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences().

◆ 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
spacedAdd spaces between references

Definition at line 911 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 507 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

◆ 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 519 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

◆ 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 491 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

◆ 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 466 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

◆ 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 481 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

◆ 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 331 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(), 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 356 of file sch_reference_list.h.

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

Referenced by SCH_SHEET_LIST::AnnotatePowerSymbols(), and SCH_DRAWING_TOOLS::PlaceSymbol().

Friends And Related Function Documentation

◆ BACK_ANNOTATE

friend class BACK_ANNOTATE
friend

Definition at line 623 of file sch_reference_list.h.

◆ BACK_ANNOTATION

friend class BACK_ANNOTATION
friend

Definition at line 580 of file sch_reference_list.h.

Member Data Documentation

◆ m_flatList


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