40#include <wx/filename.h>
58 return _(
"(Deleted Item)" );
63 return wxT(
"DELETED_SHEET_ITEM" );
94 void Show(
int , std::ostream& )
const override {}
103 return path.GetCurrentHash();
134 for(
size_t i = 0; i <
size; i++ )
172 if(
size() > aSheetPathToTest.
size() )
175 if(
size() < aSheetPathToTest.
size() )
179 for(
unsigned i = 0; i <
size(); i++ )
199 if( pageNumComp == 0 )
204 if( virtualPageA > virtualPageB )
206 else if( virtualPageA < virtualPageB )
216 if( aSheetPathToTest.
size() >
size() )
219 for(
size_t i = 0; i < aSheetPathToTest.
size(); ++i )
221 if(
at( i )->m_Uuid != aSheetPathToTest.
at( i )->
m_Uuid )
272 if( sheet->GetExcludedFromSim() )
284 if( sheet->GetExcludedFromBOM() )
296 if( sheet->GetExcludedFromBoard() )
308 if( sheet->GetDNP() )
324 for(
unsigned i = 1; i <
size(); i++ )
337 path.push_back( sheet->m_Uuid );
344 bool aStripTrailingSeparator )
const
348 if( aUseShortRootName )
356 if( !
empty() &&
at( 0 )->GetScreen() )
359 wxFileName fn = fileName;
361 s = fn.GetName() + wxS(
"/" );
365 for(
unsigned i = 1; i <
size(); i++ )
368 if( aStripTrailingSeparator && s.EndsWith(
"/" ) )
369 s = s.Left( s.length() - 1 );
377 std::vector<SCH_ITEM*> items;
380 std::back_inserter( items ),
425 bool aForceIncludeOrphanSymbols )
const
430 AppendSymbol( aReferences, symbol, aIncludePowerSymbols, aForceIncludeOrphanSymbols );
436 bool aIncludePowerSymbols,
437 bool aForceIncludeOrphanSymbols )
const
441 if( aIncludePowerSymbols || aSymbol->
GetRef(
this )[0] != wxT(
'#' ) )
448 aReferences.
AddItem( schReference );
455 bool aIncludePowerSymbols )
const
467 bool aIncludePowerSymbols )
const
471 if( !aIncludePowerSymbols && aSymbol->
GetRef(
this )[0] == wxT(
'#' ) )
480 wxString reference_str = schReference.
GetRef();
483 if( reference_str[reference_str.Len() - 1] ==
'?' )
486 aRefList[reference_str].AddItem( schReference );
499 auto pair = std::make_pair( aSrcFileName, aDestFileName );
506 wxCHECK_MSG( sch,
false,
"No SCHEMATIC found in SCH_SHEET_PATH::TestForRecursion!" );
509 wxFileName srcFn = aSrcFileName;
510 wxFileName destFn = aDestFileName;
512 if( srcFn.IsRelative() )
513 srcFn.MakeAbsolute( rootFn.GetPath() );
515 if( destFn.IsRelative() )
516 destFn.MakeAbsolute( rootFn.GetPath() );
519 if( srcFn == destFn )
534 if( cmpFn.IsRelative() )
535 cmpFn.MakeAbsolute( rootFn.GetPath() );
538 if( cmpFn == destFn )
546 if( i >=
size() || i == 0 )
560 if( cmpFn.IsRelative() )
561 cmpFn.MakeAbsolute( rootFn.GetPath() );
581 wxCHECK( sheet, wxEmptyString );
606 const wxString& aProjectName )
608 wxCHECK( !aProjectName.IsEmpty(), );
614 newSheetPath = newSheetPath + currentSheetPath;
620 wxCHECK2( symbol,
continue );
629 newSymbolInstance.
m_Path = newSheetPath.
Path();
638 newSymbolInstance.
m_Path = newSheetPath.
Path();
647 newSymbolInstance.
m_Path = newSheetPath.
Path();
662 wxCHECK2( symbol,
continue );
668 fullSheetPath = fullSheetPath + currentSheetPath;
676 wxCHECK( !aProjectName.IsEmpty() &&
LastScreen(), );
682 wxCHECK2( symbol,
continue );
695 (
LastScreen()->GetFileFormatVersionAtLoad() <= 20200310 ) )
724 if( sheetFileName.IsAbsolute() )
730 wxCHECK( screen && parentScreen, );
733 wxFileName parentFileName = parentScreen->
GetFileName();
737 wxCHECK( fileName.IsAbsolute() && parentFileName.IsAbsolute(), );
739 if( fileName.GetPath() == parentFileName.GetPath() )
743 else if( fileName.MakeRelativeTo( parentFileName.GetPath() ) )
753 wxT(
"\n File name: '%s'"
754 "\n parent file name '%s',"
755 "\n sheet '%s' file name '%s'." ),
757 Last()->GetFileName() );
763 if( aSheet !=
nullptr )
773 std::vector<SCH_SHEET*> badSheets;
782 std::vector<SCH_ITEM*> childSheets;
789 if( aCheckIntegrity )
794 badSheets.push_back( sheet );
801 wxT(
"Recursion prevented in SCH_SHEET_LIST::BuildSheetList" ) );
808 if( aCheckIntegrity )
824 path.CachePageNumber();
826 std::sort( begin(),
end(),
830 size_t common_len = 0;
831 size_t min_len = std::min( a.
size(), b.
size() );
833 while( common_len < min_len && a.
at( common_len )->
m_Uuid == b.
at( common_len )->
m_Uuid )
838 if( common_len == a.
size() )
840 if( common_len == b.
size() )
851 for(
size_t i = 0; i < common_len; i++ )
852 ancestor.push_back( a.
at( i )->
m_Uuid );
873 if( aUpdateVirtualPageNums )
875 int virtualPageNum = 1;
886 path.CachePageNumber();
888 std::sort( begin(),
end(),
896 else if( retval > 0 )
908 if( aUpdateVirtualPageNums )
910 int virtualPageNum = 1;
944 auto it = std::remove_if( begin(),
end(),
947 return std::find( aPageInclusions.begin(),
948 aPageInclusions.end(),
994 if( aAllowNullptrReturn )
1005 if( aItem->m_Uuid == aID )
1013 if( aChild->
m_Uuid == aID )
1014 childMatch = aChild;
1016 RECURSE_MODE::NO_RECURSE );
1034 aMap[ aItem->m_Uuid ] = aItem;
1036 aItem->RunOnChildren(
1039 aMap[ aChild->
m_Uuid ] = aChild;
1041 RECURSE_MODE::NO_RECURSE );
1064 if( libSymbol && libSymbol->
IsPower() )
1067 references.
AddItem( schReference );
1073 std::map<wxString, int> ref_list;
1075 for(
unsigned ii = 0; ii< references.
GetCount(); ++ii )
1077 wxString curr_ref = references[ii].GetRef();
1079 if( curr_ref.IsEmpty() )
1082 if( ref_list.find( curr_ref ) == ref_list.end() )
1084 ref_list[curr_ref] = ii;
1089 if( curr_ref.Last() <
'0' && curr_ref.Last() >
'9' )
1093 while( !curr_ref.IsEmpty() && curr_ref.Last() >=
'0' && curr_ref.Last() <=
'9' )
1094 curr_ref.RemoveLast();
1096 references[ii].SetRef( curr_ref );
1105 for(
unsigned ii = 0; ii< references.
GetCount(); ++ii )
1109 if( ref_unit.
GetRef()[0] !=
'#' )
1111 wxString new_ref =
"#" + ref_unit.
GetRef();
1112 ref_unit.
SetRef( new_ref );
1120 bool aForceIncludeOrphanSymbols )
const
1123 sheet.
GetSymbols( aReferences, aIncludePowerSymbols, aForceIncludeOrphanSymbols );
1129 bool aIncludePowerSymbols,
1130 bool aForceIncludeOrphanSymbols )
const
1135 sheet.
GetSymbols( aReferences, aIncludePowerSymbols, aForceIncludeOrphanSymbols );
1146 aSheets.push_back( sheet );
1152 bool aIncludeLastSheet )
const
1158 if( !aIncludeLastSheet )
1159 testPath.pop_back();
1161 if( testPath == aPath )
1165 return std::nullopt;
1170 bool aIncludePowerSymbols )
const
1172 for(
auto it = begin(); it !=
end(); ++it )
1175 ( *it ).GetMultiUnitSymbols( tempMap, aIncludePowerSymbols );
1177 for( SCH_MULTI_UNIT_REFERENCE_MAP::value_type& pair : tempMap )
1180 unsigned n_refs = pair.second.GetCount();
1182 for(
unsigned thisRef = 0; thisRef < n_refs; ++thisRef )
1183 aRefList[pair.first].AddItem( pair.second[thisRef] );
1190 const wxString& aDestFileName )
1195 SCHEMATIC* sch = at( 0 ).LastScreen()->Schematic();
1197 wxCHECK_MSG( sch,
false,
"No SCHEMATIC found in SCH_SHEET_LIST::TestForRecursion!" );
1200 wxFileName destFn = aDestFileName;
1202 if( destFn.IsRelative() )
1203 destFn.MakeAbsolute( rootFn.GetPath() );
1206 for(
unsigned i = 0; i < size(); i++ )
1209 for(
unsigned j = 0; j < aSrcSheetHierarchy.size(); j++ )
1213 for(
unsigned k = 0; k < sheetPath->
size(); k++ )
1260 retval.push_back( sheetpath );
1268 const std::vector<SCH_SYMBOL_INSTANCE>& aSymbolInstances )
1276 wxCHECK2( symbol,
continue );
1279 sheetPathWithSymbolUuid.push_back( symbol->
m_Uuid );
1281 auto it = std::find_if( aSymbolInstances.begin(), aSymbolInstances.end(),
1284 return sheetPathWithSymbolUuid == r.m_Path;
1287 if( it == aSymbolInstances.end() )
1290 sheetPathWithSymbolUuid.
AsString() );
1299 if( !it->m_Value.IsEmpty() )
1302 if( !it->m_Footprint.IsEmpty() )
1318 wxCHECK2( sheet &&
path.Last(),
continue );
1320 auto it = std::find_if( aSheetInstances.begin(), aSheetInstances.end(),
1323 return path.Path() == r.m_Path;
1326 if( it == aSheetInstances.end() )
1329 path.Path().AsString() );
1334 ( sheet->
GetName().IsEmpty() ) ? wxString( wxT(
"root" ) ) : sheet->
GetName(),
1335 path.Path().AsString(), it->m_PageNumber );
1336 path.SetPageNumber( it->m_PageNumber );
1343 std::vector<KIID_PATH> paths;
1346 paths.emplace_back( sheetPath.
Path() );
1354 std::vector<SCH_SHEET_INSTANCE> retval;
1360 wxCHECK2( sheet,
continue );
1369 retval.push_back( std::move( instance ) );
1398 tmp.Printf(
"%d", pageNumber );
1406 const wxString& aProjectName )
1421 int aLastVirtualPageNumber )
1423 wxString pageNumber;
1424 int lastUsedPageNumber = 1;
1425 int nextVirtualPageNumber = aLastVirtualPageNumber;
1428 std::vector< wxString > usedPageNumbers;
1430 if( aPrefixSheetPath.
size() )
1436 pageNumber =
path.GetPageNumber();
1438 if( !pageNumber.IsEmpty() )
1439 usedPageNumbers.emplace_back( pageNumber );
1449 newSheetPath = newSheetPath + sheetPath;
1456 wxCHECK2( sheet,
continue );
1458 nextVirtualPageNumber += 1;
1475 pageNumber.Printf( wxT(
"%d" ), lastUsedPageNumber );
1476 lastUsedPageNumber += 1;
1477 }
while( std::find( usedPageNumbers.begin(), usedPageNumbers.end(), pageNumber ) !=
1478 usedPageNumbers.end() );
1499 int lastVirtualPageNumber = 1;
1507 return lastVirtualPageNumber;
1515 if(
path.Path() == aPath )
1527 for(
size_t i = 0; i <
path.size(); i++ )
1529 if(
path.at( i ) == aSheet )
1542 return std::nullopt;
1546 if(
path.LastScreen() == aScreen )
1547 return std::optional<SCH_SHEET_PATH>(
path );
1550 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 void UpdateHatching() const
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,...
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode)
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
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 SplitReferences()
Attempt to split all reference designators into a name (U) and number (1).
void AddItem(const SCH_REFERENCE &aItem)
A helper to define a symbol's reference designator in a schematic.
void SetRef(const wxString &aReference)
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 * ResolveItem(const KIID &aID, SCH_SHEET_PATH *aPathOut=nullptr, bool aAllowNullptrReturn=false) 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
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.
SCH_ITEM * ResolveItem(const KIID &aID) const
Fetch a SCH_ITEM by ID.
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.
wxString getPageNumber(const KIID_PATH &aParentPath) const
Return the sheet page number for aParentPath.
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.
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