KiCad PCB EDA Suite
SCH_REFERENCE Class Reference

SCH_REFERENCE is used as a helper to define a component's reference designator in a schematic. More...

#include <sch_reference_list.h>

Public Member Functions

 SCH_REFERENCE ()
 
 SCH_REFERENCE (SCH_COMPONENT *aComponent, LIB_PART *aLibComponent, SCH_SHEET_PATH &aSheetPath)
 
SCH_COMPONENTGetComp () const
 
LIB_PARTGetLibPart () const
 
const SCH_SHEET_PATHGetSheetPath () const
 
SCH_SHEET_PATHGetSheetPath ()
 
int GetUnit () const
 
void SetSheetNumber (int aSheetNumber)
 
const wxString GetPath () const
 
void Annotate ()
 Function Annotate updates the annotation of the component according the the current object state. More...
 
void Split ()
 Function Split attempts to split the reference designator into a name (U) and number (1). More...
 
void SetRef (const wxString &aReference)
 
wxString GetRef () const
 
void SetRefStr (const std::string &aReference)
 
const char * GetRefStr () const
 
wxString GetFullRef ()
 

Return reference name with unit altogether

More...
 
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
 Function IsSameInstance returns whether this reference refers to the same component instance (component and sheet) as another. More...
 
bool IsUnitsLocked ()
 

Private Attributes

UTF8 m_Ref
 Component reference prefix, without number (for IC1, this is IC) ) More...
 
SCH_COMPONENTm_RootCmp
 The component associated the reference object. More...
 
LIB_PARTm_Entry
 The source component from a library. More...
 
wxPoint m_CmpPos
 The physical position of the component in schematic used to annotate by X or Y position. More...
 
int m_Unit
 The unit number for components with multiple parts per package. More...
 
SCH_SHEET_PATH m_SheetPath
 The sheet path for this reference. More...
 
bool m_IsNew
 True if not yet annotated. More...
 
int m_SheetNum
 The sheet number for the reference. More...
 
KIID m_Uuid
 UUID of the component. More...
 
EDA_TEXTm_Value
 The component value of the reference. More...
 
int m_NumRef
 The numeric part of the reference designator. More...
 
int m_Flag
 

Friends

class SCH_REFERENCE_LIST
 

Detailed Description

SCH_REFERENCE is used as a helper to define a component's reference designator in a schematic.

This helper is required in a complex hierarchy because a component 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 50 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.

74  :
75  m_SheetPath()
76  {
77  m_RootCmp = NULL;
78  m_Entry = NULL;
79  m_Unit = 0;
80  m_IsNew = false;
81  m_Value = NULL;
82  m_NumRef = 0;
83  m_Flag = 0;
84  m_SheetNum = 0;
85  }
int m_NumRef
The numeric part of the reference designator.
int m_SheetNum
The sheet number for the reference.
int m_Unit
The unit number for components with multiple parts per package.
#define NULL
SCH_COMPONENT * m_RootCmp
The component associated the reference object.
EDA_TEXT * m_Value
The component value of the reference.
LIB_PART * m_Entry
The source component from a library.
SCH_SHEET_PATH m_SheetPath
The sheet path for this reference.
bool m_IsNew
True if not yet annotated.

References m_Entry, m_Flag, m_IsNew, m_NumRef, m_RootCmp, m_SheetNum, m_Unit, m_Value, and NULL.

◆ SCH_REFERENCE() [2/2]

SCH_REFERENCE::SCH_REFERENCE ( SCH_COMPONENT aComponent,
LIB_PART aLibComponent,
SCH_SHEET_PATH aSheetPath 
)

Definition at line 652 of file component_references_lister.cpp.

