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
 
SCH_SHEET_PATH GetSheetPath () 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
 
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...
 
time_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.
time_t m_TimeStamp
The time stamp for the reference.
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.
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 695 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(), m_CmpPos, m_Entry, m_Flag, m_IsNew, m_NumRef, m_RootCmp, m_SheetNum, m_SheetPath, m_TimeStamp, m_Unit, m_Value, SetRef(), SCH_COMPONENT::SetRef(), EDA_TEXT::SetText(), and VALUE.

697 {
698  wxASSERT( aComponent != NULL && aLibPart != NULL );
699 
700  m_RootCmp = aComponent;
701  m_Entry = aLibPart;
702  m_Unit = aComponent->GetUnitSelection( &aSheetPath );
703  m_SheetPath = aSheetPath;
704  m_IsNew = false;
705  m_Flag = 0;
706  m_TimeStamp = aComponent->GetTimeStamp();
707  m_CmpPos = aComponent->GetPosition();
708  m_SheetNum = 0;
709 
710  if( aComponent->GetRef( &aSheetPath ).IsEmpty() )
711  aComponent->SetRef( &aSheetPath, wxT( "DefRef?" ) );
712 
713  wxString ref = aComponent->GetRef( &aSheetPath );
714  SetRef( ref );
715 
716  m_NumRef = -1;
717 
718  if( aComponent->GetField( VALUE )->GetText().IsEmpty() )
719  aComponent->GetField( VALUE )->SetText( wxT( "~" ) );
720 
721  m_Value = aComponent->GetField( VALUE );
722 }
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.
time_t m_TimeStamp
The time stamp for the reference.
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:130
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.
time_t GetTimeStamp() const
Definition: base_struct.h:204
Field Value of part, i.e. "3.3K".
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)
bool m_IsNew
True if not yet annotated.
virtual void SetText(const wxString &aText)
Definition: eda_text.h:141

Member Function Documentation

void SCH_REFERENCE::Annotate ( )

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

Definition at line 725 of file component_references_lister.cpp.

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

726 {
727  if( m_NumRef < 0 )
728  m_Ref += wxChar( '?' );
729  else
730  m_Ref = TO_UTF8( GetRef() << m_NumRef );
731 
732  m_RootCmp->SetRef( &m_SheetPath, FROM_UTF8( m_Ref.c_str() ) );
735 }
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.
int SCH_REFERENCE::CompareLibName ( const SCH_REFERENCE item) const
inline

Definition at line 153 of file sch_reference_list.h.

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

Referenced by SCH_REFERENCE_LIST::Annotate().

154  {
155  return m_RootCmp->GetLibId().GetLibItemName().compare(
156  item.m_RootCmp->GetLibId().GetLibItemName() );
157  }
SCH_COMPONENT * m_RootCmp
The component associated the reference object.
const UTF8 & GetLibItemName() const
Function GetLibItemName.
Definition: lib_id.h:129
const LIB_ID & GetLibId() const
int SCH_REFERENCE::CompareRef ( const SCH_REFERENCE item) const
inline

Definition at line 148 of file sch_reference_list.h.

References m_Ref.

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

149  {
150  return m_Ref.compare( item.m_Ref );
151  }
UTF8 m_Ref
Component reference prefix, without number (for IC1, this is IC) )
int SCH_REFERENCE::CompareValue ( const SCH_REFERENCE item) const
inline

Definition at line 143 of file sch_reference_list.h.

References EDA_TEXT::GetText(), and m_Value.

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

144  {
145  return m_Value->GetText().Cmp( item.m_Value->GetText() );
146  }
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:130
SCH_COMPONENT* SCH_REFERENCE::GetComp ( ) const
inline

Definition at line 96 of file sch_reference_list.h.

References m_RootCmp.

Referenced by BOM_TABLE_COMPONENT::AddUnit(), IsSameInstance(), and BOM_TABLE_MODEL::SetComponents().

96 { return m_RootCmp; }
SCH_COMPONENT * m_RootCmp
The component associated the reference object.
LIB_PART* SCH_REFERENCE::GetLibPart ( ) const
inline

Definition at line 98 of file sch_reference_list.h.

References m_Entry.

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

Definition at line 130 of file sch_reference_list.h.

References m_Ref.

Referenced by BOM_TABLE_COMPONENT::AddUnit(), Annotate(), SCH_SHEET_PATH::GetMultiUnitComponents(), and SCH_REFERENCE_LIST::sortByReferenceOnly().

131  {
132  return m_Ref;
133  }
UTF8 m_Ref
Component reference prefix, without number (for IC1, this is IC) )
const char* SCH_REFERENCE::GetRefStr ( ) const
inline

Definition at line 138 of file sch_reference_list.h.

Referenced by Split().

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

Definition at line 100 of file sch_reference_list.h.

References m_SheetPath.

Referenced by IsSameInstance().

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.

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

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

Referenced by SCH_REFERENCE_LIST::Annotate().

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

Definition at line 169 of file sch_reference_list.h.

References LIB_PART::UnitsLocked().

Referenced by Split().

170  {
171  return m_Entry->UnitsLocked();
172  }
bool UnitsLocked() const
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.

Referenced by SCH_REFERENCE().

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.

Referenced by Split().

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.

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 738 of file component_references_lister.cpp.

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

739 {
740  std::string refText = GetRefStr();
741 
742  m_NumRef = -1;
743 
744  int ll = refText.length() - 1;
745 
746  if( refText[ll] == '?' )
747  {
748  m_IsNew = true;
749 
750  if( !IsUnitsLocked() )
751  m_Unit = 0x7FFFFFFF;
752 
753  refText.erase( ll ); // delete last char
754 
755  SetRefStr( refText );
756  }
757  else if( isdigit( refText[ll] ) == 0 )
758  {
759  m_IsNew = true;
760 
761  if( !IsUnitsLocked() )
762  m_Unit = 0x7FFFFFFF;
763  }
764  else
765  {
766  while( ll >= 0 )
767  {
768  if( (refText[ll] <= ' ' ) || isdigit( refText[ll] ) )
769  ll--;
770  else
771  {
772  if( isdigit( refText[ll + 1] ) )
773  {
774  // null terminated C string into cp
775  const char* cp = refText.c_str() + ll + 1;
776 
777  m_NumRef = atoi( cp );
778  }
779 
780  refText.erase( ll+1 ); // delete from ll+1 to end
781  break;
782  }
783  }
784 
785  SetRefStr( refText );
786  }
787 }
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(), 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(), and SCH_REFERENCE().

int SCH_REFERENCE::m_Flag
private

Definition at line 72 of file sch_reference_list.h.

Referenced by SCH_REFERENCE().

bool SCH_REFERENCE::m_IsNew
private

True if not yet annotated.

Definition at line 66 of file sch_reference_list.h.

Referenced by SCH_REFERENCE(), and Split().

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 Annotate(), SCH_REFERENCE(), and Split().

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 Annotate(), CompareRef(), and GetRef().

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 Annotate(), CompareLibName(), GetComp(), SCH_REFERENCE(), and SCH_REFERENCE_LIST::sortByReferenceOnly().

int SCH_REFERENCE::m_SheetNum
private
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 Annotate(), GetSheetPath(), SCH_REFERENCE(), and SCH_REFERENCE_LIST::sortByTimeStamp().

time_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 Annotate(), SCH_REFERENCE_LIST::Annotate(), GetUnit(), SCH_REFERENCE(), SCH_REFERENCE_LIST::sortByRefAndValue(), SCH_REFERENCE_LIST::sortByReferenceOnly(), and Split().

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(), and SCH_REFERENCE().


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