SCH_SHEET_LIST Class Reference

A container for handling SCH_SHEET_PATH objects in a flattened hierarchy. More...

#include <sch_sheet_path.h>

Inheritance diagram for SCH_SHEET_LIST:

Public Member Functions
	SCH_SHEET_LIST (SCH_SHEET *aSheet=nullptr, bool aCheckIntegrity=false)
	Construct a flattened list of SCH_SHEET_PATH objects from aSheet. More...
	~SCH_SHEET_LIST ()
bool	IsModified () const
	Check the entire hierarchy for any modifications. More...
void	ClearModifyStatus ()
SCH_ITEM *	GetItem (const KIID &aID, SCH_SHEET_PATH *aPathOut=nullptr) const
	Fetch a SCH_ITEM by ID. More...
void	FillItemMap (std::map< KIID, EDA_ITEM * > &aMap)
	Fill an item cache for temporary use when many items need to be fetched. More...
void	AnnotatePowerSymbols ()
	Silently annotate the not yet annotated power symbols of the entire hierarchy of the sheet path list. More...
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. More...
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 within aSheetPath as well as recursively downwards inside aSheetPath. More...
void	GetSheetsWithinPath (SCH_SHEET_PATHS &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 aSheetPath as well as recursively downwards inside aSheetPath. More...
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. More...
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 list of sheets. More...
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 aSrcSheetHierarchy to the sheet stored in aDestFileName will cause recursion. More...
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 provided path. More...
SCH_SHEET_PATH *	FindSheetForScreen (const SCH_SCREEN *aScreen)
	Return a pointer to the first SCH_SHEET_PATH object (not necessarily the only one) using a particular screen. More...
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. More...
void	BuildSheetList (SCH_SHEET *aSheet, bool aCheckIntegrity)
	Build the list of sheets and their sheet path from aSheet. More...
void	SortByPageNumbers (bool aUpdateVirtualPageNums=true)
	Sort the list of sheets by page number. More...
bool	NameExists (const wxString &aSheetName) const
bool	PageNumberExists (const wxString &aPageNumber) const
void	UpdateSymbolInstanceData (const std::vector< SCH_SYMBOL_INSTANCE > &aSymbolInstances)
	Update all of the symbol instance information using aSymbolInstances. More...
void	UpdateSheetInstanceData (const std::vector< SCH_SHEET_INSTANCE > &aSheetInstances)
	Update all of the sheet instance information using aSheetInstances. More...
std::vector< KIID_PATH >	GetPaths () const
std::vector< SCH_SHEET_INSTANCE >	GetSheetInstances () const
	Fetch the instance information for all of the sheets in the hiearchy. More...
bool	AllSheetPageNumbersEmpty () const
	Check all of the sheet instance for empty page numbers. More...
void	SetInitialPageNumbers ()
	Set initial sheet page numbers. More...
void	AddNewSymbolInstances (const SCH_SHEET_PATH &aPrefixSheetPath)
	Attempt to add new symbol instances for all symbols in this list of sheet paths prefixed with aPrefixSheetPath. More...
void	AddNewSheetInstances (const SCH_SHEET_PATH &aPrefixSheetPath, int aLastVirtualPageNumber)
int	GetLastVirtualPageNumber () const
void	RemoveSymbolInstances (const SCH_SHEET_PATH &aPrefixSheetPath)

Private Attributes
SCH_SHEET_PATH	m_currentSheetPath

Detailed Description

A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.

SCH_SHEET objects are not unique, there can be many sheets with the same filename and that share the same SCH_SCREEN reference. Each The schematic file (SCH_SCREEN) may be shared between these sheets and symbol references are specific to a sheet path. When a sheet is entered, symbol references and sheet page number are updated.

Definition at line 460 of file sch_sheet_path.h.

Constructor & Destructor Documentation

SCH_SHEET_LIST()

SCH_SHEET_LIST::SCH_SHEET_LIST	(	SCH_SHEET *	aSheet = nullptr,
		bool	aCheckIntegrity = false
	)

Construct a flattened list of SCH_SHEET_PATH objects from aSheet.

If aSheet == NULL, then this is an empty hierarchy which the user can populate.

Definition at line 660 of file sch_sheet_path.cpp.

{
 if( aSheet != nullptr )
 {
 BuildSheetList( aSheet, aCheckIntegrity );
 
 if( aSheet->IsRootSheet() )
 SortByPageNumbers();
 }
}

References BuildSheetList(), SCH_SHEET::IsRootSheet(), and SortByPageNumbers().

~SCH_SHEET_LIST()

SCH_SHEET_LIST::~SCH_SHEET_LIST ( )

inline

Definition at line 470 of file sch_sheet_path.h.

{}

Member Function Documentation

AddNewSheetInstances()

void SCH_SHEET_LIST::AddNewSheetInstances	(	const SCH_SHEET_PATH &	aPrefixSheetPath,
		int	aLastVirtualPageNumber
	)

Definition at line 1226 of file sch_sheet_path.cpp.

{
 wxString pageNumber;
 int lastUsedPageNumber = 1;
 int nextVirtualPageNumber = aLastVirtualPageNumber;
 
 // Fetch the list of page numbers already in use.
 std::vector< wxString > usedPageNumbers;
 
 if( aPrefixSheetPath.size() )
 {
 SCH_SHEET_LIST prefixHierarchy( aPrefixSheetPath.at( 0 ) );
 
 for( const SCH_SHEET_PATH& path : prefixHierarchy )
 {
 pageNumber = path.GetPageNumber();
 
 if( !pageNumber.IsEmpty() )
 usedPageNumbers.emplace_back( pageNumber );
 }
 }
 
 for( SCH_SHEET_PATH& sheetPath : *this )
 {
 SCH_SHEET_PATH tmp( sheetPath );
 SCH_SHEET_PATH newSheetPath( aPrefixSheetPath );
 
 // Prefix the new hierarchical path.
 newSheetPath = newSheetPath + sheetPath;
 
 // Sheets cannot have themselves in the path.
 tmp.pop_back();
 
 SCH_SHEET* sheet = sheetPath.Last();
 
 wxCHECK2( sheet, continue );
 
 nextVirtualPageNumber += 1;
 
 SCH_SHEET_INSTANCE instance;
 
 if( sheet->getInstance( instance, tmp.Path(), true )
 && !instance.m_PageNumber.IsEmpty() )
 {
 newSheetPath.SetPageNumber( instance.m_PageNumber );
 usedPageNumbers.push_back( instance.m_PageNumber );
 }
 else
 {
 // Generate the next available page number.
 do
 {
 pageNumber.Printf( wxT( "%d" ), lastUsedPageNumber );
 lastUsedPageNumber += 1;
 } while( std::find( usedPageNumbers.begin(), usedPageNumbers.end(), pageNumber ) !=
 usedPageNumbers.end() );
 
 newSheetPath.SetVirtualPageNumber( nextVirtualPageNumber );
 newSheetPath.SetPageNumber( pageNumber );
 usedPageNumbers.push_back( pageNumber );
 }
 }
}

References SCH_SHEET_PATH::at(), SCH_SHEET::getInstance(), SCH_SHEET_INSTANCE::m_PageNumber, SCH_SHEET_PATH::Path(), path, SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::SetPageNumber(), SCH_SHEET_PATH::SetVirtualPageNumber(), and SCH_SHEET_PATH::size().

Referenced by SCH_EDIT_FRAME::LoadSheetFromFile().

AddNewSymbolInstances()

void SCH_SHEET_LIST::AddNewSymbolInstances

(

const SCH_SHEET_PATH &

aPrefixSheetPath

)

Attempt to add new symbol instances for all symbols in this list of sheet paths prefixed with aPrefixSheetPath.

Parameters

aPrefixSheetPath

is the sheet path to append the new symbol instances to.

Definition at line 1212 of file sch_sheet_path.cpp.

{
 for( SCH_SHEET_PATH& sheetPath : *this )
 sheetPath.AddNewSymbolInstances( aPrefixSheetPath );
}

References SCH_SHEET_PATH::AddNewSymbolInstances().

Referenced by SCH_EDIT_FRAME::LoadSheetFromFile().

AllSheetPageNumbersEmpty()

bool SCH_SHEET_LIST::AllSheetPageNumbersEmpty

(

)

const

Check all of the sheet instance for empty page numbers.

Note

This should only return true when loading a legacy schematic or an s-expression schematic before version 20201005.

Returns

true if all sheet instance page numbers are not defined. Otherwise false.

Definition at line 1183 of file sch_sheet_path.cpp.

{
 for( const SCH_SHEET_PATH& instance : *this )
 {
 if( !instance.GetPageNumber().IsEmpty() )
 return false;
 }
 
 return true;
}

References SCH_SHEET_PATH::GetPageNumber().

Referenced by BOOST_AUTO_TEST_CASE(), SCH_EDIT_FRAME::OpenProjectFiles(), and SetInitialPageNumbers().

AnnotatePowerSymbols()

void SCH_SHEET_LIST::AnnotatePowerSymbols

(

)

Silently annotate the not yet annotated power symbols of the entire hierarchy of the sheet path list.

It is called before creating a netlist, to annotate power symbols, without prompting the user about not annotated or duplicate for these symbols, if only these symbols need annotation ( a very frequent case ).

Definition at line 856 of file sch_sheet_path.cpp.

{
 // List of reference for power symbols
 SCH_REFERENCE_LIST references;
 SCH_REFERENCE_LIST additionalreferences; // Todo: add as a parameter to this function
 
 // Map of locked symbols (not used, but needed by Annotate()
 SCH_MULTI_UNIT_REFERENCE_MAP lockedSymbols;
 
 // Build the list of power symbols:
 for( SCH_SHEET_PATH& sheet : *this )
 {
 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
 LIB_SYMBOL* libSymbol = symbol->GetLibSymbolRef().get();
 
 if( libSymbol && libSymbol->IsPower() )
 {
 SCH_REFERENCE schReference( symbol, libSymbol, sheet );
 references.AddItem( schReference );
 }
 }
 }
 
 // Find duplicate, and silently clear annotation of duplicate
 std::map<wxString, int> ref_list; // stores the existing references
 
 for( unsigned ii = 0; ii< references.GetCount(); ++ii )
 {
 wxString curr_ref = references[ii].GetRef();
 
 if( ref_list.find( curr_ref ) == ref_list.end() )
 {
 ref_list[curr_ref] = ii;
 continue;
 }
 
 // Possible duplicate, if the ref ends by a number:
 if( curr_ref.Last() < '0' && curr_ref.Last() > '9' )
 continue; // not annotated
 
 // Duplicate: clear annotation by removing the number ending the ref
 while( curr_ref.Last() >= '0' && curr_ref.Last() <= '9' )
 curr_ref.RemoveLast();
 
 references[ii].SetRef( curr_ref );
 }
 
 // Break full symbol reference into name (prefix) and number:
 // example: IC1 become IC, and 1
 references.SplitReferences();
 
 // Ensure all power symbols have the reference starting by '#'
 // (Not sure this is really useful)
 for( unsigned ii = 0; ii< references.GetCount(); ++ii )
 {
 if( references[ii].GetRef()[0] != '#' )
 {
 wxString new_ref = "#" + references[ii].GetRef();
 references[ii].SetRef( new_ref );
 }
 }
 
 // Recalculate and update reference numbers in schematic
 references.Annotate( false, 0, 100, lockedSymbols, additionalreferences );
 references.UpdateAnnotation();
}

