KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
SCH_REFERENCE Class Reference

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
 
void SetRefStr (const std::string &aReference)
 
const char * GetRefStr () const
 
wxString GetFullRef () const
 Return reference name with unit altogether.
 
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
 

Private Attributes

wxString m_ref
 Symbol reference prefix, without number (for IC1, this is IC) )
 
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
 

Detailed Description

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

Constructor & Destructor Documentation

◆ SCH_REFERENCE() [1/2]

SCH_REFERENCE::SCH_REFERENCE ( )
inline

Definition at line 74 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() [2/2]

SCH_REFERENCE::SCH_REFERENCE ( SCH_SYMBOL * aSymbol,
const SCH_SHEET_PATH & aSheetPath )

Definition at line 764 of file sch_reference_list.cpp.

References SCH_SYMBOL::AddHierarchicalReference(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetFootprintFieldText(), SCH_SYMBOL::GetInstance(), SCH_SYMBOL::GetPosition(), SCH_SYMBOL::GetRef(), 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_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(), REFERENCE, RESOLVED, SetRef(), and SCH_SYMBOL::SetRef().

Member Function Documentation

◆ AlwaysAnnotate()

bool SCH_REFERENCE::AlwaysAnnotate ( ) const

Verify the reference should always be automatically annotated.

Returns
true if the symbol reference should always be automatically annotated otherwise false.

Definition at line 826 of file sch_reference_list.cpp.

References m_rootSymbol, and m_sheetPath.

Referenced by API_HANDLER_SCH::handlePlaceSymbolFromLibrary(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ Annotate()

void SCH_REFERENCE::Annotate ( )

Update the annotation of the symbol according the current object state.

Definition at line 813 of file sch_reference_list.cpp.

References From_UTF8(), GetRef(), GetRefNumber(), m_numRef, m_ref, m_rootSymbol, m_sheetPath, m_unit, and TO_UTF8.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols().

◆ CompareLibId()

int SCH_REFERENCE::CompareLibId ( const SCH_REFERENCE & item) const
inline

Definition at line 223 of file sch_reference_list.h.

References LIB_ID::compare(), SCH_SYMBOL::GetLibId(), GetSymbol(), and SCH_REFERENCE().

Referenced by SCH_REFERENCE_LIST::Annotate().

◆ CompareRef()

int SCH_REFERENCE::CompareRef ( const SCH_REFERENCE & item) const
inline

Definition at line 217 of file sch_reference_list.h.

References 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().

◆ CompareValue()

int SCH_REFERENCE::CompareValue ( const SCH_REFERENCE & item) const
inline

Definition at line 211 of file sch_reference_list.h.

References m_value, SCH_REFERENCE(), and StrNumCmp().

Referenced by SCH_REFERENCE_LIST::Annotate(), SCH_REFERENCE_LIST::CheckAnnotation(), and SCH_REFERENCE_LIST::sortByRefAndValue().

◆ formatRefStr()

wxString SCH_REFERENCE::formatRefStr ( int aNumber) const
private

Definition at line 939 of file sch_reference_list.cpp.

References GetLibPart(), and GetSymbol().

Referenced by SetRefNum().

◆ GetCanonicalRef()

wxString SCH_REFERENCE::GetCanonicalRef ( bool aIncludeUnit) const
inline

Return reference name in canonical format, optionally with unit.

(Canonical form will return "R1" even when the user entered "R001".)

Definition at line 185 of file sch_reference_list.h.

References GetRef(), GetSymbol(), GetUnit(), IsSplit(), m_numRef, m_numRefStr, and SCH_SYMBOL::SubReference().

◆ GetFootprint()

const wxString SCH_REFERENCE::GetFootprint ( ) const
inline

Definition at line 102 of file sch_reference_list.h.

References m_footprint.

Referenced by BACK_ANNOTATE::applyChangelist(), and ERC_TESTER::multiUnitSources().

◆ GetFullPath()

const wxString SCH_REFERENCE::GetFullPath ( ) const
inline
Returns
the full path of the symbol item

Definition at line 118 of file sch_reference_list.h.

References m_sheetPath, and m_symbolUuid.

Referenced by operator<().

◆ GetFullRef()

wxString SCH_REFERENCE::GetFullRef ( ) const
inline

Return reference name with unit altogether.

Definition at line 165 of file sch_reference_list.h.

References GetRef(), GetSymbol(), GetUnit(), IsSplit(), m_numRef, m_numRefStr, and SCH_SYMBOL::SubReference().

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ GetLibPart()

LIB_SYMBOL * SCH_REFERENCE::GetLibPart ( ) const
inline

Definition at line 89 of file sch_reference_list.h.

References m_rootSymbol.

Referenced by SCH_REFERENCE_LIST::CheckAnnotation(), formatRefStr(), IsMultiUnit(), and IsUnitsLocked().

◆ GetPath()

const wxString SCH_REFERENCE::GetPath ( ) const
inline
Returns
the sheet path containing the symbol item

Definition at line 110 of file sch_reference_list.h.

References m_sheetPath.

◆ GetRef()

wxString SCH_REFERENCE::GetRef ( ) const
inline

Definition at line 159 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(), CollectOtherUnits(), findSymbolsAndPins(), GetCanonicalRef(), GetFullRef(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getItemIdentifier(), REFDES_TRACKER::GetNextRefDesForUnits(), SCH_EDITOR_CONTROL::IncrementAnnotations(), IsUnannotatedUnitOccupied(), SCH_DRAWING_TOOLS::PlaceSymbol(), sheetContainsOnlyWantedItems(), SCH_REFERENCE_LIST::sortByReferenceOnly(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch().

◆ GetRefNumber()

wxString SCH_REFERENCE::GetRefNumber ( ) const
inline

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

◆ GetRefStr()

const char * SCH_REFERENCE::GetRefStr ( ) const
inline

Definition at line 162 of file sch_reference_list.h.

References m_ref.

Referenced by REFDES_TRACKER::GetNextRefDesForUnits(), IsSplitNeeded(), and Split().

◆ GetSheetPath() [1/2]

SCH_SHEET_PATH & SCH_REFERENCE::GetSheetPath ( )
inline

Definition at line 93 of file sch_reference_list.h.

References m_sheetPath.

◆ GetSheetPath() [2/2]

const SCH_SHEET_PATH & SCH_REFERENCE::GetSheetPath ( ) const
inline

Definition at line 91 of file sch_reference_list.h.

References m_sheetPath.

Referenced by 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(), DIALOG_ERC::OnRunERCClick(), SCH_REFERENCE_LIST::ReannotateByOptions(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), SCHEMATIC::resolveCrossReference(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars().

◆ GetSymbol()

SCH_SYMBOL * SCH_REFERENCE::GetSymbol ( ) const
inline

Definition at line 87 of file sch_reference_list.h.

References m_rootSymbol.

Referenced by 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(), DIALOG_ERC::OnRunERCClick(), SCH_REFERENCE_LIST::ReannotateByOptions(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), SCHEMATIC::resolveCrossReference(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RevertRow(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setCellValues(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences().

◆ GetSymbolDNP()

bool SCH_REFERENCE::GetSymbolDNP ( const wxString & aVariant = wxEmptyString) const

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

◆ GetSymbolExcludedFromBoard()

bool SCH_REFERENCE::GetSymbolExcludedFromBoard ( ) const

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

◆ GetSymbolExcludedFromBOM()

bool SCH_REFERENCE::GetSymbolExcludedFromBOM ( const wxString & aVariant = wxEmptyString) const

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

◆ GetSymbolExcludedFromPosFiles()

bool SCH_REFERENCE::GetSymbolExcludedFromPosFiles ( const wxString & aVariant = wxEmptyString) const

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

◆ GetSymbolExcludedFromSim()

bool SCH_REFERENCE::GetSymbolExcludedFromSim ( const wxString & aVariant = wxEmptyString) const

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

◆ GetUnit()

int SCH_REFERENCE::GetUnit ( ) const
inline

Definition at line 95 of file sch_reference_list.h.

References m_unit.

Referenced by BACK_ANNOTATE::applyChangelist(), buildFullReference(), SCH_REFERENCE_LIST::CheckAnnotation(), CollectOtherUnits(), findSymbolsAndPins(), GetCanonicalRef(), GetFullRef(), IsUnannotatedUnitOccupied(), ERC_TESTER::multiUnitSources(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ GetValue()

const wxString SCH_REFERENCE::GetValue ( ) const
inline

Definition at line 99 of file sch_reference_list.h.

References m_value.

Referenced by BACK_ANNOTATE::applyChangelist().

◆ IsMultiUnit()

bool SCH_REFERENCE::IsMultiUnit ( ) const
inline

Definition at line 97 of file sch_reference_list.h.

References GetLibPart(), and LIB_SYMBOL::GetUnitCount().

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ IsSameInstance()

bool SCH_REFERENCE::IsSameInstance ( const SCH_REFERENCE & other) const
inline

Return whether this reference refers to the same symbol instance (symbol and sheet) as another.

Definition at line 232 of file sch_reference_list.h.

References GetSheetPath(), GetSymbol(), SCH_SHEET_PATH::Path(), and SCH_REFERENCE().

Referenced by SCH_REFERENCE_LIST::Annotate().

◆ IsSplit()

bool SCH_REFERENCE::IsSplit ( ) const
inline

Definition at line 156 of file sch_reference_list.h.

References IsSplitNeeded().

Referenced by GetCanonicalRef(), and GetFullRef().

◆ IsSplitNeeded()

bool SCH_REFERENCE::IsSplitNeeded ( ) const

Determine if this reference needs to be split or if it likely already has been.

Returns
true if this reference hasn't been split yet.

Definition at line 886 of file sch_reference_list.cpp.

References GetRefStr().

Referenced by findSymbolsAndPins(), SCH_EDITOR_CONTROL::IncrementAnnotations(), IsSplit(), and sheetContainsOnlyWantedItems().

◆ IsUnitsLocked()

bool SCH_REFERENCE::IsUnitsLocked ( )
inline

Definition at line 241 of file sch_reference_list.h.

References GetLibPart(), and LIB_SYMBOL::UnitsLocked().

◆ operator<()

bool SCH_REFERENCE::operator< ( const SCH_REFERENCE & aRef) const
inline

Compare by full path to make std::set work.

Definition at line 126 of file sch_reference_list.h.

References GetFullPath(), and SCH_REFERENCE().

◆ SetFootprint()

void SCH_REFERENCE::SetFootprint ( const wxString & aFP)
inline

Definition at line 103 of file sch_reference_list.h.

References m_footprint.

◆ SetRef()

void SCH_REFERENCE::SetRef ( const wxString & aReference)
inline

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

◆ SetRefNum()

void SCH_REFERENCE::SetRefNum ( int aNum)
inline

Definition at line 249 of file sch_reference_list.h.

References formatRefStr(), m_numRef, and m_numRefStr.

◆ SetRefStr()

void SCH_REFERENCE::SetRefStr ( const std::string & aReference)
inline

Definition at line 161 of file sch_reference_list.h.

References m_ref.

Referenced by Split().

◆ SetSheetNumber()

void SCH_REFERENCE::SetSheetNumber ( int aSheetNumber)
inline

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

◆ SetSymbolDNP()

void SCH_REFERENCE::SetSymbolDNP ( bool aEnable,
const wxString & aVariant = wxEmptyString )

Definition at line 950 of file sch_reference_list.cpp.

References m_rootSymbol, and m_sheetPath.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetSymbolExcludedFromBoard()

void SCH_REFERENCE::SetSymbolExcludedFromBoard ( bool aEnable)

Definition at line 974 of file sch_reference_list.cpp.

References m_rootSymbol.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetSymbolExcludedFromBOM()

void SCH_REFERENCE::SetSymbolExcludedFromBOM ( bool aEnable,
const wxString & aVariant = wxEmptyString )

Definition at line 958 of file sch_reference_list.cpp.

References m_rootSymbol, and m_sheetPath.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetSymbolExcludedFromPosFiles()

void SCH_REFERENCE::SetSymbolExcludedFromPosFiles ( bool aEnable,
const wxString & aVariant = wxEmptyString )

Definition at line 982 of file sch_reference_list.cpp.

References m_rootSymbol, and m_sheetPath.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetSymbolExcludedFromSim()

void SCH_REFERENCE::SetSymbolExcludedFromSim ( bool aEnable,
const wxString & aVariant = wxEmptyString )

Definition at line 966 of file sch_reference_list.cpp.

References m_rootSymbol, and m_sheetPath.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetUnit()

void SCH_REFERENCE::SetUnit ( int aUnit)
inline

Definition at line 96 of file sch_reference_list.h.

References m_unit.

Referenced by TEST_ANNOTATION_UNITS_CONFLICTS::createTestReference(), TEST_ANNOTATION_UNITS_INTEGRATION::createTestReference(), TEST_REFDES_TRACKER_UNITS::createTestReference(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ SetValue()

void SCH_REFERENCE::SetValue ( const wxString & aValue)
inline

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

◆ Split()

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 836 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().

Friends And Related Symbol Documentation

◆ SCH_REFERENCE_LIST

friend class SCH_REFERENCE_LIST
friend

Definition at line 271 of file sch_reference_list.h.

References SCH_REFERENCE_LIST.

Referenced by SCH_REFERENCE_LIST.

Member Data Documentation

◆ m_flag

int SCH_REFERENCE::m_flag
private

Definition at line 289 of file sch_reference_list.h.

Referenced by SCH_REFERENCE(), and SCH_REFERENCE().

◆ m_footprint

wxString SCH_REFERENCE::m_footprint
private

The footprint assigned.

Definition at line 281 of file sch_reference_list.h.

Referenced by GetFootprint(), SCH_REFERENCE(), and SetFootprint().

◆ m_isNew

bool SCH_REFERENCE::m_isNew
private

True if not yet annotated.

Definition at line 283 of file sch_reference_list.h.

Referenced by SCH_REFERENCE_LIST::Annotate(), SCH_REFERENCE_LIST::ReannotateByOptions(), SCH_REFERENCE(), SCH_REFERENCE(), and Split().

◆ m_numRef

int SCH_REFERENCE::m_numRef
private

The numeric part of the reference designator.

Definition at line 286 of file sch_reference_list.h.

Referenced by Annotate(), SCH_REFERENCE_LIST::CheckAnnotation(), GetCanonicalRef(), GetFullRef(), GetRefNumber(), SCH_REFERENCE_LIST::GetUnitsMatchingRef(), SCH_REFERENCE(), SCH_REFERENCE(), SetRefNum(), and Split().

◆ m_numRefStr

wxString SCH_REFERENCE::m_numRefStr
private

The numeric part in original string form (may have leading zeroes).

Definition at line 287 of file sch_reference_list.h.

Referenced by SCH_REFERENCE_LIST::CheckAnnotation(), GetCanonicalRef(), GetFullRef(), GetRefNumber(), SetRefNum(), and Split().

◆ m_ref

wxString SCH_REFERENCE::m_ref
private

Symbol reference prefix, without number (for IC1, this is IC) )

Definition at line 274 of file sch_reference_list.h.

Referenced by Annotate(), CompareRef(), GetRef(), GetRefStr(), SetRef(), and SetRefStr().

◆ m_rootSymbol

SCH_SYMBOL* SCH_REFERENCE::m_rootSymbol
private

The symbol associated the reference object.

Definition at line 275 of file sch_reference_list.h.

Referenced by AlwaysAnnotate(), Annotate(), GetLibPart(), GetSymbol(), GetSymbolDNP(), GetSymbolExcludedFromBoard(), GetSymbolExcludedFromBOM(), GetSymbolExcludedFromPosFiles(), GetSymbolExcludedFromSim(), SCH_REFERENCE(), SCH_REFERENCE(), SetSymbolDNP(), SetSymbolExcludedFromBoard(), SetSymbolExcludedFromBOM(), SetSymbolExcludedFromPosFiles(), SetSymbolExcludedFromSim(), and SCH_REFERENCE_LIST::sortBySymbolPtr().

◆ m_sheetNum

int SCH_REFERENCE::m_sheetNum
private

The sheet number for the reference.

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

◆ m_sheetPath

SCH_SHEET_PATH SCH_REFERENCE::m_sheetPath
private

The sheet path for this reference.

Definition at line 282 of file sch_reference_list.h.

Referenced by AlwaysAnnotate(), Annotate(), GetFullPath(), GetPath(), GetSheetPath(), GetSheetPath(), GetSymbolDNP(), GetSymbolExcludedFromBOM(), GetSymbolExcludedFromPosFiles(), GetSymbolExcludedFromSim(), SCH_REFERENCE(), SCH_REFERENCE(), SetSymbolDNP(), SetSymbolExcludedFromBOM(), SetSymbolExcludedFromPosFiles(), SetSymbolExcludedFromSim(), and SCH_REFERENCE_LIST::sortByTimeStamp().

◆ m_symbolPos

VECTOR2I SCH_REFERENCE::m_symbolPos
private

The physical position of the symbol in schematic used to annotate by X or Y position.

Definition at line 276 of file sch_reference_list.h.

Referenced by SCH_REFERENCE(), SCH_REFERENCE_LIST::sortByRefAndValue(), SCH_REFERENCE_LIST::sortByXPosition(), and SCH_REFERENCE_LIST::sortByYPosition().

◆ m_symbolUuid

KIID SCH_REFERENCE::m_symbolUuid
private

UUID of the symbol.

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

◆ m_unit

int SCH_REFERENCE::m_unit
private

The unit number for symbol with multiple parts per package.

Definition at line 278 of file sch_reference_list.h.

Referenced by Annotate(), SCH_REFERENCE_LIST::Annotate(), SCH_REFERENCE_LIST::CheckAnnotation(), GetUnit(), SCH_REFERENCE_LIST::GetUnitsMatchingRef(), SCH_REFERENCE(), SCH_REFERENCE(), SetUnit(), SCH_REFERENCE_LIST::sortByRefAndValue(), and SCH_REFERENCE_LIST::sortByReferenceOnly().

◆ m_value

wxString SCH_REFERENCE::m_value
private

The symbol value.

Definition at line 280 of file sch_reference_list.h.

Referenced by SCH_REFERENCE_LIST::CheckAnnotation(), CompareValue(), GetValue(), SCH_REFERENCE(), and SetValue().

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