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, LIB_SYMBOL aLibSymbol, 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)

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

void	Annotate ()
	Update the annotation of the symbol according the current object state. More...

void	Split ()
	Attempt to split the reference designator into a name (U) and number (1). More...

bool	IsSplitNeeded ()
	Determine if this reference needs to be split or if it likely already has been. More...

void	SetRef (const wxString &aReference)

wxString	GetRef () const

void	SetRefStr (const std::string &aReference)

const char *	GetRefStr () const
	Return reference name with unit altogether. More...

wxString	GetFullRef () 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
	Return whether this reference refers to the same symbol instance (symbol and sheet) as another. More...

bool	IsUnitsLocked ()

Private Attributes
wxString	m_ref
	Symbol reference prefix, without number (for IC1, this is IC) ) More...

SCH_SYMBOL *	m_rootSymbol
	The symbol associated the reference object. More...

LIB_SYMBOL *	m_libPart
	The source symbol from a library. More...

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

int	m_unit
	The unit number for symbol with multiple parts per package. More...

wxString	m_value
	The symbol value. More...

wxString	m_footprint
	The footprint assigned. 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_symbolUuid
	UUID of the symbol. More...

int	m_numRef
	The numeric part of the reference designator. More...

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.

 :
 m_sheetPath()
 {
 m_rootSymbol = nullptr;
 m_libPart = nullptr;
 m_unit = 0;
 m_isNew = false;
 m_numRef = 0;
 m_flag = 0;
 m_sheetNum = 0;
 }

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

◆ SCH_REFERENCE() [2/2]

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

Definition at line 810 of file component_references_lister.cpp.

{
 wxASSERT( aSymbol != nullptr );
 
 m_rootSymbol = aSymbol;
 m_libPart = aLibSymbol; // Warning: can be nullptr for orphan symbols
 // (i.e. with a symbol library not found)
 m_unit = aSymbol->GetUnitSelection( &aSheetPath );
 m_footprint = aSymbol->GetFootprintFieldText( true );
 m_sheetPath = aSheetPath;
 m_isNew = false;
 m_flag = 0;
 m_symbolUuid = aSymbol->m_Uuid;
 m_symbolPos = aSymbol->GetPosition();
 m_sheetNum = 0;
 
 if( aSymbol->GetRef( &aSheetPath ).IsEmpty() )
 aSymbol->SetRef( &aSheetPath, wxT( "DefRef?" ) );
 
 wxString ref = aSymbol->GetRef( &aSheetPath );
 SetRef( ref );
 
 m_numRef = -1;
 
 if( aSymbol->GetValueFieldText( false ).IsEmpty() )
 aSymbol->SetValueFieldText( wxT( "~" ) );
 
 m_value = aSymbol->GetValueFieldText( false );
}

References SCH_SYMBOL::GetFootprintFieldText(), SCH_SYMBOL::GetPosition(), SCH_SYMBOL::GetRef(), SCH_SYMBOL::GetUnitSelection(), SCH_SYMBOL::GetValueFieldText(), m_flag, m_footprint, m_isNew, m_libPart, 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

◆ Annotate()

void SCH_REFERENCE::Annotate ( )

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

Definition at line 842 of file component_references_lister.cpp.

{
 if( m_numRef < 0 )
 m_ref += '?';
 else
 m_ref = TO_UTF8( GetRef() << GetRefNumber() );
 
 m_rootSymbol->SetRef( &m_sheetPath, FROM_UTF8( m_ref.c_str() ) );
 m_rootSymbol->SetUnit( m_unit );
 m_rootSymbol->SetUnitSelection( &m_sheetPath, m_unit );
}

References FROM_UTF8(), GetRef(), GetRefNumber(), m_numRef, m_ref, m_rootSymbol, m_sheetPath, m_unit, SCH_SYMBOL::SetRef(), SCH_SYMBOL::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 189 of file sch_reference_list.h.

 {
 return m_rootSymbol->GetLibId().GetLibItemName().compare(
 item.m_rootSymbol->GetLibId().GetLibItemName() );
 }

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

 {
 return m_ref.CmpNoCase( item.m_ref );
 }

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

 {
 return m_value.Cmp( item.m_value );
 }

References m_value.

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

◆ GetFootprint()

const wxString SCH_REFERENCE::GetFootprint ( ) const

inline

Definition at line 107 of file sch_reference_list.h.

107{ return m_footprint; }

References m_footprint.

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

◆ GetFullPath()