References SCH_REFERENCE_LIST::AddItem(), SCH_REFERENCE_LIST::Annotate(), SCH_REFERENCE_LIST::GetCount(), SCH_SYMBOL::GetLibSymbolRef(), LIB_SYMBOL::IsPower(), SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), EE_RTREE::OfType(), SCH_SYMBOL_T, SCH_REFERENCE_LIST::SplitReferences(), and SCH_REFERENCE_LIST::UpdateAnnotation().

Referenced by KI_TEST::LoadSchematic(), EESCHEMA_HELPERS::LoadSchematic(), DIALOG_ERC::OnRunERCClick(), SCH::readSchematicFromFile(), SCH_EDIT_FRAME::ReadyToNetlist(), DIALOG_ERC::testErc(), and SCH_EDIT_FRAME::WriteNetListFile().

BuildSheetList()

void SCH_SHEET_LIST::BuildSheetList	(	SCH_SHEET *	aSheet,
		bool	aCheckIntegrity
	)

Build the list of sheets and their sheet path from aSheet.

If aSheet is the root sheet, the full sheet path and sheet list are built.

The list will be ordered as per SCH_SCREEN::GetSheets which results in sheets being ordered in the legacy way of using the X and Y positions of the sheets.

See also

SortByPageNumbers to sort by page numbers

