SCH_SCREENS Class Reference

Container class that holds multiple SCH_SCREEN objects in a hierarchy. More...

#include <sch_screen.h>

Public Member Functions
	SCH_SCREENS (SCH_SHEET *aSheet)
	SCH_SCREENS (SCH_SHEET &aSheet)
	~SCH_SCREENS ()
size_t	GetCount () const
SCH_SCREEN *	GetFirst ()
SCH_SCREEN *	GetNext ()
SCH_SCREEN *	GetScreen (unsigned int aIndex) const
SCH_SHEET *	GetSheet (unsigned int aIndex) const
void	ClearAnnotationOfNewSheetPaths (SCH_SHEET_LIST &aInitialSheetPathList)
	Clear the annotation for the symbols inside new sheetpaths when a complex hierarchy is modified and new sheetpaths added when a screen shares more than one sheet path, missing alternate references are added and alternate references of new sheet paths are cleared. More...
int	ReplaceDuplicateTimeStamps ()
	Test all sheet and symbol objects in the schematic for duplicate time stamps and replaces them as necessary. More...
void	DeleteAllMarkers (enum MARKER_BASE::TYPEMARKER aMarkerType, bool aIncludeExclusions)
	Delete all electronic rules check markers of aMarkerType from all the screens in the list. More...
void	DeleteMarkers (enum MARKER_BASE::TYPEMARKER aMarkerTyp, int aErrorCode, bool aIncludeExclusions=true)
	Delete all markers of a particular type and error code. More...
void	DeleteMarker (SCH_MARKER *aMarker)
	Delete a specific marker. More...
void	UpdateSymbolLinks (REPORTER *aReporter=nullptr)
	Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in the full schematic. More...
void	ClearEditFlags ()
bool	HasNoFullyDefinedLibIds ()
	Test all of the schematic symbols to see if all LIB_ID objects library nickname is not set. More...
size_t	GetLibNicknames (wxArrayString &aLibNicknames)
	Fetch all of the symbol library nicknames into aLibNicknames. More...
int	ChangeSymbolLibNickname (const wxString &aFrom, const wxString &aTo)
	Change all of the symbol library nicknames. More...
bool	HasSchematic (const wxString &aSchematicFileName)
	Check if one of the schematics in the list of screens is aSchematicFileName. More...
void	BuildClientSheetPathList ()
	built the list of sheet paths sharing a screen for each screen in use More...
bool	CanCauseCaseSensitivityIssue (const wxString &aSchematicFileName) const
	Check aSchematicFileName for a potential file name case sensitivity issue. More...
void	SetLegacySymbolInstanceData ()
	Update the symbol value and footprint instance data for legacy designs. More...
void	FixLegacyPowerSymbolMismatches ()
	Fix legacy power symbols that have mismatched value text fields and invisible power pin names. More...

Private Member Functions
void	addScreenToList (SCH_SCREEN *aScreen, SCH_SHEET *aSheet)
void	buildScreenList (SCH_SHEET *aSheet)

Private Attributes
std::vector< SCH_SCREEN * >	m_screens
std::vector< SCH_SHEET * >	m_sheets
unsigned int	m_index

Detailed Description

Container class that holds multiple SCH_SCREEN objects in a hierarchy.

Individual SCH_SCREEN objects are unique and correspond to .sch files.

NOTE: It may be desirable to fold the functionality of SCH_SCREENS into the new SCHEMATIC class at some point, since SCHEMATIC can also be thought of as owning the collection of all the SCH_SCREEN objects.

Definition at line 661 of file sch_screen.h.

Constructor & Destructor Documentation

SCH_SCREENS() [1/2]

SCH_SCREENS::SCH_SCREENS

(

SCH_SHEET *

aSheet

)

Definition at line 1636 of file sch_screen.cpp.

{
 m_index = 0;
 buildScreenList( aSheet );
}

References buildScreenList(), and m_index.

SCH_SCREENS() [2/2]

SCH_SCREENS::SCH_SCREENS ( SCH_SHEET &  aSheet )

inline

Definition at line 665 of file sch_screen.h.

