KiCad PCB EDA Suite
SCH_REFERENCE Class Reference

Class 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
 
int GetUnit () const
 
void SetSheetNumber (int aSheetNumber)
 
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 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...
 
timestamp_t m_TimeStamp
 The time stamp for the reference. 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

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

Constructor & Destructor Documentation

SCH_REFERENCE::SCH_REFERENCE ( )
inline

Definition at line 79 of file sch_reference_list.h.

79  :
80  m_SheetPath()
81  {
82  m_RootCmp = NULL;
83  m_Entry = NULL;
84  m_Unit = 0;
85  m_TimeStamp = 0;
86  m_IsNew = false;
87  m_Value = NULL;
88  m_NumRef = 0;
89  m_Flag = 0;
90  m_SheetNum = 0;
91  }
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.
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.
timestamp_t m_TimeStamp
The time stamp for the reference.
SCH_SHEET_PATH m_SheetPath
The sheet path for this reference.
bool m_IsNew
True if not yet annotated.
SCH_REFERENCE::SCH_REFERENCE ( SCH_COMPONENT aComponent,
LIB_PART aLibComponent,
SCH_SHEET_PATH aSheetPath 
)

Definition at line 717 of file component_references_lister.cpp.

References SCH_COMPONENT::GetField(), SCH_COMPONENT::GetPosition(), SCH_COMPONENT::GetRef(), EDA_TEXT::GetText(), EDA_ITEM::GetTimeStamp(), SCH_COMPONENT::GetUnitSelection(), SCH_COMPONENT::SetRef(), EDA_TEXT::SetText(), and VALUE.

719 {
720  wxASSERT( aComponent != NULL );
721 
722  m_RootCmp = aComponent;
723  m_Entry = aLibPart; // Warning: can be nullptr for orphan components
724  // (i.e. with a symbol library not found)
725  m_Unit = aComponent->GetUnitSelection( &aSheetPath );
726  m_SheetPath = aSheetPath;
727  m_IsNew = false;
728  m_Flag = 0;
729  m_TimeStamp = aComponent->GetTimeStamp();
730  m_CmpPos = aComponent->GetPosition();
731  m_SheetNum = 0;
732 
733  if( aComponent->GetRef( &aSheetPath ).IsEmpty() )
734  aComponent->SetRef( &aSheetPath, wxT( "DefRef?" ) );
735 
736  wxString ref = aComponent->GetRef( &aSheetPath );
737  SetRef( ref );
738 
739  m_NumRef = -1;
740 
741  if( aComponent->GetField( VALUE )->GetText().IsEmpty() )
742  aComponent->GetField( VALUE )->SetText( wxT( "~" ) );
743 
744  m_Value = aComponent->GetField( VALUE );
745 }
wxPoint m_CmpPos
The physical position of the component in schematic used to annotate by X or Y position.
int m_NumRef
The numeric part of the reference designator.
int GetUnitSelection(SCH_SHEET_PATH *aSheet)
int m_SheetNum
The sheet number for the reference.
int m_Unit
The unit number for components with multiple parts per package.
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
SCH_COMPONENT * m_RootCmp
The component associated the reference object.
EDA_TEXT * m_Value
The component value of the reference.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:143
LIB_PART * m_Entry
The source component from a library.
const wxString GetRef(const SCH_SHEET_PATH *aSheet)
Return the reference for the given sheet path.
timestamp_t m_TimeStamp
The time stamp for the reference.
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)
#define VALUE
timestamp_t GetTimeStamp() const
Definition: base_struct.h:207
bool m_IsNew
True if not yet annotated.
virtual void SetText(const wxString &aText)
Definition: eda_text.h:154

Member Function Documentation

void SCH_REFERENCE::Annotate ( )

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

Definition at line 748 of file component_references_lister.cpp.

References FROM_UTF8(), and TO_UTF8.

Referenced by SetSheetNumber(), and SCH_REFERENCE_LIST::UpdateAnnotation().