Parameters

aSheet

is the starting sheet from which the list is built, or NULL indicating that g_RootSheet should be used.

Exceptions

std::bad_alloc

if the memory for the sheet path list could not be allocated.

Definition at line 672 of file sch_sheet_path.cpp.

{
 wxCHECK_RET( aSheet != nullptr, wxT( "Cannot build sheet list from undefined sheet." ) );
 
 std::vector<SCH_SHEET*> badSheets;
 
 m_currentSheetPath.push_back( aSheet );
 m_currentSheetPath.SetVirtualPageNumber( static_cast<int>( size() ) + 1 );
 push_back( m_currentSheetPath );
 
 if( m_currentSheetPath.LastScreen() )
 {
 wxString parentFileName = aSheet->GetFileName();
 std::vector<SCH_ITEM*> childSheets;
 m_currentSheetPath.LastScreen()->GetSheets( &childSheets );
 
 for( SCH_ITEM* item : childSheets )
 {
 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
 
 if( aCheckIntegrity )
 {
 if( !m_currentSheetPath.TestForRecursion( sheet->GetFileName(), parentFileName ) )
 BuildSheetList( sheet, true );
 else
 badSheets.push_back( sheet );
 }
 else
 {
 BuildSheetList( sheet, false );
 }
 }
 }
 
 if( aCheckIntegrity )
 {
 for( SCH_SHEET* sheet : badSheets )
 {
 m_currentSheetPath.LastScreen()->Remove( sheet );
 m_currentSheetPath.LastScreen()->SetContentModified();
 }
 }
 
 m_currentSheetPath.pop_back();
}

