41#include <wx/filename.h>
59 return _(
"(Deleted Item)" );
64 return wxT(
"DELETED_SHEET_ITEM" );
95 void Show(
int , std::ostream& )
const override {}
104 return path.GetCurrentHash();
135 for(
size_t i = 0; i <
size; i++ )
173 if(
size() > aSheetPathToTest.
size() )
176 if(
size() < aSheetPathToTest.
size() )
180 for(
unsigned i = 0; i <
size(); i++ )
200 if( pageNumComp == 0 )
205 if( virtualPageA > virtualPageB )
207 else if( virtualPageA < virtualPageB )
217 if( aSheetPathToTest.
size() >
size() )
220 for(
size_t i = 0; i < aSheetPathToTest.
size(); ++i )
222 if(
at( i )->m_Uuid != aSheetPathToTest.
at( i )->
m_Uuid )
273 if( sheet->GetExcludedFromSim() )
285 if( sheet->GetExcludedFromBOM() )
297 if( sheet->GetExcludedFromBoard() )
309 if( sheet->GetDNP() )
325 for(
unsigned i = 1; i <
size(); i++ )
338 path.push_back( sheet->m_Uuid );
345 bool aStripTrailingSeparator )
const
349 if( aUseShortRootName )
357 if( !
empty() &&
at( 0 )->GetScreen() )
360 wxFileName fn = fileName;
362 s = fn.GetName() + wxS(
"/" );
366 for(
unsigned i = 1; i <
size(); i++ )
369 if( aStripTrailingSeparator && s.EndsWith(
"/" ) )
370 s = s.Left( s.length() - 1 );
378 std::vector<SCH_ITEM*> items;
381 std::back_inserter( items ),
419 bool aForceIncludeOrphanSymbols )
const
424 AppendSymbol( aReferences, symbol, aIncludePowerSymbols, aForceIncludeOrphanSymbols );
430 bool aIncludePowerSymbols,
431 bool aForceIncludeOrphanSymbols )
const
435 if( aIncludePowerSymbols || aSymbol->
GetRef(
this )[0] != wxT(
'#' ) )
442 aReferences.
AddItem( schReference );
449 bool aIncludePowerSymbols )
const
461 bool aIncludePowerSymbols )
const
465 if( !aIncludePowerSymbols && aSymbol->
GetRef(
this )[0] == wxT(
'#' ) )
474 wxString reference_str = schReference.
GetRef();
477 if( reference_str[reference_str.Len() - 1] ==
'?' )
480 aRefList[reference_str].AddItem( schReference );
493 auto pair = std::make_pair( aSrcFileName, aDestFileName );
500 wxCHECK_MSG( sch,
false,
"No SCHEMATIC found in SCH_SHEET_PATH::TestForRecursion!" );
503 wxFileName srcFn = aSrcFileName;
504 wxFileName destFn = aDestFileName;
506 if( srcFn.IsRelative() )
507 srcFn.MakeAbsolute( rootFn.GetPath() );
509 if( destFn.IsRelative() )
510 destFn.MakeAbsolute( rootFn.GetPath() );
513 if( srcFn == destFn )
528 if( cmpFn.IsRelative() )
529 cmpFn.MakeAbsolute( rootFn.GetPath() );
532 if( cmpFn == destFn )
540 if( i >=
size() || i == 0 )
554 if( cmpFn.IsRelative() )
555 cmpFn.MakeAbsolute( rootFn.GetPath() );
575 wxCHECK( sheet, wxEmptyString );
600 const wxString& aProjectName )
602 wxCHECK( !aProjectName.IsEmpty(), );
608 newSheetPath = newSheetPath + currentSheetPath;
614 wxCHECK2( symbol,
continue );
623 newSymbolInstance.
m_Path = newSheetPath.
Path();
632 newSymbolInstance.
m_Path = newSheetPath.
Path();
641 newSymbolInstance.
m_Path = newSheetPath.
Path();
656 wxCHECK2( symbol,
continue );
662 fullSheetPath = fullSheetPath + currentSheetPath;
670 wxCHECK( !aProjectName.IsEmpty() &&
LastScreen(), );
676 wxCHECK2( symbol,
continue );
689 (
LastScreen()->GetFileFormatVersionAtLoad() <= 20200310 ) )
718 if( sheetFileName.IsAbsolute() )
724 wxCHECK( screen && parentScreen, );
727 wxFileName parentFileName = parentScreen->
GetFileName();
731 wxCHECK( fileName.IsAbsolute() && parentFileName.IsAbsolute(), );
733 if( fileName.GetPath() == parentFileName.GetPath() )
737 else if( fileName.MakeRelativeTo( parentFileName.GetPath() ) )
747 wxT(
"\n File name: '%s'"
748 "\n parent file name '%s',"
749 "\n sheet '%s' file name '%s'." ),
751 Last()->GetFileName() );
757 if( aSheet !=
nullptr )
764 wxCHECK_RET( aSheet !=
nullptr, wxT(
"Cannot build sheet list from undefined sheet." ) );
766 std::vector<SCH_SHEET*> badSheets;
775 std::vector<SCH_ITEM*> childSheets;
782 if( aCheckIntegrity )
787 badSheets.push_back( sheet );
794 wxT(
"Recursion prevented in SCH_SHEET_LIST::BuildSheetList" ) );
801 if( aCheckIntegrity )
817 path.CachePageNumber();
819 std::sort( begin(),
end(),
830 else if( retval > 0 )
842 if( aUpdateVirtualPageNums )
844 int virtualPageNum = 1;
855 path.CachePageNumber();
857 std::sort( begin(),
end(),
865 else if( retval > 0 )
877 if( aUpdateVirtualPageNums )
879 int virtualPageNum = 1;
913 auto it = std::remove_if( begin(),
end(),
916 return std::find( aPageInclusions.begin(), aPageInclusions.end(),
918 == aPageInclusions.end();
971 if( aItem->m_Uuid == aID )
979 if( aChild->
m_Uuid == aID )
999 aMap[ aItem->m_Uuid ] = aItem;
1001 aItem->RunOnChildren(
1004 aMap[ aChild->
m_Uuid ] = aChild;
1028 if( libSymbol && libSymbol->
IsPower() )
1031 references.
AddItem( schReference );
1037 std::map<wxString, int> ref_list;
1039 for(
unsigned ii = 0; ii< references.
GetCount(); ++ii )
1041 wxString curr_ref = references[ii].GetRef();
1043 if( ref_list.find( curr_ref ) == ref_list.end() )
1045 ref_list[curr_ref] = ii;
1050 if( curr_ref.Last() <
'0' && curr_ref.Last() >
'9' )
1054 while( curr_ref.Last() >=
'0' && curr_ref.Last() <=
'9' )
1055 curr_ref.RemoveLast();
1057 references[ii].SetRef( curr_ref );
1066 for(
unsigned ii = 0; ii< references.
GetCount(); ++ii )
1068 if( references[ii].GetRef()[0] !=
'#' )
1070 wxString new_ref =
"#" + references[ii].GetRef();
1071 references[ii].SetRef( new_ref );
1076 references.
Annotate(
false, 0, 100, lockedSymbols, additionalreferences );
1082 bool aForceIncludeOrphanSymbols )
const
1085 sheet.
GetSymbols( aReferences, aIncludePowerSymbols, aForceIncludeOrphanSymbols );
1091 bool aIncludePowerSymbols,
1092 bool aForceIncludeOrphanSymbols )
const
1097 sheet.
GetSymbols( aReferences, aIncludePowerSymbols, aForceIncludeOrphanSymbols );
1108 aSheets.push_back( sheet );
1114 bool aIncludeLastSheet )
const
1120 if( !aIncludeLastSheet )
1121 testPath.pop_back();
1123 if( testPath == aPath )
1127 return std::nullopt;
1132 bool aIncludePowerSymbols )
const
1134 for(
auto it = begin(); it !=
end(); ++it )
1137 ( *it ).GetMultiUnitSymbols( tempMap, aIncludePowerSymbols );
1139 for( SCH_MULTI_UNIT_REFERENCE_MAP::value_type& pair : tempMap )
1142 unsigned n_refs = pair.second.GetCount();
1144 for(
unsigned thisRef = 0; thisRef < n_refs; ++thisRef )
1145 aRefList[pair.first].AddItem( pair.second[thisRef] );
1152 const wxString& aDestFileName )
1157 SCHEMATIC* sch = at( 0 ).LastScreen()->Schematic();
1159 wxCHECK_MSG( sch,
false,
"No SCHEMATIC found in SCH_SHEET_LIST::TestForRecursion!" );
1162 wxFileName destFn = aDestFileName;
1164 if( destFn.IsRelative() )
1165 destFn.MakeAbsolute( rootFn.GetPath() );
1168 for(
unsigned i = 0; i < size(); i++ )
1171 for(
unsigned j = 0; j < aSrcSheetHierarchy.size(); j++ )
1175 for(
unsigned k = 0; k < sheetPath->
size(); k++ )
1222 retval.push_back( sheetpath );
1230 const std::vector<SCH_SYMBOL_INSTANCE>& aSymbolInstances )
1238 wxCHECK2( symbol,
continue );
1241 sheetPathWithSymbolUuid.push_back( symbol->
m_Uuid );
1243 auto it = std::find_if( aSymbolInstances.begin(), aSymbolInstances.end(),
1246 return sheetPathWithSymbolUuid == r.m_Path;
1249 if( it == aSymbolInstances.end() )
1252 sheetPathWithSymbolUuid.
AsString() );
1261 if( !it->m_Value.IsEmpty() )
1264 if( !it->m_Footprint.IsEmpty() )
1280 wxCHECK2( sheet &&
path.Last(),
continue );
1282 auto it = std::find_if( aSheetInstances.begin(), aSheetInstances.end(),
1285 return path.Path() == r.m_Path;
1288 if( it == aSheetInstances.end() )
1291 path.Path().AsString() );
1296 ( sheet->
GetName().IsEmpty() ) ? wxString( wxT(
"root" ) ) : sheet->
GetName(),
1297 path.Path().AsString(), it->m_PageNumber );
1298 path.SetPageNumber( it->m_PageNumber );
1305 std::vector<KIID_PATH> paths;
1308 paths.emplace_back( sheetPath.
Path() );
1316 std::vector<SCH_SHEET_INSTANCE> retval;
1322 wxCHECK2( sheet,
continue );
1331 retval.push_back( instance );
1360 tmp.Printf(
"%d", pageNumber );
1368 const wxString& aProjectName )
1383 int aLastVirtualPageNumber )
1385 wxString pageNumber;
1386 int lastUsedPageNumber = 1;
1387 int nextVirtualPageNumber = aLastVirtualPageNumber;
1390 std::vector< wxString > usedPageNumbers;
1392 if( aPrefixSheetPath.
size() )
1398 pageNumber =
path.GetPageNumber();
1400 if( !pageNumber.IsEmpty() )
1401 usedPageNumbers.emplace_back( pageNumber );
1411 newSheetPath = newSheetPath + sheetPath;
1418 wxCHECK2( sheet,
continue );
1420 nextVirtualPageNumber += 1;
1437 pageNumber.Printf( wxT(
"%d" ), lastUsedPageNumber );
1438 lastUsedPageNumber += 1;
1439 }
while( std::find( usedPageNumbers.begin(), usedPageNumbers.end(), pageNumber ) !=
1440 usedPageNumbers.end() );
1461 int lastVirtualPageNumber = 1;
1469 return lastVirtualPageNumber;
1477 if(
path.Path() == aPath )
1489 for(
size_t i = 0; i <
path.size(); i++ )
1491 if(
path.at( i ) == aSheet )
1504 return std::nullopt;
1508 if(
path.LastScreen() == aScreen )
1509 return std::optional<SCH_SHEET_PATH>(
path );
1512 return std::nullopt;
bool IsContentModified() const
void SetContentModified(bool aModified=true)
A singleton item of this class is returned for a weak reference that no longer exists.
wxString GetClass() const override
Return the class name.
void SetPosition(const VECTOR2I &) override
static DELETED_SHEET_ITEM * GetInstance()
double Similarity(const SCH_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
void Move(const VECTOR2I &aMoveVector) override
Move the item by aMoveVector to a new position.
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
bool operator==(const SCH_ITEM &aOther) const override
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
KICAD_T Type() const
Returns the type of object.
virtual const wxString & GetText() const
Return the string associated with the text object.
virtual bool IsVisible() const
virtual void SetVisible(bool aVisible)
EE_TYPE OfType(KICAD_T aType) const
wxString AsString() const
wxString AsString() const
Define a library symbol object.
bool IsPower() const override
int GetUnitCount() const override
bool m_IntersheetRefsShow
Holds all the data relating to one schematic.
wxString GetFileName() const
Helper to retrieve the filename from the root sheet screen.
SCHEMATIC_SETTINGS & Settings() const
VECTOR2I GetPosition() const override
wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
void SetText(const wxString &aText) override
SCH_FIELD * GetField(FIELD_T aFieldType)
Return a mandatory field in this label.
Base class for any item which can be embedded within the SCHEMATIC container class,...
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction)
virtual void SetUnit(int aUnit)
void AutoplaceFields(SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo) override
std::vector< SCH_FIELD > & GetFields()
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
void Annotate(bool aUseSheetNum, int aSheetIntervalId, int aStartNumber, SCH_MULTI_UNIT_REFERENCE_MAP aLockedUnitMap, const SCH_REFERENCE_LIST &aAdditionalRefs, bool aStartAtCurrent=false)
Set the reference designators in the list that have not been annotated.
void SplitReferences()
Attempt to split all reference designators into a name (U) and number (1).
void AddItem(const SCH_REFERENCE &aItem)
void UpdateAnnotation()
Update the symbol references for the schematic project (or the current sheet).
A helper to define a symbol's reference designator in a schematic.
void SetSheetNumber(int aSheetNumber)
EE_RTREE & Items()
Get the full RTree, usually for iterating.
const wxString & GetFileName() const
bool Remove(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Remove aItem from the schematic associated with this screen.
SCHEMATIC * Schematic() const
void Update(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Update aItem's bounding box in the tree.
void GetSheets(std::vector< SCH_ITEM * > *aItems) const
Similar to Items().OfType( SCH_SHEET_T ), but return the sheets in a deterministic order (L-R,...
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
std::optional< SCH_SHEET_PATH > GetSheetPathByKIIDPath(const KIID_PATH &aPath, bool aIncludeLastSheet=true) const
Finds a SCH_SHEET_PATH that matches the provided KIID_PATH.
SCH_ITEM * GetItem(const KIID &aID, SCH_SHEET_PATH *aPathOut=nullptr) const
Fetch a SCH_ITEM by ID.
void GetMultiUnitSymbols(SCH_MULTI_UNIT_REFERENCE_MAP &aRefList, bool aIncludePowerSymbols=true) const
Add a SCH_REFERENCE_LIST object to aRefList for each same-reference set of multi-unit parts in the li...
std::optional< SCH_SHEET_PATH > GetOrdinalPath(const SCH_SCREEN *aScreen) const
Return the ordinal sheet path of aScreen.
void FillItemMap(std::map< KIID, EDA_ITEM * > &aMap)
Fill an item cache for temporary use when many items need to be fetched.
SCH_SHEET_PATH m_currentSheetPath
void TrimToPageNumbers(const std::vector< wxString > &aPageInclusions)
Truncates the list by removing sheet's with page numbers not in the given list.
void SortByPageNumbers(bool aUpdateVirtualPageNums=true)
Sort the list of sheets by page number.
void AddNewSymbolInstances(const SCH_SHEET_PATH &aPrefixSheetPath, const wxString &aProjectName)
Attempt to add new symbol instances for all symbols in this list of sheet paths prefixed with aPrefix...
bool NameExists(const wxString &aSheetName) const
std::vector< SCH_SHEET_INSTANCE > GetSheetInstances() const
Fetch the instance information for all of the sheets in the hierarchy.
void UpdateSheetInstanceData(const std::vector< SCH_SHEET_INSTANCE > &aSheetInstances)
Update all of the sheet instance information using aSheetInstances.
void SetInitialPageNumbers()
Set initial sheet page numbers.
void RemoveSymbolInstances(const SCH_SHEET_PATH &aPrefixSheetPath)
SCH_SHEET_LIST FindAllSheetsForScreen(const SCH_SCREEN *aScreen) const
Return a SCH_SHEET_LIST with a copy of all the SCH_SHEET_PATH using a particular screen.
bool AllSheetPageNumbersEmpty() const
Check all of the sheet instance for empty page numbers.
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets.
bool IsModified() const
Check the entire hierarchy for any modifications.
SCH_SHEET_LIST(SCH_SHEET *aSheet=nullptr)
Construct a flattened list of SCH_SHEET_PATH objects from aSheet.
void AnnotatePowerSymbols()
Silently annotate the not yet annotated power symbols of the entire hierarchy of the sheet path list.
int GetLastVirtualPageNumber() const
void UpdateSymbolInstanceData(const std::vector< SCH_SYMBOL_INSTANCE > &aSymbolInstances)
Update all of the symbol instance information using aSymbolInstances.
void GetSheetsWithinPath(std::vector< SCH_SHEET_PATH > &aSheets, const SCH_SHEET_PATH &aSheetPath) const
Add a SCH_SHEET_PATH object to aSheets for each sheet in the list that are contained within aSheetPat...
bool PageNumberExists(const wxString &aPageNumber) const
void SortByHierarchicalPageNumbers(bool aUpdateVirtualPageNums=true)
This works like SortByPageNumbers, but it sorts the sheets first by their hierarchical depth and then...
void AddNewSheetInstances(const SCH_SHEET_PATH &aPrefixSheetPath, int aLastVirtualPageNumber)
bool ContainsSheet(const SCH_SHEET *aSheet) const
std::vector< KIID_PATH > GetPaths() const
void GetSymbolsWithinPath(SCH_REFERENCE_LIST &aReferences, const SCH_SHEET_PATH &aSheetPath, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets that are contained wi...
void BuildSheetList(SCH_SHEET *aSheet, bool aCheckIntegrity)
Build the list of sheets and their sheet path from aSheet.
SCH_SHEET_PATH FindSheetForScreen(const SCH_SCREEN *aScreen)
Return the first SCH_SHEET_PATH object (not necessarily the only one) using a particular screen.
void CheckForMissingSymbolInstances(const wxString &aProjectName)
bool HasPath(const KIID_PATH &aPath) const
SCH_SHEET_PATH * FindSheetForPath(const SCH_SHEET_PATH *aPath)
Return a pointer to the first SCH_SHEET_PATH object (not necessarily the only one) matching the provi...
bool TestForRecursion(const SCH_SHEET_LIST &aSrcSheetHierarchy, const wxString &aDestFileName)
Test every SCH_SHEET_PATH in this SCH_SHEET_LIST to verify if adding the sheets stored in aSrcSheetHi...
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
bool GetExcludedFromBOM() const
SCH_ITEM * GetItem(const KIID &aID) const
Fetch a SCH_ITEM by ID.
void AppendMultiUnitSymbol(SCH_MULTI_UNIT_REFERENCE_MAP &aRefList, SCH_SYMBOL *aSymbol, bool aIncludePowerSymbols=true) const
Append a SCH_REFERENCE_LIST object to aRefList based on aSymbol, storing same-reference set of multi-...
const SCH_SHEET * GetSheet(unsigned aIndex) const
bool empty() const
Forwarded method from std::vector.
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Adds SCH_REFERENCE object to aReferences for each symbol in the sheet.
int ComparePageNum(const SCH_SHEET_PATH &aSheetPathToTest) const
Compare sheets by their page number.
size_t GetCurrentHash() const
wxString PathHumanReadable(bool aUseShortRootName=true, bool aStripTrailingSeparator=false) const
Return the sheet path in a human readable form made from the sheet names.
bool operator==(const SCH_SHEET_PATH &d1) const
void AddNewSymbolInstances(const SCH_SHEET_PATH &aPrefixSheetPath, const wxString &aProjectName)
Attempt to add new symbol instances for all symbols in this sheet path prefixed with aPrefixSheetPath...
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
bool TestForRecursion(const wxString &aSrcFileName, const wxString &aDestFileName)
Test the SCH_SHEET_PATH file names to check adding the sheet stored in the file aSrcFileName to the s...
void UpdateAllScreenReferences() const
Update all the symbol references for this sheet path.
void MakeFilePathRelativeToParentSheet()
Make the sheet file name relative to its parent sheet.
wxString GetCachedPageNumber() const
std::vector< SCH_SHEET * > m_sheets
SCH_SCREEN * LastScreen()
int Cmp(const SCH_SHEET_PATH &aSheetPathToTest) const
Compare if this is the same sheet path as aSheetPathToTest.
void GetMultiUnitSymbols(SCH_MULTI_UNIT_REFERENCE_MAP &aRefList, bool aIncludePowerSymbols=true) const
Add a SCH_REFERENCE_LIST object to aRefList for each same-reference set of multi-unit parts in the sh...
void initFromOther(const SCH_SHEET_PATH &aOther)
wxString m_cached_page_number
wxString GetPageNumber() const
void RemoveSymbolInstances(const SCH_SHEET_PATH &aPrefixSheetPath)
void CheckForMissingSymbolInstances(const wxString &aProjectName)
bool IsContainedWithin(const SCH_SHEET_PATH &aSheetPathToTest) const
Check if this path is contained inside aSheetPathToTest.
SCH_SHEET * at(size_t aIndex) const
Forwarded method from std::vector.
void SetVirtualPageNumber(int aPageNumber)
Set the sheet instance virtual page number.
void AppendSymbol(SCH_REFERENCE_LIST &aReferences, SCH_SYMBOL *aSymbol, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Append a SCH_REFERENCE object to aReferences based on aSymbol.
std::map< std::pair< wxString, wxString >, bool > m_recursion_test_cache
bool GetExcludedFromSim() const
wxString PathAsString() const
Return the path of time stamps which do not changes even when editing sheet parameters.
bool GetExcludedFromBoard() const
void SetPageNumber(const wxString &aPageNumber)
Set the sheet instance user definable page number.
SCH_SHEET_PATH & operator=(const SCH_SHEET_PATH &aOther)
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
SCH_SHEET_PATH operator+(const SCH_SHEET_PATH &aOther)
int m_virtualPageNumber
Page numbers are maintained by the sheet load order.
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
size_t size() const
Forwarded method from std::vector.
int GetVirtualPageNumber() const
void pop_back()
Forwarded method from std::vector.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
void SetFileName(const wxString &aFilename)
wxString GetFileName() const
Return the filename corresponding to this sheet.
bool getInstance(SCH_SHEET_INSTANCE &aInstance, const KIID_PATH &aSheetPath, bool aTestFromEnd=false) const
bool addInstance(const KIID_PATH &aInstance)
Add a new instance aSheetPath to the instance list.
SCH_FIELD * GetField(FIELD_T aFieldType)
Return a mandatory field in this sheet.
SCH_SCREEN * GetScreen() const
static int ComparePageNum(const wxString &aPageNumberA, const wxString &aPageNumberB)
Compare page numbers of schematic sheets.
void setPageNumber(const KIID_PATH &aInstance, const wxString &aPageNumber)
Set the page number for the sheet instance aInstance.
wxString getPageNumber(const KIID_PATH &aInstance) const
Return the sheet page number for aInstance.
void UpdatePrefix()
Set the prefix based on the current reference designator.
const std::vector< SCH_SYMBOL_INSTANCE > & GetInstances() const
void RemoveInstance(const SCH_SHEET_PATH &aInstancePath)
void SetValueFieldText(const wxString &aValue)
void SetFootprintFieldText(const wxString &aFootprint)
void AddHierarchicalReference(const KIID_PATH &aPath, const wxString &aRef, int aUnit)
Add a full hierarchical reference to this symbol.
bool GetInstance(SCH_SYMBOL_INSTANCE &aInstance, const KIID_PATH &aSheetPath, bool aTestFromEnd=false) const
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
Return the instance-specific unit selection for the given sheet path.
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
wxString GetPrefix() const
SCH_FIELD * GetField(FIELD_T aFieldType)
Return a mandatory field in this symbol.
static bool empty(const wxTextEntryBase *aCtrl)
const wxChar *const tracePathsAndFiles
Flag to enable path and file name debug output.
const wxChar *const traceSchSheetPaths
Flag to enable debug output of schematic symbol sheet path manipulation code.
static constexpr void hash_combine(std::size_t &seed)
This is a dummy function to take the final case of hash_combine below.
wxString GetRefDesUnannotated(const wxString &aSource)
Return an unannotated refdes from either a prefix or an existing refdes.
Collection of utility functions for component reference designators (refdes)
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
std::map< wxString, SCH_REFERENCE_LIST > SCH_MULTI_UNIT_REFERENCE_MAP
Container to map reference designators for multi-unit parts.
A simple container for sheet instance information.
A simple container for schematic symbol instance information.
Definition for symbol library class.
wxLogTrace helper definitions.
@ NOT_USED
the 3d code uses this value
VECTOR2< int32_t > VECTOR2I