749 {
750  if( m_NumRef < 0 )
751  m_Ref += '?';
752  else
753  {
754  m_Ref = TO_UTF8( GetRef() << GetRefNumber() );
755  }
756 
760 }
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:53
UTF8 m_Ref
Component reference prefix, without number (for IC1, this is IC) )
int m_NumRef
The numeric part of the reference designator.
void SetUnitSelection(SCH_SHEET_PATH *aSheet, int aUnitSelection)
int m_Unit
The unit number for components with multiple parts per package.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
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.
wxString GetRef() const
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
const char * c_str() const
Definition: utf8.h:107
wxString GetRefNumber() const
int SCH_REFERENCE::CompareLibName ( const SCH_REFERENCE item) const
inline

Definition at line 169 of file sch_reference_list.h.

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

Referenced by SCH_REFERENCE_LIST::Annotate().

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

Definition at line 164 of file sch_reference_list.h.

References UTF8::compare(), and m_Ref.

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

165  {
166  return m_Ref.compare( item.m_Ref );
167  }
UTF8 m_Ref
Component reference prefix, without number (for IC1, this is IC) )
int compare(const std::string &s) const
Definition: utf8.h:116
int SCH_REFERENCE::CompareValue ( const SCH_REFERENCE item) const
inline

Definition at line 159 of file sch_reference_list.h.

References EDA_TEXT::GetText(), and m_Value.

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

160  {
161  return m_Value->GetText().Cmp( item.m_Value->GetText() );
162  }
EDA_TEXT * m_Value
The component value of the reference.
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:143
SCH_COMPONENT* SCH_REFERENCE::GetComp ( ) const
inline
LIB_PART* SCH_REFERENCE::GetLibPart ( ) const
inline

Definition at line 98 of file sch_reference_list.h.

References m_Entry.

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

98 { return m_Entry; }
LIB_PART * m_Entry
The source component from a library.
wxString SCH_REFERENCE::GetRef ( ) const
inline
wxString SCH_REFERENCE::GetRefNumber ( ) const
inline

Definition at line 143 of file sch_reference_list.h.

References GetLibPart(), and m_NumRef.

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

144  {
145  wxString ref;
146 
147  if( m_NumRef < 0 )
148  return wxT( "?" );
149 
150  // To avoid a risk of duplicate, for power components
151  // the ref number is 0nnn instead of nnn.
152  // Just because sometimes only power components are annotated
153  if( GetLibPart() && GetLibPart()->IsPower() )
154  ref = wxT( "0" );
155 
156  return ref << m_NumRef;
157  }
int m_NumRef
The numeric part of the reference designator.
LIB_PART * GetLibPart() const
const char* SCH_REFERENCE::GetRefStr ( ) const
inline

Definition at line 138 of file sch_reference_list.h.

References UTF8::c_str().

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

Definition at line 100 of file sch_reference_list.h.

References m_SheetPath.

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

100 { return m_SheetPath; }
SCH_SHEET_PATH m_SheetPath
The sheet path for this reference.
int SCH_REFERENCE::GetUnit ( ) const
inline

Definition at line 102 of file sch_reference_list.h.

References m_Unit.

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

102 { return m_Unit; }
int m_Unit
The unit number for components with multiple parts per package.
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 180 of file sch_reference_list.h.

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

Referenced by SCH_REFERENCE_LIST::Annotate().

181  {
182  return GetComp() == other.GetComp() && GetSheetPath().Path() == other.GetSheetPath().Path();
183  }
wxString Path() const
Function Path the path uses the time stamps which do not changes even when editing sheet parameters a...
SCH_COMPONENT * GetComp() const
const SCH_SHEET_PATH & GetSheetPath() const
bool SCH_REFERENCE::IsUnitsLocked ( )
inline

Definition at line 185 of file sch_reference_list.h.

References LIB_PART::UnitsLocked().

186  {
187  return m_Entry->UnitsLocked();
188  }
bool UnitsLocked() const
Check whether part units are interchangeable.
LIB_PART * m_Entry
The source component from a library.
void SCH_REFERENCE::SetRef ( const wxString &  aReference)
inline

Definition at line 125 of file sch_reference_list.h.

126  {
127  m_Ref = aReference;
128  }
UTF8 m_Ref
Component reference prefix, without number (for IC1, this is IC) )
void SCH_REFERENCE::SetRefStr ( const std::string &  aReference)
inline