References BuildSheetList(), SCH_SHEET::GetFileName(), SCH_SCREEN::GetSheets(), SCH_SHEET_PATH::LastScreen(), m_currentSheetPath, SCH_SHEET_PATH::pop_back(), SCH_SHEET_PATH::push_back(), SCH_SCREEN::Remove(), BASE_SCREEN::SetContentModified(), SCH_SHEET_PATH::SetVirtualPageNumber(), and SCH_SHEET_PATH::TestForRecursion().

Referenced by BuildSheetList(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPDFFile(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), SCHEMATIC::GetFullHierarchy(), and SCH_SHEET_LIST().

ClearModifyStatus()

void SCH_SHEET_LIST::ClearModifyStatus

(

)

Definition at line 782 of file sch_sheet_path.cpp.

{
 for( const SCH_SHEET_PATH& sheet : *this )
 {
 if( sheet.LastScreen() )
 sheet.LastScreen()->SetContentModified( false );
 }
}

References SCH_SHEET_PATH::LastScreen(), and BASE_SCREEN::SetContentModified().

Referenced by SCH_EDIT_FRAME::doCloseWindow().

FillItemMap()

void SCH_SHEET_LIST::FillItemMap

(

std::map< KIID, EDA_ITEM * > &

aMap

)

Fill an item cache for temporary use when many items need to be fetched.

Definition at line 836 of file sch_sheet_path.cpp.

{
 for( const SCH_SHEET_PATH& sheet : *this )
 {
 SCH_SCREEN* screen = sheet.LastScreen();
 
 for( SCH_ITEM* aItem : screen->Items() )
 {
 aMap[ aItem->m_Uuid ] = aItem;
 
 aItem->RunOnChildren(
 [&]( SCH_ITEM* aChild )
 {
 aMap[ aChild->m_Uuid ] = aChild;
 } );
 }
 }
}

References SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), and EDA_ITEM::m_Uuid.

Referenced by SCH_EDITOR_CONTROL::Paste(), and DIALOG_ERC::writeReport().

FindAllSheetsForScreen()

SCH_SHEET_LIST 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.

Definition at line 1060 of file sch_sheet_path.cpp.

{
 SCH_SHEET_LIST retval;
 
 for( const SCH_SHEET_PATH& sheetpath : *this )
 {
 if( sheetpath.LastScreen() == aScreen )
 retval.push_back( sheetpath );
 }
 
 return retval;
}

References SCH_SHEET_PATH::LastScreen().

Referenced by SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), and SCH_FIND_REPLACE_TOOL::ReplaceAll().

FindSheetForPath()

SCH_SHEET_PATH * SCH_SHEET_LIST::FindSheetForPath

(

const SCH_SHEET_PATH *

aPath

)

Return a pointer to the first SCH_SHEET_PATH object (not necessarily the only one) matching the provided path.

Returns nullptr if not found.

Definition at line 1036 of file sch_sheet_path.cpp.

{
 for( SCH_SHEET_PATH& path : *this )
 {
 if( path.Path() == aPath->Path() )
 return &path;
 }
 
 return nullptr;
}

References SCH_SHEET_PATH::Path(), and path.

Referenced by SCH_REFERENCE_LIST::ReannotateByOptions().

FindSheetForScreen()

SCH_SHEET_PATH * SCH_SHEET_LIST::FindSheetForScreen

(

const SCH_SCREEN *

aScreen

)

Return a pointer to the first SCH_SHEET_PATH object (not necessarily the only one) using a particular screen.

Definition at line 1048 of file sch_sheet_path.cpp.

{
 for( SCH_SHEET_PATH& sheetpath : *this )
 {
 if( sheetpath.LastScreen() == aScreen )
 return &sheetpath;
 }
 
 return nullptr;
}

References SCH_SHEET_PATH::LastScreen().

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

GetItem()

SCH_ITEM * SCH_SHEET_LIST::GetItem	(	const KIID &	aID,
		SCH_SHEET_PATH *	aPathOut = nullptr
	)		const

Fetch a SCH_ITEM by ID.

Also returns the sheet the item was found on in aPathOut.

Definition at line 792 of file sch_sheet_path.cpp.

{
 for( const SCH_SHEET_PATH& sheet : *this )
 {
 SCH_ITEM* item = sheet.GetItem( aID );
 
 if( item )
 {
 if( aPathOut )
 *aPathOut = sheet;
 
 return item;
 }
 }
 
 // Not found; weak reference has been deleted.
 return DELETED_SHEET_ITEM::GetInstance();
}

