|
KiCad PCB EDA Suite
|
A helper to define a symbol's reference designator in a schematic. More...
#include <sch_reference_list.h>
Public Member Functions | |
| SCH_REFERENCE () | |
| SCH_REFERENCE (SCH_SYMBOL *aSymbol, const SCH_SHEET_PATH &aSheetPath) | |
| SCH_SYMBOL * | GetSymbol () const |
| LIB_SYMBOL * | GetLibPart () const |
| const SCH_SHEET_PATH & | GetSheetPath () const |
| SCH_SHEET_PATH & | GetSheetPath () |
| int | GetUnit () const |
| void | SetUnit (int aUnit) |
| bool | IsMultiUnit () const |
| const wxString | GetValue () const |
| void | SetValue (const wxString &aValue) |
| const wxString | GetFootprint () const |
| void | SetFootprint (const wxString &aFP) |
| void | SetSheetNumber (int aSheetNumber) |
| const wxString | GetPath () const |
| const wxString | GetFullPath () const |
| bool | operator< (const SCH_REFERENCE &aRef) const |
| Compare by full path to make std::set work. | |
| void | Annotate () |
| Update the annotation of the symbol according the current object state. | |
| bool | AlwaysAnnotate () const |
| Verify the reference should always be automatically annotated. | |
| void | Split () |
| Attempt to split the reference designator into a name (U) and number (1). | |
| bool | IsSplitNeeded () const |
| Determine if this reference needs to be split or if it likely already has been. | |
| bool | IsSplit () const |
| void | SetRef (const wxString &aReference) |
| wxString | GetRef () const |
| wxString | GetComposedRef () const |
| Return the reference as shown on this sheet path, with its sheet suffix. | |
| const wxString & | GetRefSuffix () const |
| Return the sheet suffix this reference composes with, or empty while it is unannotated. | |
| void | SetRefStr (const std::string &aReference) |
| const char * | GetRefStr () const |
| wxString | GetFullRef () const |
| Return reference name with unit and sheet suffix altogether, as in U12A_M4. | |
| wxString | GetCanonicalRef (bool aIncludeUnit) const |
| Return reference name in canonical format, optionally with unit. | |
| wxString | GetRefNumber () const |
| int | CompareValue (const SCH_REFERENCE &item) const |
| int | CompareRef (const SCH_REFERENCE &item) const |
| int | CompareLibId (const SCH_REFERENCE &item) const |
| bool | IsSameInstance (const SCH_REFERENCE &other) const |
| Return whether this reference refers to the same symbol instance (symbol and sheet) as another. | |
| bool | IsUnitsLocked () |
| void | SetRefNum (int aNum) |
| bool | GetSymbolDNP (const wxString &aVariant=wxEmptyString) const |
| bool | GetSymbolExcludedFromBOM (const wxString &aVariant=wxEmptyString) const |
| bool | GetSymbolExcludedFromSim (const wxString &aVariant=wxEmptyString) const |
| bool | GetSymbolExcludedFromBoard () const |
| bool | GetSymbolExcludedFromPosFiles (const wxString &aVariant=wxEmptyString) const |
| void | SetSymbolDNP (bool aEnable, const wxString &aVariant=wxEmptyString) |
| void | SetSymbolExcludedFromBOM (bool aEnable, const wxString &aVariant=wxEmptyString) |
| void | SetSymbolExcludedFromSim (bool aEnable, const wxString &aVariant=wxEmptyString) |
| void | SetSymbolExcludedFromBoard (bool aEnable) |
| void | SetSymbolExcludedFromPosFiles (bool aEnable, const wxString &aVariant=wxEmptyString) |
Private Member Functions | |
| wxString | formatRefStr (int aNumber) const |
| bool | hasRef () const |
Private Attributes | |
| wxString | m_ref |
| Symbol reference prefix, without number (for IC1, this is IC) ) | |
| wxString | m_refSuffix |
| The suffix the board reference composes with. | |
| SCH_SYMBOL * | m_rootSymbol |
| The symbol associated the reference object. | |
| VECTOR2I | m_symbolPos |
| The physical position of the symbol in schematic used to annotate by X or Y position. | |
| int | m_unit |
| The unit number for symbol with multiple parts per package. | |
| wxString | m_value |
| The symbol value. | |
| wxString | m_footprint |
| The footprint assigned. | |
| SCH_SHEET_PATH | m_sheetPath |
| The sheet path for this reference. | |
| bool | m_isNew |
| True if not yet annotated. | |
| int | m_sheetNum |
| The sheet number for the reference. | |
| KIID | m_symbolUuid |
| UUID of the symbol. | |
| int | m_numRef |
| The numeric part of the reference designator. | |
| wxString | m_numRefStr |
| The numeric part in original string form (may have leading zeroes). | |
| int | m_flag |
Friends | |
| class | SCH_REFERENCE_LIST |
A helper to define a symbol's reference designator in a schematic.
This helper is required in a complex hierarchy because a symbol can be used more than once and its reference depends on the sheet path. This class is used to flatten the schematic hierarchy for annotation, net list generation, and bill of material generation.
Definition at line 77 of file sch_reference_list.h.
|
inline |
Definition at line 80 of file sch_reference_list.h.
References m_flag, m_isNew, m_numRef, m_rootSymbol, m_sheetNum, m_sheetPath, and m_unit.
Referenced by CompareLibId(), CompareRef(), CompareValue(), IsSameInstance(), and operator<().
| SCH_REFERENCE::SCH_REFERENCE | ( | SCH_SYMBOL * | aSymbol, |
| const SCH_SHEET_PATH & | aSheetPath ) |
Definition at line 1151 of file sch_reference_list.cpp.
References SCH_SYMBOL::AddHierarchicalReference(), SCH_SYMBOL::GetBaseRef(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetFootprintFieldText(), SCH_SYMBOL::GetInstance(), SCH_SYMBOL::GetPosition(), SCH_FIELD::GetText(), SCH_ITEM::GetUnit(), SCH_SYMBOL::GetUnitSelection(), SCH_SYMBOL::GetValue(), m_flag, m_footprint, m_isNew, m_numRef, SCH_SYMBOL_INSTANCE::m_Path, SCH_SYMBOL_INSTANCE::m_Reference, m_refSuffix, m_rootSymbol, m_sheetNum, m_sheetPath, m_symbolPos, m_symbolUuid, SCH_SYMBOL_INSTANCE::m_Unit, m_unit, EDA_ITEM::m_Uuid, m_value, SCH_SHEET_PATH::Path(), RAW_VALUE, REFERENCE, RESOLVED, SCH_ITEM::Schematic(), SetRef(), and SCH_SYMBOL::SetRef().
| bool SCH_REFERENCE::AlwaysAnnotate | ( | ) | const |
Verify the reference should always be automatically annotated.
Definition at line 1241 of file sch_reference_list.cpp.
References m_rootSymbol, and m_sheetPath.
Referenced by API_HANDLER_SCH::handlePlaceSymbolFromLibrary().
| void SCH_REFERENCE::Annotate | ( | ) |
Update the annotation of the symbol according the current object state.
Definition at line 1228 of file sch_reference_list.cpp.
References From_UTF8(), GetRef(), GetRefNumber(), m_numRef, m_ref, m_rootSymbol, m_sheetPath, m_unit, and TO_UTF8.
|
inline |
Definition at line 244 of file sch_reference_list.h.
References LIB_ID::compare(), SCH_SYMBOL::GetLibId(), GetSymbol(), and SCH_REFERENCE().
Referenced by SCH_REFERENCE_LIST::Annotate(), AnnotateNewSymbol(), and SCH_REFERENCE_LIST::FindFirstUnusedReference().
|
inline |
Definition at line 230 of file sch_reference_list.h.
References IGNORE_CASE, m_ref, SCH_REFERENCE(), and StrNumCmp().
Referenced by SCH_REFERENCE_LIST::CheckAnnotation(), SCH_REFERENCE_LIST::sortByRefAndValue(), SCH_REFERENCE_LIST::sortByXPosition(), and SCH_REFERENCE_LIST::sortByYPosition().
|
inline |
Definition at line 216 of file sch_reference_list.h.
References CASE_SENSITIVE, m_value, SCH_REFERENCE(), and StrNumCmp().
Referenced by SCH_REFERENCE_LIST::Annotate(), AnnotateNewSymbol(), SCH_REFERENCE_LIST::CheckAnnotation(), SCH_REFERENCE_LIST::FindFirstUnusedReference(), and SCH_REFERENCE_LIST::sortByRefAndValue().
|
private |
Definition at line 1352 of file sch_reference_list.cpp.
References GetLibPart(), and GetSymbol().
Referenced by SCH_REFERENCE_LIST::FindFirstUnusedReference(), and SetRefNum().
|
inline |
Return reference name in canonical format, optionally with unit.
(Canonical form will return "R1" even when the user entered "R001".)
Definition at line 190 of file sch_reference_list.h.
References GetRef(), GetSymbol(), GetUnit(), IsSplit(), m_numRef, m_numRefStr, and SCH_SYMBOL::SubReference().
|
inline |
Return the reference as shown on this sheet path, with its sheet suffix.
Definition at line 168 of file sch_reference_list.h.
References m_rootSymbol, and m_sheetPath.
Referenced by SCH_SHEET_PATH::AppendMultiUnitSymbol(), BACK_ANNOTATE::applyChangelist(), CollectOtherUnits(), findSymbolsAndPins(), IsUnannotatedUnitOccupied(), SCH_REFERENCE_LIST::RenumberBasesUsedBy(), ResolveBackannotatedRefs(), and sheetContainsOnlyWantedItems().
|
inline |
Definition at line 108 of file sch_reference_list.h.
References m_footprint.
Referenced by BACK_ANNOTATE::applyChangelist(), and ERC_TESTER::multiUnitSources().
|
inline |
Definition at line 124 of file sch_reference_list.h.
References m_sheetPath, and m_symbolUuid.
Referenced by operator<().
| wxString SCH_REFERENCE::GetFullRef | ( | ) | const |
Return reference name with unit and sheet suffix altogether, as in U12A_M4.
Definition at line 1205 of file sch_reference_list.cpp.
References GetRef(), GetSymbol(), GetUnit(), hasRef(), IsSplit(), m_numRef, m_numRefStr, m_rootSymbol, and m_sheetPath.
Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().
|
inline |
Definition at line 95 of file sch_reference_list.h.
References m_rootSymbol.
Referenced by SCH_REFERENCE_LIST::CheckAnnotation(), formatRefStr(), IsMultiUnit(), and IsUnitsLocked().
|
inline |
Definition at line 116 of file sch_reference_list.h.
References m_sheetPath.
|
inline |
Definition at line 165 of file sch_reference_list.h.
References m_ref.
Referenced by Annotate(), SCH_SHEET_PATH::AppendMultiUnitSymbol(), BACK_ANNOTATE::applyChangelist(), BACK_ANNOTATE::applyPinSwaps(), buildFullReference(), SCH_REFERENCE_LIST::CheckAnnotation(), SCH_REFERENCE_LIST::FindFirstUnusedReference(), GetCanonicalRef(), GetFullRef(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getItemIdentifier(), REFDES_TRACKER::GetNextRefDesForUnits(), SCH_EDITOR_CONTROL::IncrementAnnotations(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_REFERENCE_LIST::RenumberBasesUsedBy(), SCH_REFERENCE_LIST::sortByReferenceOnly(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch().
|
inline |
Definition at line 208 of file sch_reference_list.h.
References m_numRef, and m_numRefStr.
Referenced by Annotate(), buildFullReference(), findSymbolsAndPins(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getItemIdentifier(), SCH_EDITOR_CONTROL::IncrementAnnotations(), sheetContainsOnlyWantedItems(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch().
|
inline |
Definition at line 183 of file sch_reference_list.h.
References m_ref.
Referenced by REFDES_TRACKER::GetNextRefDesForUnits(), and Split().
|
inline |
Return the sheet suffix this reference composes with, or empty while it is unannotated.
Channels of a reused sheet share a base, so the suffix tells their packages apart.
Definition at line 175 of file sch_reference_list.h.
References empty(), hasRef(), and m_refSuffix.
Referenced by SCH_REFERENCE_LIST::CheckAnnotation(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getItemRefSuffix(), SCH_REFERENCE_LIST::sortByRefAndValue(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch().
|
inline |
Definition at line 99 of file sch_reference_list.h.
References m_sheetPath.
|
inline |
Definition at line 97 of file sch_reference_list.h.
References m_sheetPath.
Referenced by SCH_REFERENCE_LIST::Annotate(), SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::applyChangelist(), BACK_ANNOTATE::applyPinSwaps(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::attributeForcedOnBySheet(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TABLECELL_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getDataStoreKey(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant(), DIALOG_EDIT_SYMBOLS_LIBID::initDlg(), IsSameInstance(), ERC_TESTER::multiUnitSources(), packageMemberKey(), SCH_REFERENCE_LIST::ReannotateByOptions(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), SCH_REFERENCE_LIST::RenumberBasesUsedBy(), ResolveBackannotatedRefs(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars(), and ERC_TESTER::TestAnnotation().
|
inline |
Definition at line 93 of file sch_reference_list.h.
References m_rootSymbol.
Referenced by SCH_REFERENCE_LIST::Annotate(), SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::applyChangelist(), BOOST_AUTO_TEST_CASE(), SCH_REFERENCE_LIST::CheckAnnotation(), BACK_ANNOTATE::checkForUnusedSymbols(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ClearCell(), CollectOtherUnits(), CompareLibId(), findSymbolsAndPins(), formatRefStr(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), GetCanonicalRef(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TABLECELL_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getDataStoreKey(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue(), GetFullRef(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant(), DIALOG_SYMBOL_FIELDS_TABLE::getSymbolReferences(), DIALOG_EDIT_SYMBOLS_LIBID::initDlg(), IsSameInstance(), IsUnannotatedUnitOccupied(), ERC_TESTER::multiUnitSources(), packageMemberKey(), SCH_REFERENCE_LIST::ReannotateByOptions(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), SCH_REFERENCE_LIST::RenumberBasesUsedBy(), ResolveBackannotatedRefs(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RevertRow(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setCellValues(), sharesReusedBase(), ERC_TESTER::TestAnnotation(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences().
| bool SCH_REFERENCE::GetSymbolDNP | ( | const wxString & | aVariant = wxEmptyString | ) | const |
Definition at line 1312 of file sch_reference_list.cpp.
References m_rootSymbol, and m_sheetPath.
Referenced by BOOST_FIXTURE_TEST_CASE(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().
| bool SCH_REFERENCE::GetSymbolExcludedFromBoard | ( | ) | const |
Definition at line 1336 of file sch_reference_list.cpp.
References m_rootSymbol.
Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().
| bool SCH_REFERENCE::GetSymbolExcludedFromBOM | ( | const wxString & | aVariant = wxEmptyString | ) | const |
Definition at line 1320 of file sch_reference_list.cpp.
References m_rootSymbol, and m_sheetPath.
Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().
| bool SCH_REFERENCE::GetSymbolExcludedFromPosFiles | ( | const wxString & | aVariant = wxEmptyString | ) | const |
Definition at line 1344 of file sch_reference_list.cpp.
References m_rootSymbol, and m_sheetPath.
Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().
| bool SCH_REFERENCE::GetSymbolExcludedFromSim | ( | const wxString & | aVariant = wxEmptyString | ) | const |
Definition at line 1328 of file sch_reference_list.cpp.
References m_rootSymbol, and m_sheetPath.
Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().
|
inline |
Definition at line 101 of file sch_reference_list.h.
References m_unit.
Referenced by AnnotateNewSymbol(), BACK_ANNOTATE::applyChangelist(), buildFullReference(), SCH_REFERENCE_LIST::CheckAnnotation(), CollectOtherUnits(), SCH_REFERENCE_LIST::FindFirstUnusedReference(), findSymbolsAndPins(), GetCanonicalRef(), GetFullRef(), IsUnannotatedUnitOccupied(), ERC_TESTER::multiUnitSources(), SCH_DRAWING_TOOLS::PlaceSymbol(), removeUnitConflicts(), and SCH_REFERENCE_LIST::RenumberBasesUsedBy().
|
inline |
Definition at line 105 of file sch_reference_list.h.
References m_value.
Referenced by BACK_ANNOTATE::applyChangelist().
|
inlineprivate |
Definition at line 291 of file sch_reference_list.h.
References IsSplit(), m_isNew, m_numRef, and m_ref.
Referenced by GetFullRef(), and GetRefSuffix().
|
inline |
Definition at line 103 of file sch_reference_list.h.
References GetLibPart(), and LIB_SYMBOL::GetUnitCount().
Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().
|
inline |
Return whether this reference refers to the same symbol instance (symbol and sheet) as another.
Definition at line 253 of file sch_reference_list.h.
References GetSheetPath(), GetSymbol(), SCH_SHEET_PATH::Path(), and SCH_REFERENCE().
Referenced by SCH_REFERENCE_LIST::Annotate().
|
inline |
Definition at line 162 of file sch_reference_list.h.
References IsSplitNeeded().
Referenced by GetCanonicalRef(), GetFullRef(), and hasRef().
| bool SCH_REFERENCE::IsSplitNeeded | ( | ) | const |
Determine if this reference needs to be split or if it likely already has been.
Definition at line 1301 of file sch_reference_list.cpp.
References m_ref.
Referenced by findSymbolsAndPins(), SCH_EDITOR_CONTROL::IncrementAnnotations(), IsSplit(), and sheetContainsOnlyWantedItems().
|
inline |
Definition at line 262 of file sch_reference_list.h.
References GetLibPart(), and LIB_SYMBOL::UnitsLocked().
|
inline |
Compare by full path to make std::set work.
Definition at line 132 of file sch_reference_list.h.
References GetFullPath(), and SCH_REFERENCE().
|
inline |
Definition at line 109 of file sch_reference_list.h.
References m_footprint.
|
inline |
Definition at line 164 of file sch_reference_list.h.
References m_ref.
Referenced by FIELD_CASE_CONFLICT_FIXTURE::buildList(), TEST_ANNOTATION_UNITS_CONFLICTS::createTestReference(), TEST_ANNOTATION_UNITS_INTEGRATION::createTestReference(), TEST_REFDES_TRACKER_UNITS::createTestReference(), SCH_EDITOR_CONTROL::IncrementAnnotations(), and SCH_REFERENCE().
|
inline |
Definition at line 270 of file sch_reference_list.h.
References formatRefStr(), m_numRef, and m_numRefStr.
|
inline |
|
inline |
Definition at line 111 of file sch_reference_list.h.
References m_sheetNum.
Referenced by SCH_SHEET_PATH::AppendMultiUnitSymbol(), SCH_SHEET_PATH::AppendSymbol(), SCH_EDITOR_CONTROL::Paste(), and SCH_REFERENCE_LIST::ReannotateByOptions().
| void SCH_REFERENCE::SetSymbolDNP | ( | bool | aEnable, |
| const wxString & | aVariant = wxEmptyString ) |
Definition at line 1363 of file sch_reference_list.cpp.
References m_rootSymbol, and m_sheetPath.
Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().
| void SCH_REFERENCE::SetSymbolExcludedFromBoard | ( | bool | aEnable | ) |
Definition at line 1387 of file sch_reference_list.cpp.
References m_rootSymbol.
Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().
| void SCH_REFERENCE::SetSymbolExcludedFromBOM | ( | bool | aEnable, |
| const wxString & | aVariant = wxEmptyString ) |
Definition at line 1371 of file sch_reference_list.cpp.
References m_rootSymbol, and m_sheetPath.
Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().
| void SCH_REFERENCE::SetSymbolExcludedFromPosFiles | ( | bool | aEnable, |
| const wxString & | aVariant = wxEmptyString ) |
Definition at line 1395 of file sch_reference_list.cpp.
References m_rootSymbol, and m_sheetPath.
Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().
| void SCH_REFERENCE::SetSymbolExcludedFromSim | ( | bool | aEnable, |
| const wxString & | aVariant = wxEmptyString ) |
Definition at line 1379 of file sch_reference_list.cpp.
References m_rootSymbol, and m_sheetPath.
Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().
|
inline |
Definition at line 102 of file sch_reference_list.h.
References m_unit.
Referenced by AnnotateNewSymbol(), TEST_ANNOTATION_UNITS_CONFLICTS::createTestReference(), TEST_ANNOTATION_UNITS_INTEGRATION::createTestReference(), TEST_REFDES_TRACKER_UNITS::createTestReference(), and SCH_DRAWING_TOOLS::PlaceSymbol().
|
inline |
Definition at line 106 of file sch_reference_list.h.
References m_value.
Referenced by TEST_ANNOTATION_UNITS_CONFLICTS::createTestReference(), TEST_ANNOTATION_UNITS_INTEGRATION::createTestReference(), and TEST_REFDES_TRACKER_UNITS::createTestReference().
| void SCH_REFERENCE::Split | ( | ) |
Attempt to split the reference designator 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 per package that are not already annotated, keeps the unit number the same. E.g. U?A or U?B
Definition at line 1251 of file sch_reference_list.cpp.
References GetRefStr(), m_isNew, m_numRef, m_numRefStr, and SetRefStr().
Referenced by SCH_REFERENCE_LIST::Annotate(), findSymbolsAndPins(), DIALOG_SYMBOL_FIELDS_TABLE::getSymbolReferences(), SCH_EDITOR_CONTROL::IncrementAnnotations(), and sheetContainsOnlyWantedItems().
|
friend |
Definition at line 298 of file sch_reference_list.h.
References SCH_REFERENCE_LIST.
Referenced by SCH_REFERENCE_LIST.
|
private |
Definition at line 317 of file sch_reference_list.h.
Referenced by SCH_REFERENCE(), and SCH_REFERENCE().
|
private |
The footprint assigned.
Definition at line 309 of file sch_reference_list.h.
Referenced by GetFootprint(), SCH_REFERENCE(), and SetFootprint().
|
private |
True if not yet annotated.
Definition at line 311 of file sch_reference_list.h.
Referenced by SCH_REFERENCE_LIST::Annotate(), hasRef(), SCH_REFERENCE_LIST::ReannotateByOptions(), SCH_REFERENCE(), SCH_REFERENCE(), and Split().
|
private |
The numeric part of the reference designator.
Definition at line 314 of file sch_reference_list.h.
Referenced by Annotate(), SCH_REFERENCE_LIST::CheckAnnotation(), GetCanonicalRef(), GetFullRef(), GetRefNumber(), hasRef(), SCH_REFERENCE(), SCH_REFERENCE(), SetRefNum(), and Split().
|
private |
The numeric part in original string form (may have leading zeroes).
Definition at line 315 of file sch_reference_list.h.
Referenced by SCH_REFERENCE_LIST::CheckAnnotation(), GetCanonicalRef(), GetFullRef(), GetRefNumber(), SetRefNum(), and Split().
|
private |
Symbol reference prefix, without number (for IC1, this is IC) )
Definition at line 301 of file sch_reference_list.h.
Referenced by Annotate(), CompareRef(), GetRef(), GetRefStr(), hasRef(), IsSplitNeeded(), SetRef(), and SetRefStr().
|
private |
The suffix the board reference composes with.
Definition at line 302 of file sch_reference_list.h.
Referenced by GetRefSuffix(), and SCH_REFERENCE().
|
private |
The symbol associated the reference object.
Definition at line 303 of file sch_reference_list.h.
Referenced by AlwaysAnnotate(), Annotate(), GetComposedRef(), GetFullRef(), GetLibPart(), GetSymbol(), GetSymbolDNP(), GetSymbolExcludedFromBoard(), GetSymbolExcludedFromBOM(), GetSymbolExcludedFromPosFiles(), GetSymbolExcludedFromSim(), SCH_REFERENCE(), SCH_REFERENCE(), SetSymbolDNP(), SetSymbolExcludedFromBoard(), SetSymbolExcludedFromBOM(), SetSymbolExcludedFromPosFiles(), SetSymbolExcludedFromSim(), and SCH_REFERENCE_LIST::sortBySymbolPtr().
|
private |
The sheet number for the reference.
Definition at line 312 of file sch_reference_list.h.
Referenced by SCH_REFERENCE(), SCH_REFERENCE(), SetSheetNumber(), SCH_REFERENCE_LIST::sortByRefAndValue(), SCH_REFERENCE_LIST::sortByXPosition(), and SCH_REFERENCE_LIST::sortByYPosition().
|
private |
The sheet path for this reference.
Definition at line 310 of file sch_reference_list.h.
Referenced by AlwaysAnnotate(), Annotate(), GetComposedRef(), GetFullPath(), GetFullRef(), GetPath(), GetSheetPath(), GetSheetPath(), GetSymbolDNP(), GetSymbolExcludedFromBOM(), GetSymbolExcludedFromPosFiles(), GetSymbolExcludedFromSim(), SCH_REFERENCE(), SCH_REFERENCE(), SetSymbolDNP(), SetSymbolExcludedFromBOM(), SetSymbolExcludedFromPosFiles(), SetSymbolExcludedFromSim(), and SCH_REFERENCE_LIST::sortByTimeStamp().
|
private |
The physical position of the symbol in schematic used to annotate by X or Y position.
Definition at line 304 of file sch_reference_list.h.
Referenced by SCH_REFERENCE(), SCH_REFERENCE_LIST::sortByRefAndValue(), SCH_REFERENCE_LIST::sortByXPosition(), and SCH_REFERENCE_LIST::sortByYPosition().
|
private |
UUID of the symbol.
Definition at line 313 of file sch_reference_list.h.
Referenced by GetFullPath(), SCH_REFERENCE(), SCH_REFERENCE_LIST::sortByRefAndValue(), SCH_REFERENCE_LIST::sortByReferenceOnly(), SCH_REFERENCE_LIST::sortByTimeStamp(), SCH_REFERENCE_LIST::sortByXPosition(), and SCH_REFERENCE_LIST::sortByYPosition().
|
private |
The unit number for symbol with multiple parts per package.
Definition at line 306 of file sch_reference_list.h.
Referenced by Annotate(), SCH_REFERENCE_LIST::Annotate(), SCH_REFERENCE_LIST::CheckAnnotation(), SCH_REFERENCE_LIST::GetPackageUnits(), GetUnit(), SCH_REFERENCE(), SCH_REFERENCE(), SetUnit(), SCH_REFERENCE_LIST::sortByRefAndValue(), and SCH_REFERENCE_LIST::sortByReferenceOnly().
|
private |
The symbol value.
Definition at line 308 of file sch_reference_list.h.
Referenced by SCH_REFERENCE_LIST::CheckAnnotation(), CompareValue(), GetValue(), SCH_REFERENCE(), and SetValue().