Definition at line 134 of file sch_reference_list.h.

135  {
136  m_Ref = aReference;
137  }
UTF8 m_Ref
Component reference prefix, without number (for IC1, this is IC) )
void SCH_REFERENCE::SetSheetNumber ( int  aSheetNumber)
inline

Definition at line 104 of file sch_reference_list.h.

References Annotate(), and Split().

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

104 { m_SheetNum = aSheetNumber; }
int m_SheetNum
The sheet number for the reference.
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 763 of file component_references_lister.cpp.

Referenced by SetSheetNumber(), and SCH_REFERENCE_LIST::SplitReferences().

764 {
765  std::string refText = GetRefStr();
766 
767  m_NumRef = -1;
768 
769  int ll = refText.length() - 1;
770 
771  if( refText[ll] == '?' )
772  {
773  m_IsNew = true;
774 
775  if( !IsUnitsLocked() )
776  m_Unit = 0x7FFFFFFF;
777 
778  refText.erase( ll ); // delete last char
779 
780  SetRefStr( refText );
781  }
782  else if( isdigit( refText[ll] ) == 0 )
783  {
784  m_IsNew = true;
785 
786  if( !IsUnitsLocked() )
787  m_Unit = 0x7FFFFFFF;
788  }
789  else
790  {
791  while( ll >= 0 )
792  {
793  if( (refText[ll] <= ' ' ) || isdigit( refText[ll] ) )
794  ll--;
795  else
796  {
797  if( isdigit( refText[ll + 1] ) )
798  {
799  // null terminated C string into cp
800  const char* cp = refText.c_str() + ll + 1;
801 
802  m_NumRef = atoi( cp );
803  }
804 
805  refText.erase( ll+1 ); // delete from ll+1 to end
806  break;
807  }
808  }
809 
810  SetRefStr( refText );
811  }
812 }
const char * GetRefStr() const
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.
bool m_IsNew
True if not yet annotated.

Friends And Related Function Documentation

friend class SCH_REFERENCE_LIST
friend

Definition at line 74 of file sch_reference_list.h.

Member Data Documentation

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

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

LIB_PART* SCH_REFERENCE::m_Entry
private

The source component from a library.

Definition at line 60 of file sch_reference_list.h.

Referenced by GetLibPart().

int SCH_REFERENCE::m_Flag
private

Definition at line 72 of file sch_reference_list.h.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

bool SCH_REFERENCE::m_IsNew
private

True if not yet annotated.

Definition at line 66 of file sch_reference_list.h.

int SCH_REFERENCE::m_NumRef
private

The numeric part of the reference designator.

Definition at line 71 of file sch_reference_list.h.

Referenced by GetRefNumber(), and SCH_REFERENCE_LIST::SortByReferenceOnly().

UTF8 SCH_REFERENCE::m_Ref
private

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

Definition at line 58 of file sch_reference_list.h.

Referenced by CompareRef(), GetRef(), and SCH_REFERENCE_LIST::SortByReferenceOnly().

SCH_COMPONENT* SCH_REFERENCE::m_RootCmp
private

The component associated the reference object.

Definition at line 59 of file sch_reference_list.h.

Referenced by CompareLibName(), GetComp(), and SCH_REFERENCE_LIST::sortByReferenceOnly().

int SCH_REFERENCE::m_SheetNum
private

The sheet number for the reference.

Definition at line 67 of file sch_reference_list.h.

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

SCH_SHEET_PATH SCH_REFERENCE::m_SheetPath
private

The sheet path for this reference.

Definition at line 65 of file sch_reference_list.h.

Referenced by GetSheetPath(), and SCH_REFERENCE_LIST::sortByTimeStamp().

timestamp_t SCH_REFERENCE::m_TimeStamp
private
int SCH_REFERENCE::m_Unit
private

The unit number for components with multiple parts per package.

Definition at line 63 of file sch_reference_list.h.

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

EDA_TEXT* SCH_REFERENCE::m_Value
private

The component value of the reference.

It is the same for all instances.

Definition at line 69 of file sch_reference_list.h.

Referenced by CompareValue().


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