References DELETED_SHEET_ITEM::GetInstance(), and SCH_SHEET_PATH::GetItem().

Referenced by SCHEMATIC::ConvertKIIDsToRefs(), SCH_EDIT_FRAME::FocusOnItem(), SCH_EDIT_FRAME::GetItem(), TEST_SCH_REFERENCE_LIST_FIXTURE::getSymbolByKIID(), DIALOG_ERC::OnERCItemSelected(), SCHEMATIC::ResolveCrossReference(), SCH_EDIT_FRAME::ResolveERCExclusions(), and SCH_EDIT_FRAME::SaveSymbolToSchematic().

GetLastVirtualPageNumber()

int SCH_SHEET_LIST::GetLastVirtualPageNumber

(

)

const

Definition at line 1292 of file sch_sheet_path.cpp.

{
 int lastVirtualPageNumber = 1;
 
 for( const SCH_SHEET_PATH& sheetPath : *this )
 {
 if( sheetPath.GetVirtualPageNumber() > lastVirtualPageNumber )
 lastVirtualPageNumber = sheetPath.GetVirtualPageNumber();
 }
 
 return lastVirtualPageNumber;
}

References SCH_SHEET_PATH::GetVirtualPageNumber().

Referenced by SCH_EDIT_FRAME::LoadSheetFromFile().

GetMultiUnitSymbols()

void SCH_SHEET_LIST::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 list of sheets.

The map key for each element will be the reference designator.

Parameters

aRefList	Map of reference designators to reference lists
aIncludePowerSymbols	Set to false to only get normal symbols.

Definition at line 976 of file sch_sheet_path.cpp.

{
 for( SCH_SHEET_PATHS::const_iterator it = begin(); it != end(); ++it )
 {
 SCH_MULTI_UNIT_REFERENCE_MAP tempMap;
 ( *it ).GetMultiUnitSymbols( tempMap, aIncludePowerSymbols );
 
 for( SCH_MULTI_UNIT_REFERENCE_MAP::value_type& pair : tempMap )
 {
 // Merge this list into the main one
 unsigned n_refs = pair.second.GetCount();
 
 for( unsigned thisRef = 0; thisRef < n_refs; ++thisRef )
 aRefList[pair.first].AddItem( pair.second[thisRef] );
 }
 }
}

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::BackAnnotateSymbols(), ERC_TESTER::TestMissingUnits(), and ERC_TESTER::TestMultiunitFootprints().

GetPaths()

std::vector< KIID_PATH > SCH_SHEET_LIST::GetPaths

(

)

const

Definition at line 1148 of file sch_sheet_path.cpp.

{
 std::vector<KIID_PATH> paths;
 
 for( const SCH_SHEET_PATH& sheetPath : *this )
 paths.emplace_back( sheetPath.Path() );
 
 return paths;
}

References SCH_SHEET_PATH::Path().

GetSheetInstances()

std::vector< SCH_SHEET_INSTANCE > SCH_SHEET_LIST::GetSheetInstances

(

)

const

Fetch the instance information for all of the sheets in the hiearchy.

Returns

all of the sheet instance data for the hierarchy.

Definition at line 1159 of file sch_sheet_path.cpp.

{
 std::vector<SCH_SHEET_INSTANCE> retval;
 
 for( const SCH_SHEET_PATH& path : *this )
 {
 const SCH_SHEET* sheet = path.Last();
 
 wxCHECK2( sheet, continue );
 
 SCH_SHEET_INSTANCE instance;
 SCH_SHEET_PATH tmpPath = path;
 
 tmpPath.pop_back();
 instance.m_Path = tmpPath.Path();
 instance.m_PageNumber = path.GetPageNumber();
 
 retval.push_back( instance );
 }
 
 return retval;
}

References SCH_SHEET_INSTANCE::m_PageNumber, SCH_SHEET_INSTANCE::m_Path, SCH_SHEET_PATH::Path(), path, and SCH_SHEET_PATH::pop_back().

Referenced by SCH_SEXPR_PLUGIN::Format().

GetSheetPathByKIIDPath()

std::optional< SCH_SHEET_PATH > SCH_SHEET_LIST::GetSheetPathByKIIDPath	(	const KIID_PATH &	aPath,
		bool	aIncludeLastSheet = true
	)		const

Finds a SCH_SHEET_PATH that matches the provided KIID_PATH.

Parameters

aPath

The KIID_PATH to search for.

Definition at line 958 of file sch_sheet_path.cpp.

{
 for( const SCH_SHEET_PATH& sheet : *this )
 {
 KIID_PATH testPath = sheet.Path();
 
 if( !aIncludeLastSheet )
 testPath.pop_back();
 
 if( testPath == aPath )
 return SCH_SHEET_PATH( sheet );
 }
 
 return std::nullopt;
}