: SCH_SCREENS( &aSheet ) {}

~SCH_SCREENS()

SCH_SCREENS::~SCH_SCREENS

(

)

Definition at line 1643 of file sch_screen.cpp.

{
}

Member Function Documentation

addScreenToList()

void SCH_SCREENS::addScreenToList ( SCH_SCREEN *  aScreen, SCH_SHEET *  aSheet  )

private

Definition at line 1686 of file sch_screen.cpp.

{
 if( aScreen == nullptr )
 return;
 
 for( const SCH_SCREEN* screen : m_screens )
 {
 if( screen == aScreen )
 return;
 }
 
 m_screens.push_back( aScreen );
 m_sheets.push_back( aSheet );
}

References m_screens, and m_sheets.

Referenced by buildScreenList().

BuildClientSheetPathList()

void SCH_SCREENS::BuildClientSheetPathList

(

)

built the list of sheet paths sharing a screen for each screen in use

Definition at line 1987 of file sch_screen.cpp.

{
 SCH_SCREEN* first = GetFirst();
 
 if( !first )
 return;
 
 SCHEMATIC* sch = first->Schematic();
 
 wxCHECK_RET( sch, "Null schematic in SCH_SCREENS::BuildClientSheetPathList" );
 
 for( SCH_SCREEN* curr_screen = GetFirst(); curr_screen; curr_screen = GetNext() )
 curr_screen->GetClientSheetPaths().clear();
 
 for( SCH_SHEET_PATH& sheetpath : sch->GetSheets() )
 {
 SCH_SCREEN* used_screen = sheetpath.LastScreen();
 
 // Search for the used_screen in list and add this unique sheet path:
 for( SCH_SCREEN* curr_screen = GetFirst(); curr_screen; curr_screen = GetNext() )
 {
 if( used_screen == curr_screen )
 {
 curr_screen->GetClientSheetPaths().push_back( sheetpath );
 break;
 }
 }
 }
}

References SCH_SCREEN::GetClientSheetPaths(), GetFirst(), GetNext(), SCHEMATIC::GetSheets(), and SCH_SCREEN::Schematic().

Referenced by ClearAnnotationOfNewSheetPaths(), SCH_FIND_REPLACE_TOOL::FindNext(), and SCH_EDIT_FRAME::SaveProject().

buildScreenList()

void SCH_SCREENS::buildScreenList ( SCH_SHEET *  aSheet )

private

Definition at line 1702 of file sch_screen.cpp.

{
 if( aSheet && aSheet->Type() == SCH_SHEET_T )
 {
 SCH_SCREEN* screen = aSheet->GetScreen();
 
 wxCHECK_RET( screen, "No screen for aSheet" );
 
 addScreenToList( screen, aSheet );
 
 for( SCH_ITEM* item : screen->Items().OfType( SCH_SHEET_T ) )
 buildScreenList( static_cast<SCH_SHEET*>( item ) );
 }
}

References addScreenToList(), buildScreenList(), SCH_SHEET::GetScreen(), SCH_SCREEN::Items(), EE_RTREE::OfType(), SCH_SHEET_T, and EDA_ITEM::Type().

Referenced by buildScreenList(), and SCH_SCREENS().

CanCauseCaseSensitivityIssue()

bool SCH_SCREENS::CanCauseCaseSensitivityIssue

(

const wxString &

aSchematicFileName

)

const

Check aSchematicFileName for a potential file name case sensitivity issue.

On platforms where file names are case sensitive, it is possible to schematic sheet file names that would cause issues on platforms where file name are case insensitive. File names foo.sch and Foo.sch are unique files on Linux and MacOS but on Windows this would result in a broken schematic.

Parameters

[in]

aSchematicFileName

is the absolute path and file name of the file to test.

Returns

true if aSchematicFileName would cause an issue.

Definition at line 1960 of file sch_screen.cpp.