654 {
655  wxASSERT( aComponent != NULL );
656 
657  m_RootCmp = aComponent;
658  m_Entry = aLibPart; // Warning: can be nullptr for orphan components
659  // (i.e. with a symbol library not found)
660  m_Unit = aComponent->GetUnitSelection( &aSheetPath );
661  m_SheetPath = aSheetPath;
662  m_IsNew = false;
663  m_Flag = 0;
664  m_Uuid = aComponent->m_Uuid;
665  m_CmpPos = aComponent->GetPosition();
666  m_SheetNum = 0;
667 
668  if( aComponent->GetRef( &aSheetPath ).IsEmpty() )
669  aComponent->SetRef( &aSheetPath, wxT( "DefRef?" ) );
670 
671  wxString ref = aComponent->GetRef( &aSheetPath );
672  SetRef( ref );
673 
674  m_NumRef = -1;
675 
676  if( aComponent->GetField( VALUE )->GetText().IsEmpty() )
677  aComponent->GetField( VALUE )->SetText( wxT( "~" ) );
678 
679  m_Value = aComponent->GetField( VALUE );
680 }
wxPoint m_CmpPos
The physical position of the component in schematic used to annotate by X or Y position.
KIID m_Uuid
UUID of the component.
int m_NumRef
The numeric part of the reference designator.
int m_SheetNum
The sheet number for the reference.
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
int m_Unit
The unit number for components with multiple parts per package.
#define VALUE
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:111
#define NULL
SCH_COMPONENT * m_RootCmp
The component associated the reference object.
EDA_TEXT * m_Value
The component value of the reference.
LIB_PART * m_Entry
The source component from a library.
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false)
Return the reference for the given sheet path.
const KIID m_Uuid
Definition: base_struct.h:169
SCH_SHEET_PATH m_SheetPath
The sheet path for this reference.
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
wxPoint GetPosition() const override
Function GetPosition.
void SetRef(const wxString &aReference)
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
bool m_IsNew
True if not yet annotated.

References SCH_COMPONENT::GetField(), SCH_COMPONENT::GetPosition(), SCH_COMPONENT::GetRef(), EDA_TEXT::GetText(), SCH_COMPONENT::GetUnitSelection(), m_CmpPos, m_Entry, m_Flag, m_IsNew, m_NumRef, m_RootCmp, m_SheetNum, m_SheetPath, m_Unit, m_Uuid, EDA_ITEM::m_Uuid, m_Value, NULL, SetRef(), SCH_COMPONENT::SetRef(), EDA_TEXT::SetText(), and VALUE.

Member Function Documentation

◆ Annotate()

void SCH_REFERENCE::Annotate ( )

Function Annotate updates the annotation of the component according the the current object state.

Definition at line 683 of file component_references_lister.cpp.

684 {
685  if( m_NumRef < 0 )
686  m_Ref += '?';
687  else
688  m_Ref = TO_UTF8( GetRef() << GetRefNumber() );
689 
693 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:62
UTF8 m_Ref
Component reference prefix, without number (for IC1, this is IC) )
int m_NumRef
The numeric part of the reference designator.
wxString GetRefNumber() const
const char * c_str() const
Definition: utf8.h:107
int m_Unit
The unit number for components with multiple parts per package.
wxString GetRef() const
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
SCH_COMPONENT * m_RootCmp
The component associated the reference object.
void SetUnit(int aUnit)
Change the unit number to aUnit.
SCH_SHEET_PATH m_SheetPath
The sheet path for this reference.
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
void SetUnitSelection(const SCH_SHEET_PATH *aSheet, int aUnitSelection)

References UTF8::c_str(), FROM_UTF8(), GetRef(), GetRefNumber(), m_NumRef, m_Ref, m_RootCmp, m_SheetPath, m_Unit, SCH_COMPONENT::SetRef(), SCH_COMPONENT::SetUnit(), SCH_COMPONENT::SetUnitSelection(), and TO_UTF8.

◆ CompareLibName()

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

Definition at line 179 of file sch_reference_list.h.