References SCH_SHEET_PATH::Path().

Referenced by SCH_MARKER::Deserialize(), findItemsFromSyncSelection(), SCH_SEXPR_PLUGIN::saveSheet(), and SCH_SEXPR_PLUGIN::saveSymbol().

GetSheetsWithinPath()

void SCH_SHEET_LIST::GetSheetsWithinPath	(	SCH_SHEET_PATHS &	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 aSheetPath as well as recursively downwards inside aSheetPath.

Parameters

aReferences	List of sheets to populate.
aSheetPath	Path to return sheets from

Definition at line 947 of file sch_sheet_path.cpp.

{
 for( const SCH_SHEET_PATH& sheet : *this )
 {
 if( sheet.IsContainedWithin( aSheetPath ) )
 aSheets.push_back( sheet );
 }
}

References SCH_SHEET_PATH::IsContainedWithin().

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDIT_FRAME::CheckAnnotate(), SCH_EDIT_FRAME::DeleteAnnotation(), and SCH_SEXPR_PLUGIN::Format().

GetSymbols()

void SCH_SHEET_LIST::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.

Parameters

aReferences	List of references to populate.
aIncludePowerSymbols	Set to false to only get normal symbols.
aForceIncludeOrphanSymbols	Set to true to include symbols having no symbol found in lib. The normal option is false, and set to true only to build the full list of symbols.

Definition at line 926 of file sch_sheet_path.cpp.

{
 for( const SCH_SHEET_PATH& sheet : *this )
 sheet.GetSymbols( aReferences, aIncludePowerSymbols, aForceIncludeOrphanSymbols );
}

References SCH_SHEET_PATH::GetSymbols().

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDITOR_CONTROL::AssignFootprints(), BACK_ANNOTATE::BackAnnotateSymbols(), SCH_EDIT_FRAME::CheckAnnotate(), SCHEMATIC::ConvertRefsToKIIDs(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), TEST_SCH_REFERENCE_LIST_FIXTURE::getAdditionalRefs(), DIALOG_EDIT_SYMBOLS_LIBID::initDlg(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), SCH_EDIT_FRAME::mapExistingAnnotation(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_TEXT_PROPERTIES::onScintillaCharAdded(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), and SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile().

GetSymbolsWithinPath()

void SCH_SHEET_LIST::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 within aSheetPath as well as recursively downwards inside aSheetPath.

Parameters

aReferences	List of references to populate.
aSheetPath	Path to return symbols from
aIncludePowerSymbols	Set to false to only get normal symbols.
aForceIncludeOrphanSymbols	Set to true to include symbols having no symbol found in lib. The normal option is false, and set to true only to build the full list of symbols.

Definition at line 934 of file sch_sheet_path.cpp.

{
 for( const SCH_SHEET_PATH& sheet : *this )
 {
 if( sheet.IsContainedWithin( aSheetPath ) )
 sheet.GetSymbols( aReferences, aIncludePowerSymbols, aForceIncludeOrphanSymbols );
 }
}

References SCH_SHEET_PATH::GetSymbols(), and SCH_SHEET_PATH::IsContainedWithin().

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), and SCH_SEXPR_PLUGIN::Format().

IsModified()

bool SCH_SHEET_LIST::IsModified

(

)

const

Check the entire hierarchy for any modifications.

Returns

True if the hierarchy is modified otherwise false.

Definition at line 770 of file sch_sheet_path.cpp.

{
 for( const SCH_SHEET_PATH& sheet : *this )
 {
 if( sheet.LastScreen() && sheet.LastScreen()->IsContentModified() )
 return true;
 }
 
 return false;
}

References BASE_SCREEN::IsContentModified(), and SCH_SHEET_PATH::LastScreen().

Referenced by SCH_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::IsContentModified(), and SCH_EDIT_FRAME::OpenProjectFiles().

NameExists()

bool SCH_SHEET_LIST::NameExists

(

const wxString &

aSheetName

)

const

Definition at line 746 of file sch_sheet_path.cpp.

{
 for( const SCH_SHEET_PATH& sheet : *this )
 {
 if( sheet.Last()->GetName() == aSheetName )
 return true;
 }
 
 return false;
}

References SCH_SHEET::GetName(), and SCH_SHEET_PATH::Last().

Referenced by SCH_EDITOR_CONTROL::Paste().

PageNumberExists()

bool SCH_SHEET_LIST::PageNumberExists

(

const wxString &

aPageNumber

)

const

Definition at line 758 of file sch_sheet_path.cpp.

{
 for( const SCH_SHEET_PATH& sheet : *this )
 {
 if( sheet.GetPageNumber() == aPageNumber )
 return true;
 }
 
 return false;
}

References SCH_SHEET_PATH::GetPageNumber().

Referenced by SCH_EDITOR_CONTROL::Paste().

RemoveSymbolInstances()

void SCH_SHEET_LIST::RemoveSymbolInstances

(

const SCH_SHEET_PATH &

aPrefixSheetPath

)

Definition at line 1219 of file sch_sheet_path.cpp.

{
 for( SCH_SHEET_PATH& sheetPath : *this )
 sheetPath.RemoveSymbolInstances( aPrefixSheetPath );
}

References SCH_SHEET_PATH::RemoveSymbolInstances().

SetInitialPageNumbers()

void SCH_SHEET_LIST::SetInitialPageNumbers

(

)

Set initial sheet page numbers.

The number scheme is base on the old pseudo sheet numbering algorithm prior to the implementation of user definable sheet page numbers.

Definition at line 1195 of file sch_sheet_path.cpp.

{
 // Don't accidentally renumber existing sheets.
 wxCHECK( AllSheetPageNumbersEmpty(), /* void */ );
 
 wxString tmp;
 int pageNumber = 1;
 
 for( SCH_SHEET_PATH& instance : *this )
 {
 tmp.Printf( "%d", pageNumber );
 instance.SetPageNumber( tmp );
 pageNumber += 1;
 }
}

References AllSheetPageNumbersEmpty(), and SCH_SHEET_PATH::SetPageNumber().

Referenced by BOOST_AUTO_TEST_CASE(), and SCH_EDIT_FRAME::OpenProjectFiles().

SortByPageNumbers()

void SCH_SHEET_LIST::SortByPageNumbers

(

bool

aUpdateVirtualPageNums = true

)

Sort the list of sheets by page number.

This should be called after BuildSheetList

If page numbers happen to be equal, then it compares the sheet names to ensure deterministic ordering.

Parameters

aUpdateVirtualPageNums

If true, updates the virtual page numbers to match the new ordering

Enforce strict ordering. If the page numbers are the same, use UUIDs

Definition at line 719 of file sch_sheet_path.cpp.

{
 std::sort( begin(), end(),
 []( SCH_SHEET_PATH a, SCH_SHEET_PATH b ) -> bool
 {
 int retval = a.ComparePageNum( b );
 
 if( retval < 0 )
 return true;
 else if( retval > 0 )
 return false;
 else 
 return a.GetCurrentHash() < b.GetCurrentHash();
 } );
 
 if( aUpdateVirtualPageNums )
 {
 int virtualPageNum = 1;
 
 for( SCH_SHEET_PATH& sheet : *this )
 {
 sheet.SetVirtualPageNumber( virtualPageNum++ );
 }
 }
}

References SCH_SHEET_PATH::ComparePageNum(), SCH_SHEET_PATH::GetCurrentHash(), and SCH_SHEET_PATH::SetVirtualPageNumber().

Referenced by SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPDFFile(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), SCH_SEXPR_PLUGIN::Format(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), and SCH_SHEET_LIST().

TestForRecursion()

bool SCH_SHEET_LIST::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 aSrcSheetHierarchy to the sheet stored in aDestFileName will cause recursion.

Parameters

aSrcSheetHierarchy	is the SCH_SHEET_LIST of the source sheet add to aDestFileName.
aDestFileName	is the file name of the destination sheet for aSrcFileName.

Returns

true if aFileName will cause recursion in the sheet path. Otherwise false.

Definition at line 996 of file sch_sheet_path.cpp.

{
 if( empty() )
 return false;
 
 SCHEMATIC* sch = at( 0 ).LastScreen()->Schematic();
 
 wxCHECK_MSG( sch, false, "No SCHEMATIC found in SCH_SHEET_LIST::TestForRecursion!" );
 
 wxFileName rootFn = sch->GetFileName();
 wxFileName destFn = aDestFileName;
 
 if( destFn.IsRelative() )
 destFn.MakeAbsolute( rootFn.GetPath() );
 
 // Test each SCH_SHEET_PATH in this SCH_SHEET_LIST for potential recursion.
 for( unsigned i = 0; i < size(); i++ )
 {
 // Test each SCH_SHEET_PATH in the source sheet.
 for( unsigned j = 0; j < aSrcSheetHierarchy.size(); j++ )
 {
 const SCH_SHEET_PATH* sheetPath = &aSrcSheetHierarchy[j];
 
 for( unsigned k = 0; k < sheetPath->size(); k++ )
 {
 if( at( i ).TestForRecursion( sheetPath->GetSheet( k )->GetFileName(),
 aDestFileName ) )
 {
 return true;
 }
 }
 }
 }
 
 // The source sheet file can safely be added to the destination sheet file.
 return false;
}

References empty(), SCH_SHEET::GetFileName(), SCHEMATIC::GetFileName(), SCH_SHEET_PATH::GetSheet(), and SCH_SHEET_PATH::size().

Referenced by SCH_EDIT_FRAME::CheckSheetForRecursion(), and SCH_EDITOR_CONTROL::Paste().

UpdateSheetInstanceData()

void SCH_SHEET_LIST::UpdateSheetInstanceData

(

const std::vector< SCH_SHEET_INSTANCE > &

aSheetInstances

)

Update all of the sheet instance information using aSheetInstances.

Warning

Do not call this on anything other than the full hierarchy.

Parameters

aSymbolInstances

is the symbol path information loaded from the root schematic.

Definition at line 1118 of file sch_sheet_path.cpp.

{
 
 for( SCH_SHEET_PATH& path : *this )
 {
 SCH_SHEET* sheet = path.Last();
 
 wxCHECK2( sheet && path.Last(), continue );
 
 auto it = std::find_if( aSheetInstances.begin(), aSheetInstances.end(),
 [ path ]( const SCH_SHEET_INSTANCE& r ) -> bool
 {
 return path.Path() == r.m_Path;
 } );
 
 if( it == aSheetInstances.end() )
 {
 wxLogTrace( traceSchSheetPaths, "No sheet instance found for path '%s'",
 path.Path().AsString() );
 continue;
 }
 
 wxLogTrace( traceSchSheetPaths, "Setting sheet '%s' instance '%s' page number '%s'",
 ( sheet->GetName().IsEmpty() ) ? wxString( wxT( "root" ) ) : sheet->GetName(),
 path.Path().AsString(), it->m_PageNumber );
 path.SetPageNumber( it->m_PageNumber );
 }
}

References SCH_SHEET::GetName(), path, and traceSchSheetPaths.

Referenced by KI_TEST::LoadSchematic(), EESCHEMA_HELPERS::LoadSchematic(), and SCH_EDIT_FRAME::OpenProjectFiles().

UpdateSymbolInstanceData()

void SCH_SHEET_LIST::UpdateSymbolInstanceData

(

const std::vector< SCH_SYMBOL_INSTANCE > &

aSymbolInstances

)

Update all of the symbol instance information using aSymbolInstances.

WARNING: Do not call this on anything other than the full hierarchy.

Parameters

aSymbolInstances

is the symbol path information loaded from the root schematic.

Definition at line 1074 of file sch_sheet_path.cpp.

{
 for( SCH_SHEET_PATH& sheetPath : *this )
 {
 for( SCH_ITEM* item : sheetPath.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
 
 wxCHECK2( symbol, continue );
 
 KIID_PATH sheetPathWithSymbolUuid = sheetPath.Path();
 sheetPathWithSymbolUuid.push_back( symbol->m_Uuid );
 
 auto it = std::find_if( aSymbolInstances.begin(), aSymbolInstances.end(),
 [ sheetPathWithSymbolUuid ]( const SCH_SYMBOL_INSTANCE& r ) -> bool
 {
 return sheetPathWithSymbolUuid == r.m_Path;
 } );
 
 if( it == aSymbolInstances.end() )
 {
 wxLogTrace( traceSchSheetPaths, "No symbol instance found for symbol '%s'",
 sheetPathWithSymbolUuid.AsString() );
 continue;
 }
 
 // Symbol instance paths are stored and looked up in memory with the root path so use
 // the full path here.
 symbol->AddHierarchicalReference( sheetPath.Path(), it->m_Reference, it->m_Unit );
 symbol->GetField( REFERENCE_FIELD )->SetText( it->m_Reference );
 
 if( !it->m_Value.IsEmpty() )
 symbol->SetValueFieldText( it->m_Value );
 
 if( !it->m_Footprint.IsEmpty() )
 symbol->SetFootprintFieldText( it->m_Footprint );
 
 symbol->UpdatePrefix();
 }
 }
}

References SCH_SYMBOL::AddHierarchicalReference(), KIID_PATH::AsString(), SCH_SYMBOL::GetField(), SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), EDA_ITEM::m_Uuid, EE_RTREE::OfType(), SCH_SHEET_PATH::Path(), REFERENCE_FIELD, SCH_SYMBOL_T, SCH_SYMBOL::SetFootprintFieldText(), EDA_TEXT::SetText(), SCH_SYMBOL::SetValueFieldText(), traceSchSheetPaths, and SCH_SYMBOL::UpdatePrefix().

Referenced by KI_TEST::LoadSchematic(), EESCHEMA_HELPERS::LoadSchematic(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_EDIT_FRAME::OpenProjectFiles(), and SCH::readSchematicFromFile().

Member Data Documentation

m_currentSheetPath

SCH_SHEET_PATH SCH_SHEET_LIST::m_currentSheetPath

private

Definition at line 676 of file sch_sheet_path.h.

Referenced by BuildSheetList().

---

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

• sch_sheet_path.h
• sch_sheet_path.cpp