{
 wxString lhsLower;
 wxString rhsLower;
 wxFileName lhs;
 wxFileName rhs = aSchematicFileName;
 
 wxCHECK( rhs.IsAbsolute(), false );
 
 for( const SCH_SCREEN* screen : m_screens )
 {
 lhs = screen->GetFileName();
 
 if( lhs.GetPath() != rhs.GetPath() )
 continue;
 
 lhsLower = lhs.GetFullName().Lower();
 rhsLower = rhs.GetFullName().Lower();
 
 if( lhsLower == rhsLower && lhs.GetFullName() != rhs.GetFullName() )
 return true;
 }
 
 return false;
}

References m_screens.

Referenced by SCH_EDIT_FRAME::AllowCaseSensitiveFileNameClashes().

ChangeSymbolLibNickname()

int SCH_SCREENS::ChangeSymbolLibNickname	(	const wxString &	aFrom,
		const wxString &	aTo
	)

Change all of the symbol library nicknames.

Parameters

[in]	aFrom	the current symbol library name to change.
[in]	aTo	the new symbol library name.

Returns

the number of symbol library nicknames that were changed.

Definition at line 1923 of file sch_screen.cpp.

{
 SCH_SCREEN* screen;
 int cnt = 0;
 
 for( screen = GetFirst(); screen; screen = GetNext() )
 {
 for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
 
 if( symbol->GetLibId().GetLibNickname() != aFrom )
 continue;
 
 LIB_ID id = symbol->GetLibId();
 id.SetLibNickname( aTo );
 symbol->SetLibId( id );
 cnt++;
 }
 }
 
 return cnt;
}

References GetFirst(), SCH_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), GetNext(), SCH_SCREEN::Items(), EE_RTREE::OfType(), SCH_SYMBOL_T, SCH_SYMBOL::SetLibId(), and LIB_ID::SetLibNickname().

ClearAnnotationOfNewSheetPaths()

void SCH_SCREENS::ClearAnnotationOfNewSheetPaths

(

SCH_SHEET_LIST &

aInitialSheetPathList

)

Clear the annotation for the symbols inside new sheetpaths when a complex hierarchy is modified and new sheetpaths added when a screen shares more than one sheet path, missing alternate references are added and alternate references of new sheet paths are cleared.

Parameters

aInitialSheetPathList

is the initial sheet paths list of hierarchy before changes.

Definition at line 1718 of file sch_screen.cpp.

{
 SCH_SCREEN* first = GetFirst();
 
 if( !first )
 return;
 
 SCHEMATIC* sch = first->Schematic();
 
 wxCHECK_RET( sch, "Null schematic in SCH_SCREENS::ClearAnnotationOfNewSheetPaths" );
 
 // Clear the annotation for symbols inside new sheetpaths not already in aInitialSheetList
 SCH_SCREENS screensList( sch->Root() ); // The list of screens, shared by sheet paths
 screensList.BuildClientSheetPathList(); // build the shared by sheet paths, by screen
 
 // Search for new sheet paths, not existing in aInitialSheetPathList
 // and existing in sheetpathList
 for( SCH_SHEET_PATH& sheetpath : sch->GetSheets() )
 {
 bool path_exists = false;
 
 for( const SCH_SHEET_PATH& existing_sheetpath: aInitialSheetPathList )
 {
 if( existing_sheetpath.Path() == sheetpath.Path() )
 {
 path_exists = true;
 break;
 }
 }
 
 if( !path_exists )
 {
 // A new sheet path is found: clear the annotation corresponding to this new path:
 SCH_SCREEN* curr_screen = sheetpath.LastScreen();
 
 // Clear annotation and create the AR for this path, if not exists,
 // when the screen is shared by sheet paths.
 // Otherwise ClearAnnotation do nothing, because the F1 field is used as
 // reference default value and takes the latest displayed value
 curr_screen->EnsureAlternateReferencesExist();
 curr_screen->ClearAnnotation( &sheetpath, false );
 }
 }
}

References BuildClientSheetPathList(), SCH_SCREEN::ClearAnnotation(), SCH_SCREEN::EnsureAlternateReferencesExist(), GetFirst(), SCHEMATIC::GetSheets(), SCHEMATIC::Root(), and SCH_SCREEN::Schematic().

Referenced by SCH_EDIT_TOOL::Properties().

ClearEditFlags()

void SCH_SCREENS::ClearEditFlags

(

)

Definition at line 1802 of file sch_screen.cpp.

{
 for( SCH_SCREEN* screen = GetFirst(); screen; screen = GetNext() )
 {
 for( SCH_ITEM* item : screen->Items() )
 item->ClearEditFlags();
 }
}

References GetFirst(), and GetNext().

Referenced by SCH_ALTIUM_PLUGIN::Load().

DeleteAllMarkers()

void SCH_SCREENS::DeleteAllMarkers	(	enum MARKER_BASE::TYPEMARKER	aMarkerType,
		bool	aIncludeExclusions
	)

Delete all electronic rules check markers of aMarkerType from all the screens in the list.

Parameters

aMarkerType

Type of markers to be deleted.

Definition at line 1854 of file sch_screen.cpp.

{
 DeleteMarkers( aMarkerType, ERCE_UNSPECIFIED, aIncludeExclusions );
}

References DeleteMarkers(), and ERCE_UNSPECIFIED.

Referenced by DIALOG_ERC::deleteAllMarkers().

DeleteMarker()

void SCH_SCREENS::DeleteMarker

(

SCH_MARKER *

aMarker

)

Delete a specific marker.

Definition at line 1812 of file sch_screen.cpp.

{
 for( SCH_SCREEN* screen = GetFirst(); screen; screen = GetNext() )
 {
 for( SCH_ITEM* item : screen->Items().OfType( SCH_MARKER_T ) )
 {
 if( item == aMarker )
 {
 screen->DeleteItem( item );
 return;
 }
 }
 }
}

References GetFirst(), GetNext(), and SCH_MARKER_T.

Referenced by SHEETLIST_ERC_ITEMS_PROVIDER::DeleteItem().

DeleteMarkers()

void SCH_SCREENS::DeleteMarkers	(	enum MARKER_BASE::TYPEMARKER	aMarkerTyp,
		int	aErrorCode,
		bool	aIncludeExclusions = true
	)

Delete all markers of a particular type and error code.

Definition at line 1828 of file sch_screen.cpp.

{
 for( SCH_SCREEN* screen = GetFirst(); screen; screen = GetNext() )
 {
 std::vector<SCH_ITEM*> markers;
 
 for( SCH_ITEM* item : screen->Items().OfType( SCH_MARKER_T ) )
 {
 SCH_MARKER* marker = static_cast<SCH_MARKER*>( item );
 std::shared_ptr<RC_ITEM>rcItem = marker->GetRCItem();
 
 if( marker->GetMarkerType() == aMarkerType
 && ( aErrorCode == ERCE_UNSPECIFIED || rcItem->GetErrorCode() == aErrorCode )
 && ( !marker->IsExcluded() || aIncludeExclusions ) )
 {
 markers.push_back( item );
 }
 }
 
 for( SCH_ITEM* marker : markers )
 screen->DeleteItem( marker );
 }
}

References ERCE_UNSPECIFIED, GetFirst(), MARKER_BASE::GetMarkerType(), GetNext(), MARKER_BASE::GetRCItem(), MARKER_BASE::IsExcluded(), and SCH_MARKER_T.

Referenced by DeleteAllMarkers(), and DIALOG_ERC::OnERCItemRClick().

FixLegacyPowerSymbolMismatches()

void SCH_SCREENS::FixLegacyPowerSymbolMismatches

(

)

Fix legacy power symbols that have mismatched value text fields and invisible power pin names.

Definition at line 2025 of file sch_screen.cpp.

{
 for( SCH_SCREEN* screen = GetFirst(); screen; screen = GetNext() )
 screen->FixLegacyPowerSymbolMismatches();
}

References GetFirst(), and GetNext().

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

GetCount()

size_t SCH_SCREENS::GetCount ( ) const

inline

Definition at line 667 of file sch_screen.h.

{ return m_screens.size(); }

References m_screens.

Referenced by SCH_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::SaveProject(), and SCH_EDIT_FRAME::updateAutoSaveFile().

GetFirst()

SCH_SCREEN * SCH_SCREENS::GetFirst

(

)

Definition at line 1648 of file sch_screen.cpp.

{
 m_index = 0;
 
 if( m_screens.size() > 0 )
 return m_screens[0];
 
 return nullptr;
}

References m_index, and m_screens.

Referenced by SCH_EDIT_FRAME::AskToSaveChanges(), DIALOG_SYMBOL_REMAP::backupProject(), BuildClientSheetPathList(), ChangeSymbolLibNickname(), ClearAnnotationOfNewSheetPaths(), ClearEditFlags(), SCH_EDIT_FRAME::CreateArchiveLibrary(), DeleteMarker(), DeleteMarkers(), SCH_EDIT_FRAME::doCloseWindow(), SCH_FIND_REPLACE_TOOL::FindNext(), FixLegacyPowerSymbolMismatches(), GetLibNicknames(), getSymbols(), HasNoFullyDefinedLibIds(), HasSchematic(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), KI_TEST::LoadSchematic(), EESCHEMA_HELPERS::LoadSchematic(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH::readSchematicFromFile(), SCHEMATIC::RecomputeIntersheetRefs(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_EDITOR_CONTROL::Revert(), SetLegacySymbolInstanceData(), SCHEMATIC::SetSheetNumberAndCount(), ERC_TESTER::TestConflictingBusAliases(), ERC_TESTER::TestDuplicateSheetNames(), ERC_TESTER::TestLibSymbolIssues(), TEST_NETLIST_EXPORTER_FIXTURE< NETLIST_EXPORTER_KICAD >::TestNetlist(), ERC_TESTER::TestOffGridEndpoints(), PANEL_SETUP_BUSES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), PANEL_SETUP_BUSES::TransferDataToWindow(), and UpdateSymbolLinks().

GetLibNicknames()

size_t SCH_SCREENS::GetLibNicknames

(

wxArrayString &

aLibNicknames

)

Fetch all of the symbol library nicknames into aLibNicknames.

Parameters

[out]

aLibNicknames

is the array to populate with all of the unique library nicknames.

Returns

the number of symbol library nicknames found.

Definition at line 1905 of file sch_screen.cpp.

{
 for( SCH_SCREEN* screen = GetFirst(); screen; screen = GetNext() )
 {
 for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
 const UTF8& nickname = symbol->GetLibId().GetLibNickname();
 
 if( !nickname.empty() && ( aLibNicknames.Index( nickname ) == wxNOT_FOUND ) )
 aLibNicknames.Add( nickname );
 }
 }
 
 return aLibNicknames.GetCount();
}

References UTF8::empty(), GetFirst(), SCH_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), GetNext(), and SCH_SYMBOL_T.

Referenced by SCH_EDIT_FRAME::LoadSheetFromFile().

GetNext()

SCH_SCREEN * SCH_SCREENS::GetNext

(

)

Definition at line 1659 of file sch_screen.cpp.

{
 if( m_index < m_screens.size() )
 m_index++;
 
 return GetScreen( m_index );
}

References GetScreen(), m_index, and m_screens.

Referenced by SCH_EDIT_FRAME::AskToSaveChanges(), DIALOG_SYMBOL_REMAP::backupProject(), BuildClientSheetPathList(), ChangeSymbolLibNickname(), ClearEditFlags(), SCH_EDIT_FRAME::CreateArchiveLibrary(), DeleteMarker(), DeleteMarkers(), SCH_EDIT_FRAME::doCloseWindow(), SCH_FIND_REPLACE_TOOL::FindNext(), FixLegacyPowerSymbolMismatches(), GetLibNicknames(), getSymbols(), HasNoFullyDefinedLibIds(), HasSchematic(), KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), KI_TEST::LoadSchematic(), EESCHEMA_HELPERS::LoadSchematic(), DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH::readSchematicFromFile(), SCHEMATIC::RecomputeIntersheetRefs(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_EDITOR_CONTROL::Revert(), SetLegacySymbolInstanceData(), SCHEMATIC::SetSheetNumberAndCount(), ERC_TESTER::TestConflictingBusAliases(), ERC_TESTER::TestDuplicateSheetNames(), ERC_TESTER::TestLibSymbolIssues(), TEST_NETLIST_EXPORTER_FIXTURE< NETLIST_EXPORTER_KICAD >::TestNetlist(), ERC_TESTER::TestOffGridEndpoints(), PANEL_SETUP_BUSES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), PANEL_SETUP_BUSES::TransferDataToWindow(), and UpdateSymbolLinks().

GetScreen()

SCH_SCREEN * SCH_SCREENS::GetScreen

(

unsigned int

aIndex

)

const

Definition at line 1668 of file sch_screen.cpp.

{
 if( aIndex < m_screens.size() )
 return m_screens[ aIndex ];
 
 return nullptr;
}

References m_screens.

Referenced by SCH_EDIT_FRAME::doAutoSave(), GetNext(), SCH_EDIT_FRAME::SaveProject(), and SCH_EDIT_FRAME::updateAutoSaveFile().

GetSheet()

SCH_SHEET * SCH_SCREENS::GetSheet

(

unsigned int

aIndex

)

const

Definition at line 1677 of file sch_screen.cpp.

{
 if( aIndex < m_sheets.size() )
 return m_sheets[ aIndex ];
 
 return nullptr;
}

References m_sheets.

Referenced by SCH_EDIT_FRAME::doAutoSave(), and SCH_EDIT_FRAME::SaveProject().

HasNoFullyDefinedLibIds()

bool SCH_SCREENS::HasNoFullyDefinedLibIds

(

)

Test all of the schematic symbols to see if all LIB_ID objects library nickname is not set.

If none of the LIB_ID object library nicknames are not set, this indicates that the project was created before the symbol library implementation.

Returns

true in there are any symbols and if all of the LIB_ID object library nicknames are empty, otherwise false.

Definition at line 1884 of file sch_screen.cpp.

{
 bool has_symbols = false;
 
 for( SCH_SCREEN* screen = GetFirst(); screen; screen = GetNext() )
 {
 for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
 has_symbols = true;
 
 if( !symbol->GetLibId().GetLibNickname().empty() )
 return false;
 }
 }
 
 // return true (i.e. has no fully defined symbol) only if at least one symbol is found
 return has_symbols ? true : false;
}

References UTF8::empty(), GetFirst(), SCH_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), GetNext(), and SCH_SYMBOL_T.

Referenced by SCH_EDIT_FRAME::checkForNoFullyDefinedLibIds(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::RescueSymbols(), and SCH_EDIT_FRAME::setupUIConditions().

HasSchematic()

bool SCH_SCREENS::HasSchematic

(

const wxString &

aSchematicFileName

)

Check if one of the schematics in the list of screens is aSchematicFileName.

Schematic file names in SCH_SCREEN object are stored with the absolute path to the schematic file.

Parameters

[in]

aSchematicFileName

is the schematic file name to search.

Returns

true if the a schematic matching the file name has been found.

Definition at line 1948 of file sch_screen.cpp.

{
 for( const SCH_SCREEN* screen = GetFirst(); screen; screen = GetNext() )
 {
 if( screen->GetFileName() == aSchematicFileName )
 return true;
 }
 
 return false;
}

References GetFirst(), and GetNext().

Referenced by SCH_EDIT_FRAME::LoadSheetFromFile().

ReplaceDuplicateTimeStamps()

int SCH_SCREENS::ReplaceDuplicateTimeStamps

(

)

Test all sheet and symbol objects in the schematic for duplicate time stamps and replaces them as necessary.

Time stamps must be unique in order for complex hierarchies know which symbols go to which sheets.

Returns

The number of duplicate time stamps replaced.

Definition at line 1764 of file sch_screen.cpp.

{
 std::vector<SCH_ITEM*> items;
 int count = 0;
 
 auto timestamp_cmp = []( const EDA_ITEM* a, const EDA_ITEM* b ) -> bool
 {
 return a->m_Uuid < b->m_Uuid;
 };
 
 std::set<EDA_ITEM*, decltype( timestamp_cmp )> unique_stamps( timestamp_cmp );
 
 for( SCH_SCREEN* screen : m_screens )
 screen->GetHierarchicalItems( &items );
 
 if( items.size() < 2 )
 return 0;
 
 for( EDA_ITEM* item : items )
 {
 if( !unique_stamps.insert( item ).second )
 {
 // Reset to fully random UUID. This may lose reference, but better to be
 // deterministic about it rather than to have duplicate UUIDs with random
 // side-effects.
 const_cast<KIID&>( item->m_Uuid ) = KIID();
 count++;
 
 // @todo If the item is a sheet, we need to decend the heirarchy from the sheet
 // and repace all instances of the changed UUID in sheet paths. Otherwise,
 // all instance paths with the sheet's UUID will get clobbered.
 }
 }
 
 return count;
}

References m_screens, and EDA_ITEM::m_Uuid.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDIT_FRAME::LoadSheetFromFile(), and SCH_EDIT_FRAME::OpenProjectFiles().

SetLegacySymbolInstanceData()

void SCH_SCREENS::SetLegacySymbolInstanceData

(

)

Update the symbol value and footprint instance data for legacy designs.

Definition at line 2018 of file sch_screen.cpp.

{
 for( SCH_SCREEN* screen = GetFirst(); screen; screen = GetNext() )
 screen->SetLegacySymbolInstanceData();
}

References GetFirst(), and GetNext().

Referenced by SCHEMATIC::SetLegacySymbolInstanceData().

UpdateSymbolLinks()

void SCH_SCREENS::UpdateSymbolLinks

(

REPORTER *

aReporter = nullptr

)

Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in the full schematic.

Note

This should only be called when the user specifically requests all library symbol links to be update or when the legacy schematic is opened for the last time. All subsequent schematic loads with the new s-expression will contain the library symbols.

Parameters

[in]

aReporter

An optional REPORTER object pointer to write warning and error messages into.

Definition at line 1861 of file sch_screen.cpp.

{
 for( SCH_SCREEN* screen = GetFirst(); screen; screen = GetNext() )
 screen->UpdateSymbolLinks( aReporter );
 
 SCH_SCREEN* first = GetFirst();
 
 if( !first )
 return;
 
 SCHEMATIC* sch = first->Schematic();
 
 wxCHECK_RET( sch, "Null schematic in SCH_SCREENS::UpdateSymbolLinks" );
 
 SCH_SHEET_LIST sheets = sch->GetSheets();
 
 // All of the library symbols have been replaced with copies so the connection graph
 // pointers are stale.
 if( sch->ConnectionGraph() )
 sch->ConnectionGraph()->Recalculate( sheets, true );
}

References SCHEMATIC::ConnectionGraph(), GetFirst(), GetNext(), SCHEMATIC::GetSheets(), CONNECTION_GRAPH::Recalculate(), and SCH_SCREEN::Schematic().

Referenced by SCH_EDIT_FRAME::CreateArchiveLibraryCacheFile(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_EDIT_FRAME::OpenProjectFiles(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), SCH_EDITOR_CONTROL::rescueProject(), LEGACY_RESCUER::WriteRescueLibrary(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

Member Data Documentation

m_index

unsigned int SCH_SCREENS::m_index

private

Definition at line 803 of file sch_screen.h.

Referenced by GetFirst(), GetNext(), and SCH_SCREENS().

m_screens

std::vector< SCH_SCREEN* > SCH_SCREENS::m_screens

private

Definition at line 801 of file sch_screen.h.

Referenced by addScreenToList(), CanCauseCaseSensitivityIssue(), GetCount(), GetFirst(), GetNext(), GetScreen(), and ReplaceDuplicateTimeStamps().

m_sheets

std::vector< SCH_SHEET* > SCH_SCREENS::m_sheets

private

Definition at line 802 of file sch_screen.h.

Referenced by addScreenToList(), and GetSheet().

---

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

• sch_screen.h
• sch_screen.cpp