180  {
182  item.m_RootCmp->GetLibId().GetLibItemName() );
183  }
int compare(const std::string &s) const
Definition: utf8.h:116
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
SCH_COMPONENT * m_RootCmp
The component associated the reference object.
const LIB_ID & GetLibId() const

References UTF8::compare(), SCH_COMPONENT::GetLibId(), LIB_ID::GetLibItemName(), and m_RootCmp.

Referenced by SCH_REFERENCE_LIST::Annotate().

◆ CompareRef()

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

Definition at line 174 of file sch_reference_list.h.

175  {
176  return m_Ref.compare( item.m_Ref );
177  }
int compare(const std::string &s) const
Definition: utf8.h:116
UTF8 m_Ref
Component reference prefix, without number (for IC1, this is IC) )

References UTF8::compare(), and m_Ref.

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

170  {
171  return m_Value->GetText().Cmp( item.m_Value->GetText() );
172  }
EDA_TEXT * m_Value
The component value of the reference.
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:123

References EDA_TEXT::GetText(), and m_Value.

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

◆ GetComp()

◆ GetFullRef()

wxString SCH_REFERENCE::GetFullRef ( )
inline

Return reference name with unit altogether

Definition at line 145 of file sch_reference_list.h.

146  {
147  if( GetComp()->GetUnitCount() > 1 )
148  return GetRef() + LIB_PART::SubReference( GetUnit() );
149  else
150  return GetRef();
151  }
SCH_COMPONENT * GetComp() const
int GetUnit() const
wxString GetRef() const
static wxString SubReference(int aUnit, bool aAddSeparator=true)

References GetComp(), GetRef(), GetUnit(), and LIB_PART::SubReference().

Referenced by BACK_ANNOTATE::applyChangelist().

◆ GetLibPart()

LIB_PART* SCH_REFERENCE::GetLibPart ( ) const
inline

Definition at line 92 of file sch_reference_list.h.

92 { return m_Entry; }
LIB_PART * m_Entry
The source component from a library.

References m_Entry.

Referenced by GetRefNumber(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

◆ GetPath()

const wxString SCH_REFERENCE::GetPath ( ) const
inline

Definition at line 102 of file sch_reference_list.h.

103  {
105  }
wxString AsString() const
Definition: common.cpp:170
wxString PathAsString() const
Function PathAsString the path uses the time stamps which do not changes even when editing sheet para...
SCH_COMPONENT * m_RootCmp
The component associated the reference object.
const KIID m_Uuid
Definition: base_struct.h:169
SCH_SHEET_PATH m_SheetPath
The sheet path for this reference.

References KIID::AsString(), m_RootCmp, m_SheetPath, EDA_ITEM::m_Uuid, and SCH_SHEET_PATH::PathAsString().

◆ GetRef()

◆ GetRefNumber()

wxString SCH_REFERENCE::GetRefNumber ( ) const
inline

Definition at line 153 of file sch_reference_list.h.

154  {
155  wxString ref;
156 
157  if( m_NumRef < 0 )
158  return wxT( "?" );
159 
160  // To avoid a risk of duplicate, for power components
161  // the ref number is 0nnn instead of nnn.
162  // Just because sometimes only power components are annotated
163  if( GetLibPart() && GetLibPart()->IsPower() )
164  ref = wxT( "0" );
165 
166  return ref << m_NumRef;
167  }
int m_NumRef
The numeric part of the reference designator.
LIB_PART * GetLibPart() const

References GetLibPart(), and m_NumRef.

Referenced by Annotate(), buildFullReference(), FIELDS_EDITOR_GRID_DATA_MODEL::GetValue(), and FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch().

◆ GetRefStr()

const char* SCH_REFERENCE::GetRefStr ( ) const
inline

Definition at line 139 of file sch_reference_list.h.

140  {
141  return m_Ref.c_str();
142  }
UTF8 m_Ref
Component reference prefix, without number (for IC1, this is IC) )
const char * c_str() const
Definition: utf8.h:107

