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 ()
 Determine if this reference needs to be split or if it likely already has been.
 
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 GetRefNumber () const
 
int CompareValue (const SCH_REFERENCE &item) const
 
int CompareRef (const SCH_REFERENCE &item) const
 
int CompareLibName (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 ()
 

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

Constructor & Destructor Documentation

◆ SCH_REFERENCE() [1/2]

SCH_REFERENCE::SCH_REFERENCE ( )
inline

Definition at line 79 of file sch_reference_list.h.

References m_flag, m_isNew, m_numRef, m_rootSymbol, m_sheetNum, and m_unit.

◆ SCH_REFERENCE() [2/2]

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

Definition at line 801 of file sch_reference_list.cpp.

References SCH_SYMBOL::GetFootprintFieldText(), SCH_SYMBOL::GetPosition(), SCH_SYMBOL::GetRef(), SCH_SYMBOL::GetUnitSelection(), SCH_SYMBOL::GetValue(), m_flag, m_footprint, m_isNew, m_numRef, m_rootSymbol, m_sheetNum, m_sheetPath, m_symbolPos, m_symbolUuid, m_unit, EDA_ITEM::m_Uuid, m_value, SCH_SYMBOL::SetRef(), SetRef(), and SCH_SYMBOL::SetValueFieldText().

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 843 of file sch_reference_list.cpp.

References SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetRef(), m_rootSymbol, and m_sheetPath.

Referenced by SCH_DRAWING_TOOLS::PlaceSymbol().

◆ Annotate()

void SCH_REFERENCE::Annotate ( )

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

Definition at line 830 of file sch_reference_list.cpp.

References From_UTF8(), GetRef(), GetRefNumber(), m_numRef, m_ref, m_rootSymbol, m_sheetPath, m_unit, SCH_SYMBOL::SetRef(), SCH_ITEM::SetUnit(), SCH_SYMBOL::SetUnitSelection(), and TO_UTF8.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols().

◆ CompareLibName()

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

Definition at line 200 of file sch_reference_list.h.

References UTF8::compare(), SCH_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), and m_rootSymbol.

Referenced by SCH_REFERENCE_LIST::Annotate().

◆ CompareRef()

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

Definition at line 195 of file sch_reference_list.h.

References m_ref.

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

References m_value.

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 967 of file sch_reference_list.cpp.

References GetLibPart(), and GetSymbol().

◆ GetFootprint()

const wxString SCH_REFERENCE::GetFootprint ( ) const
inline

Definition at line 107 of file sch_reference_list.h.

References m_footprint.

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

◆ GetFullPath()

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

Definition at line 123 of file sch_reference_list.h.

References KIID::AsString(), m_sheetPath, m_symbolUuid, and SCH_SHEET_PATH::PathAsString().

Referenced by operator<().

◆ GetFullRef()

wxString SCH_REFERENCE::GetFullRef ( ) const
inline

Return reference name with unit altogether.

Definition at line 169 of file sch_reference_list.h.

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

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ GetLibPart()

LIB_SYMBOL * SCH_REFERENCE::GetLibPart ( ) const
inline

Definition at line 94 of file sch_reference_list.h.

References SCH_SYMBOL::GetLibSymbolRef(), and m_rootSymbol.

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

◆ GetPath()

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

Definition at line 115 of file sch_reference_list.h.

References m_sheetPath, and SCH_SHEET_PATH::PathAsString().

◆ GetRef()

wxString SCH_REFERENCE::GetRef ( ) const
inline

Definition at line 163 of file sch_reference_list.h.

References m_ref.

Referenced by Annotate(), SCH_SHEET_PATH::AppendMultiUnitSymbol(), BACK_ANNOTATE::applyChangelist(), buildFullReference(), SCH_REFERENCE_LIST::CheckAnnotation(), CollectOtherUnits(), findSymbolsAndPins(), GetFullRef(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), SCH_EDITOR_CONTROL::IncrementAnnotations(), sheetContainsOnlyWantedItems(), SCH_REFERENCE_LIST::sortByReferenceOnly(), and FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch().

◆ GetRefNumber()

wxString SCH_REFERENCE::GetRefNumber ( ) const
inline

Definition at line 182 of file sch_reference_list.h.

References m_numRef, and m_numRefStr.

Referenced by Annotate(), buildFullReference(), findSymbolsAndPins(), SCH_EDITOR_CONTROL::IncrementAnnotations(), sheetContainsOnlyWantedItems(), and FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch().

◆ GetRefStr()

const char * SCH_REFERENCE::GetRefStr ( ) const
inline

Definition at line 166 of file sch_reference_list.h.

References m_ref.

Referenced by IsSplitNeeded(), and Split().

◆ GetSheetPath() [1/2]

SCH_SHEET_PATH & SCH_REFERENCE::GetSheetPath ( )
inline

Definition at line 98 of file sch_reference_list.h.

References m_sheetPath.

◆ GetSheetPath() [2/2]

const SCH_SHEET_PATH & SCH_REFERENCE::GetSheetPath ( ) const
inline

Definition at line 96 of file sch_reference_list.h.