const wxString SCH_REFERENCE::GetFullPath ( ) const

inline

Returns: the full patb of the symbol item

Definition at line 123 of file sch_reference_list.h.

 {
 return m_sheetPath.PathAsString() + m_symbolUuid.AsString();
 }

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

◆ GetFullRef()

wxString SCH_REFERENCE::GetFullRef ( ) const

inline

Definition at line 156 of file sch_reference_list.h.

 {
 if( GetSymbol()->GetUnitCount() > 1 )
 return GetRef() + GetRefNumber() + LIB_SYMBOL::SubReference( GetUnit() );
 else
 return GetRef() + GetRefNumber();
 }

References GetRef(), GetRefNumber(), GetSymbol(), GetUnit(), and LIB_SYMBOL::SubReference().

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ GetLibPart()

LIB_SYMBOL * SCH_REFERENCE::GetLibPart ( ) const

inline

Definition at line 95 of file sch_reference_list.h.

95{ return m_libPart; }

References m_libPart.

Referenced by SCH_REFERENCE_LIST::CheckAnnotation(), GetRefNumber(), 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.

 {
 return m_sheetPath.PathAsString();
 }

References m_sheetPath, and SCH_SHEET_PATH::PathAsString().

◆ GetRef()

wxString SCH_REFERENCE::GetRef ( ) const

inline

Definition at line 150 of file sch_reference_list.h.

150{ return m_ref; }

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(), sheetContainsOnlyWantedItems(), SCH_REFERENCE_LIST::sortByReferenceOnly(), and FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch().

◆ GetRefNumber()

wxString SCH_REFERENCE::GetRefNumber ( ) const

inline

Definition at line 164 of file sch_reference_list.h.

 {
 wxString ref;
 
 if( m_numRef < 0 )
 return wxT( "?" );
 
 // To avoid a risk of duplicate, for power symbols the ref number is 0nnn instead of nnn.
 // Just because sometimes only power symbols are annotated
 if( GetLibPart() && GetLibPart()->IsPower() )
 ref = wxT( "0" );
 
 return ref << m_numRef;
 }

References GetLibPart(), and m_numRef.

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

◆ GetRefStr()

const char * SCH_REFERENCE::GetRefStr ( ) const

inline

Return reference name with unit altogether.

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

99{ return m_sheetPath; }

References m_sheetPath.

◆ GetSheetPath() [2/2]

const SCH_SHEET_PATH & SCH_REFERENCE::GetSheetPath ( ) const

inline

Definition at line 97 of file sch_reference_list.h.

97{ return m_sheetPath; }

References m_sheetPath.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::applyChangelist(), DIALOG_EDIT_SYMBOLS_LIBID::initDlg(), IsSameInstance(), DIALOG_ERC::OnRunERCClick(), SCH_REFERENCE_LIST::ReannotateByOptions(), ERC_TESTER::TestMissingUnits(), and ERC_TESTER::TestMultiunitFootprints().

◆ GetSymbol()

SCH_SYMBOL * SCH_REFERENCE::GetSymbol ( ) const

inline

◆ GetUnit()

int SCH_REFERENCE::GetUnit ( ) const

inline

Definition at line 101 of file sch_reference_list.h.

101{ return m_unit; }

References m_unit.

Referenced by buildFullReference(), 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.

104{ return m_value; }

References m_value.

Referenced by BACK_ANNOTATE::applyChangelist().

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

 {
 // Only compare symbol and path.
 // We may have changed the unit number or the designator but
 // can still be referencing the same instance.
 return GetSymbol() == other.GetSymbol()
 && GetSheetPath().Path() == other.GetSheetPath().Path();
 }

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

{
 std::string refText = GetRefStr();
 
 int ll = refText.length() - 1;
 
 return ( refText[ll] == '?' ) || isdigit( refText[ll] );
}

References GetRefStr().

Referenced by findSymbolsAndPins(), and sheetContainsOnlyWantedItems().

◆ IsUnitsLocked()

bool SCH_REFERENCE::IsUnitsLocked ( )

inline

Definition at line 208 of file sch_reference_list.h.

 {
 if( m_libPart )
 return m_libPart->UnitsLocked();
 else
 return true; // Assume units locked when we don't have a library
 }

References m_libPart, and LIB_SYMBOL::UnitsLocked().

◆ SetFootprint()

void SCH_REFERENCE::SetFootprint ( const wxString & aFP )

inline

Definition at line 108 of file sch_reference_list.h.

108{ m_footprint = aFP; }

References m_footprint.

◆ SetRef()

void SCH_REFERENCE::SetRef ( const wxString & aReference )

inline

Definition at line 149 of file sch_reference_list.h.

149{ m_ref = aReference; }

References m_ref.

Referenced by SCH_REFERENCE().

◆ SetRefStr()

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

inline

Definition at line 152 of file sch_reference_list.h.

152{ m_ref = aReference; }

References m_ref.

Referenced by Split().

◆ SetSheetNumber()

void SCH_REFERENCE::SetSheetNumber ( int aSheetNumber )

inline

Definition at line 110 of file sch_reference_list.h.

110{ m_sheetNum = aSheetNumber; }

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

102{ m_unit = aUnit; }

References m_unit.

◆ SetValue()

void SCH_REFERENCE::SetValue ( const wxString & aValue )

inline

Definition at line 105 of file sch_reference_list.h.

105{ m_value = aValue; }

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

{
 std::string refText = GetRefStr();
 
 m_numRef = -1;
 
 int ll = refText.length() - 1;
 
 if( refText[ll] == '?' )
 {
 m_isNew = true;
 
 refText.erase( ll ); // delete last char
 
 SetRefStr( refText );
 }
 else if( isdigit( refText[ll] ) == 0 )
 {
 m_isNew = true;
 }
 else
 {
 while( ll >= 0 )
 {
 if( (refText[ll] <= ' ' ) || isdigit( refText[ll] ) )
 ll--;
 else
 {
 if( isdigit( refText[ll + 1] ) )
 {
 // null terminated C string into cp
 const char* cp = refText.c_str() + ll + 1;
 
 m_numRef = atoi( cp );
 }
 
 refText.erase( ll+1 ); // delete from ll+1 to end
 break;
 }
 }
 
 SetRefStr( refText );
 }
}

References GetRefStr(), m_isNew, m_numRef, and SetRefStr().

Referenced by SCH_REFERENCE_LIST::Annotate(), findSymbolsAndPins(), and sheetContainsOnlyWantedItems().

Friends And Related Function Documentation

◆ SCH_REFERENCE_LIST

friend class SCH_REFERENCE_LIST

friend

Definition at line 217 of file sch_reference_list.h.

Member Data Documentation

◆ m_flag

int SCH_REFERENCE::m_flag

private

Definition at line 234 of file sch_reference_list.h.

Referenced by SCH_REFERENCE().

◆ m_footprint

wxString SCH_REFERENCE::m_footprint

private

The footprint assigned.

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

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

◆ m_libPart

LIB_SYMBOL* SCH_REFERENCE::m_libPart

private

The source symbol from a library.

Definition at line 222 of file sch_reference_list.h.

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

◆ m_numRef

int SCH_REFERENCE::m_numRef

private

The numeric part of the reference designator.

Definition at line 233 of file sch_reference_list.h.

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

◆ m_ref

wxString SCH_REFERENCE::m_ref

private

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

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

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

◆ m_sheetNum

int SCH_REFERENCE::m_sheetNum

private

The sheet number for the reference.

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

Referenced by 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 223 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 232 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 225 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 227 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:

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SCH_REFERENCE() [1/2]

◆ SCH_REFERENCE() [2/2]

Member Function Documentation

◆ Annotate()

◆ CompareLibName()

◆ CompareRef()

◆ CompareValue()

◆ GetFootprint()

◆ GetFullPath()

◆ GetFullRef()

◆ GetLibPart()

◆ GetPath()

◆ GetRef()

◆ GetRefNumber()

◆ GetRefStr()

◆ GetSheetPath() [1/2]

◆ GetSheetPath() [2/2]

◆ GetSymbol()

◆ GetUnit()

◆ GetValue()

◆ IsSameInstance()

◆ IsSplitNeeded()

◆ IsUnitsLocked()

◆ SetFootprint()

◆ SetRef()

◆ SetRefStr()

◆ SetSheetNumber()

◆ SetUnit()

◆ SetValue()

◆ Split()

Friends And Related Function Documentation

◆ SCH_REFERENCE_LIST

Member Data Documentation

◆ m_flag

◆ m_footprint

◆ m_isNew

◆ m_libPart

◆ m_numRef

◆ m_ref

◆ m_rootSymbol

◆ m_sheetNum

◆ m_sheetPath

◆ m_symbolPos

◆ m_symbolUuid

◆ m_unit

◆ m_value