References UTF8::c_str(), and m_Ref.

Referenced by Split().

◆ GetSheetPath() [1/2]

const SCH_SHEET_PATH& SCH_REFERENCE::GetSheetPath ( ) const
inline

Definition at line 94 of file sch_reference_list.h.

94 { return m_SheetPath; }
SCH_SHEET_PATH m_SheetPath
The sheet path for this reference.

References m_SheetPath.

Referenced by BACK_ANNOTATE::applyChangelist(), DIALOG_EDIT_COMPONENTS_LIBID::initDlg(), IsSameInstance(), and TestMultiunitFootprints().

◆ GetSheetPath() [2/2]

SCH_SHEET_PATH& SCH_REFERENCE::GetSheetPath ( )
inline

Definition at line 96 of file sch_reference_list.h.

96 { return m_SheetPath; }
SCH_SHEET_PATH m_SheetPath
The sheet path for this reference.

References m_SheetPath.

◆ GetUnit()

int SCH_REFERENCE::GetUnit ( ) const
inline

Definition at line 98 of file sch_reference_list.h.

98 { return m_Unit; }
int m_Unit
The unit number for components with multiple parts per package.

References m_Unit.

Referenced by buildFullReference(), GetFullRef(), and DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow().

◆ IsSameInstance()

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

Function IsSameInstance returns whether this reference refers to the same component instance (component and sheet) as another.

Definition at line 190 of file sch_reference_list.h.

191  {
192  // JEY TODO: should this be checking unit as well?
193  return GetComp() == other.GetComp()
194  && GetSheetPath().Path() == other.GetSheetPath().Path();
195  }
const SCH_SHEET_PATH & GetSheetPath() const
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
SCH_COMPONENT * GetComp() const

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

Referenced by SCH_REFERENCE_LIST::Annotate().

◆ IsUnitsLocked()

bool SCH_REFERENCE::IsUnitsLocked ( )
inline

Definition at line 197 of file sch_reference_list.h.

198  {
199  return m_Entry->UnitsLocked();
200  }
LIB_PART * m_Entry
The source component from a library.
bool UnitsLocked() const
Check whether part units are interchangeable.

References m_Entry, and LIB_PART::UnitsLocked().

Referenced by Split().

◆ SetRef()

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

Definition at line 126 of file sch_reference_list.h.

127  {
128  m_Ref = aReference;
129  }
UTF8 m_Ref
Component reference prefix, without number (for IC1, this is IC) )

References m_Ref.

Referenced by SCH_REFERENCE().

◆ SetRefStr()

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

Definition at line 135 of file sch_reference_list.h.

136  {
137  m_Ref = aReference;
138  }
UTF8 m_Ref
Component reference prefix, without number (for IC1, this is IC) )

References m_Ref.

Referenced by Split().

◆ SetSheetNumber()

void SCH_REFERENCE::SetSheetNumber ( int  aSheetNumber)
inline

Definition at line 100 of file sch_reference_list.h.

100 { m_SheetNum = aSheetNumber; }
int m_SheetNum
The sheet number for the reference.

References m_SheetNum.

Referenced by SCH_SHEET_PATH::GetComponents(), and SCH_SHEET_PATH::GetMultiUnitComponents().

◆ Split()

void SCH_REFERENCE::Split ( )

Function Split attempts 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 components with multiple parts per package that are not already annotated, set m_Unit to a max value (0x7FFFFFFF).

Definition at line 696 of file component_references_lister.cpp.

697 {
698  std::string refText = GetRefStr();
699 
700  m_NumRef = -1;
701 
702  int ll = refText.length() - 1;
703 
704  if( refText[ll] == '?' )
705  {
706  m_IsNew = true;
707 
708  if( !IsUnitsLocked() )
709  m_Unit = 0x7FFFFFFF;
710 
711  refText.erase( ll ); // delete last char
712 
713  SetRefStr( refText );
714  }
715  else if( isdigit( refText[ll] ) == 0 )
716  {
717  m_IsNew = true;
718 
719  if( !IsUnitsLocked() )
720  m_Unit = 0x7FFFFFFF;
721  }
722  else
723  {
724  while( ll >= 0 )
725  {
726  if( (refText[ll] <= ' ' ) || isdigit( refText[ll] ) )
727  ll--;
728  else
729  {
730  if( isdigit( refText[ll + 1] ) )
731  {
732  // null terminated C string into cp
733  const char* cp = refText.c_str() + ll + 1;
734 
735  m_NumRef = atoi( cp );
736  }
737 
738  refText.erase( ll+1 ); // delete from ll+1 to end
739  break;
740  }
741  }
742 
743  SetRefStr( refText );
744  }
745 }
int m_NumRef
The numeric part of the reference designator.
void SetRefStr(const std::string &aReference)
int m_Unit
The unit number for components with multiple parts per package.
const char * GetRefStr() const
bool m_IsNew
True if not yet annotated.

References GetRefStr(), IsUnitsLocked(), m_IsNew, m_NumRef, m_Unit, and SetRefStr().

Friends And Related Function Documentation

◆ SCH_REFERENCE_LIST

friend class SCH_REFERENCE_LIST
friend

Definition at line 69 of file sch_reference_list.h.

Member Data Documentation

◆ m_CmpPos

wxPoint SCH_REFERENCE::m_CmpPos
private

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

Definition at line 56 of file sch_reference_list.h.

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

◆ m_Entry

LIB_PART* SCH_REFERENCE::m_Entry
private

The source component from a library.

Definition at line 55 of file sch_reference_list.h.

Referenced by GetLibPart(), IsUnitsLocked(), and SCH_REFERENCE().

◆ m_Flag

int SCH_REFERENCE::m_Flag
private

◆ m_IsNew

bool SCH_REFERENCE::m_IsNew
private

True if not yet annotated.

Definition at line 61 of file sch_reference_list.h.

Referenced by SCH_REFERENCE(), and Split().

◆ m_NumRef

int SCH_REFERENCE::m_NumRef
private

The numeric part of the reference designator.

Definition at line 66 of file sch_reference_list.h.

Referenced by Annotate(), GetRefNumber(), SCH_REFERENCE(), and Split().

◆ m_Ref

UTF8 SCH_REFERENCE::m_Ref
private

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

Definition at line 53 of file sch_reference_list.h.

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

◆ m_RootCmp

SCH_COMPONENT* SCH_REFERENCE::m_RootCmp
private

The component associated the reference object.

Definition at line 54 of file sch_reference_list.h.

Referenced by Annotate(), CompareLibName(), GetComp(), GetPath(), and SCH_REFERENCE().

◆ m_SheetNum

int SCH_REFERENCE::m_SheetNum
private

◆ m_SheetPath

SCH_SHEET_PATH SCH_REFERENCE::m_SheetPath
private

The sheet path for this reference.

Definition at line 60 of file sch_reference_list.h.

Referenced by Annotate(), GetPath(), GetSheetPath(), SCH_REFERENCE(), and SCH_REFERENCE_LIST::sortByTimeStamp().

◆ m_Unit

int SCH_REFERENCE::m_Unit
private

The unit number for components with multiple parts per package.

Definition at line 58 of file sch_reference_list.h.

Referenced by Annotate(), SCH_REFERENCE_LIST::Annotate(), GetUnit(), SCH_REFERENCE(), SCH_REFERENCE_LIST::sortByRefAndValue(), SCH_REFERENCE_LIST::sortByReferenceOnly(), and Split().

◆ m_Uuid

◆ m_Value

EDA_TEXT* SCH_REFERENCE::m_Value
private

The component value of the reference.

It is the same for all instances.

Definition at line 64 of file sch_reference_list.h.

Referenced by CompareValue(), and SCH_REFERENCE().


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