References m_sheetPath.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::applyChangelist(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TABLECELL_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), FIELDS_EDITOR_GRID_DATA_MODEL::getFieldShownText(), FIELDS_EDITOR_GRID_DATA_MODEL::GetValue(), DIALOG_EDIT_SYMBOLS_LIBID::initDlg(), IsSameInstance(), DIALOG_ERC::OnRunERCClick(), SCH_REFERENCE_LIST::ReannotateByOptions(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), ERC_TESTER::TestMissingUnits(), and ERC_TESTER::TestMultiunitFootprints().

◆ GetSymbol()

SCH_SYMBOL * SCH_REFERENCE::GetSymbol ( ) const
inline

Definition at line 92 of file sch_reference_list.h.

References m_rootSymbol.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::applyChangelist(), SCH_REFERENCE_LIST::CheckAnnotation(), BACK_ANNOTATE::checkForUnusedSymbols(), CollectOtherUnits(), findSymbolsAndPins(), formatRefStr(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TABLECELL_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), FIELDS_EDITOR_GRID_DATA_MODEL::getFieldShownText(), GetFullRef(), DIALOG_SYMBOL_FIELDS_TABLE::getSymbolReferences(), FIELDS_EDITOR_GRID_DATA_MODEL::GetValue(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), DIALOG_EDIT_SYMBOLS_LIBID::initDlg(), IsSameInstance(), DIALOG_ERC::OnRunERCClick(), SCH_REFERENCE_LIST::ReannotateByOptions(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), FIELDS_EDITOR_GRID_DATA_MODEL::SetValue(), ERC_TESTER::TestMissingUnits(), and ERC_TESTER::TestMultiunitFootprints().

◆ GetUnit()

int SCH_REFERENCE::GetUnit ( ) const
inline

Definition at line 100 of file sch_reference_list.h.

References m_unit.

Referenced by buildFullReference(), SCH_REFERENCE_LIST::CheckAnnotation(), CollectOtherUnits(), findSymbolsAndPins(), GetFullRef(), and ERC_TESTER::TestMissingUnits().

◆ GetValue()

const wxString SCH_REFERENCE::GetValue ( ) const
inline

Definition at line 104 of file sch_reference_list.h.

References m_value.

Referenced by BACK_ANNOTATE::applyChangelist().

◆ IsMultiUnit()

bool SCH_REFERENCE::IsMultiUnit ( ) const
inline

Definition at line 102 of file sch_reference_list.h.

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

Referenced by 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 210 of file sch_reference_list.h.

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

Referenced by SCH_REFERENCE_LIST::Annotate().

◆ IsSplitNeeded()

bool SCH_REFERENCE::IsSplitNeeded ( )

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 903 of file sch_reference_list.cpp.

References GetRefStr().

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

◆ IsUnitsLocked()

bool SCH_REFERENCE::IsUnitsLocked ( )
inline

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

References GetFullPath().

◆ SetFootprint()

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

Definition at line 108 of file sch_reference_list.h.

References m_footprint.

◆ SetRef()

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

Definition at line 162 of file sch_reference_list.h.

References m_ref.

Referenced by SCH_EDITOR_CONTROL::IncrementAnnotations(), and SCH_REFERENCE().

◆ SetRefStr()

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

Definition at line 165 of file sch_reference_list.h.

References m_ref.

Referenced by Split().

◆ SetSheetNumber()

void SCH_REFERENCE::SetSheetNumber ( int  aSheetNumber)
inline

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

◆ SetUnit()

void SCH_REFERENCE::SetUnit ( int  aUnit)
inline

Definition at line 101 of file sch_reference_list.h.

References m_unit.

◆ SetValue()

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

Definition at line 105 of file sch_reference_list.h.

References m_value.

◆ 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 853 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 Function Documentation

◆ SCH_REFERENCE_LIST

friend class SCH_REFERENCE_LIST
friend

Definition at line 231 of file sch_reference_list.h.

Member Data Documentation

◆ m_flag

int SCH_REFERENCE::m_flag
private

Definition at line 249 of file sch_reference_list.h.

Referenced by SCH_REFERENCE().

◆ m_footprint

wxString SCH_REFERENCE::m_footprint
private

The footprint assigned.

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

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

◆ m_numRef

int SCH_REFERENCE::m_numRef
private

The numeric part of the reference designator.

Definition at line 246 of file sch_reference_list.h.

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

◆ m_numRefStr

wxString SCH_REFERENCE::m_numRefStr
private

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

Definition at line 247 of file sch_reference_list.h.

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

◆ m_ref

wxString SCH_REFERENCE::m_ref
private

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

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

Referenced by AlwaysAnnotate(), Annotate(), CompareLibName(), GetLibPart(), GetSymbol(), and SCH_REFERENCE().

◆ m_sheetNum

int SCH_REFERENCE::m_sheetNum
private

The sheet number for the reference.

Definition at line 244 of file sch_reference_list.h.

Referenced by 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 242 of file sch_reference_list.h.

Referenced by AlwaysAnnotate(), Annotate(), GetFullPath(), GetPath(), GetSheetPath(), SCH_REFERENCE(), 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 236 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 245 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 238 of file sch_reference_list.h.

Referenced by Annotate(), SCH_REFERENCE_LIST::Annotate(), SCH_REFERENCE_LIST::CheckAnnotation(), GetUnit(), SCH_REFERENCE_LIST::GetUnitsMatchingRef(), 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 240 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: