SCH_SHEET_PATH Class Reference

Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened schematic hierarchy. More...

#include <sch_sheet_path.h>

Public Member Functions
	SCH_SHEET_PATH ()
	SCH_SHEET_PATH (const SCH_SHEET_PATH &aOther)
SCH_SHEET_PATH &	operator= (const SCH_SHEET_PATH &aOther)
	~SCH_SHEET_PATH ()=default
SCH_SHEET *	at (size_t aIndex) const
	Forwarded method from std::vector. More...
void	clear ()
	Forwarded method from std::vector. More...
bool	empty () const
	Forwarded method from std::vector. More...
void	pop_back ()
	Forwarded method from std::vector. More...
void	push_back (SCH_SHEET *aSheet)
	Forwarded method from std::vector. More...
size_t	size () const
	Forwarded method from std::vector. More...
void	Rehash ()
size_t	GetCurrentHash () const
void	SetVirtualPageNumber (int aPageNumber)
	Set the sheet instance virtual page number. More...
int	GetVirtualPageNumber () const
void	SetPageNumber (const wxString &aPageNumber)
	Set the sheet instance user definable page number. More...
wxString	GetPageNumber () const
const SCH_SHEET *	GetSheet (unsigned aIndex) const
int	Cmp (const SCH_SHEET_PATH &aSheetPathToTest) const
	Compare if this is the same sheet path as aSheetPathToTest. More...
int	ComparePageNumAndName (const SCH_SHEET_PATH &aSheetPathToTest) const
	Compare sheets by their page number and then by their name. More...
bool	IsContainedWithin (const SCH_SHEET_PATH &aSheetPathToTest) const
	Check if this path is contained inside aSheetPathToTest. More...
SCH_SHEET *	Last () const
	Return a pointer to the last SCH_SHEET of the list. More...
SCH_SCREEN *	LastScreen ()
SCH_SCREEN *	LastScreen () const
wxString	PathAsString () const
	Return the path of time stamps which do not changes even when editing sheet parameters. More...
KIID_PATH	Path () const
	Get the sheet path as an KIID_PATH. More...
KIID_PATH	PathWithoutRootUuid () const
	Get the sheet path as an KIID_PATH without the root sheet UUID prefix. More...
wxString	PathHumanReadable (bool aUseShortRootName=true) const
	Return the sheet path in a human readable form made from the sheet names. More...
void	UpdateAllScreenReferences ()
	Update all the symbol references for this sheet path. More...
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. More...
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. More...
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-unit parts together. 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 sheet. More...
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 sheet stored in file aDestFileName will cause a sheet path recursion. More...
void	MakeFilePathRelativeToParentSheet ()
	Make the sheet file name relative to its parent sheet. More...
bool	operator== (const SCH_SHEET_PATH &d1) const
bool	operator!= (const SCH_SHEET_PATH &d1) const
bool	operator< (const SCH_SHEET_PATH &d1) const

Protected Attributes
std::vector< SCH_SHEET * >	m_sheets
size_t	m_current_hash
int	m_virtualPageNumber
std::map< std::pair< wxString, wxString >, bool >	m_recursion_test_cache
	Page numbers are maintained by the sheet load order. More...

Private Member Functions
void	initFromOther (const SCH_SHEET_PATH &aOther)

Detailed Description

Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened schematic hierarchy.

The SCH_SHEET objects are stored in a list from first (usually the root sheet) to a given sheet in last position. The last sheet is usually the sheet we want to select or reach (which is what the function Last() returns). Others sheets constitute the "path" from the first to the last sheet.

Definition at line 128 of file sch_sheet_path.h.

Constructor & Destructor Documentation

SCH_SHEET_PATH() [1/2]

SCH_SHEET_PATH::SCH_SHEET_PATH

(

)

Definition at line 98 of file sch_sheet_path.cpp.

{
    m_virtualPageNumber = 0;
    m_current_hash = 0;
}

References m_current_hash, and m_virtualPageNumber.

SCH_SHEET_PATH() [2/2]

SCH_SHEET_PATH::SCH_SHEET_PATH

(

const SCH_SHEET_PATH &

aOther

)

Definition at line 105 of file sch_sheet_path.cpp.

{
    initFromOther( aOther );
}

References initFromOther().

~SCH_SHEET_PATH()

SCH_SHEET_PATH::~SCH_SHEET_PATH ( )

default

Member Function Documentation

AppendMultiUnitSymbol()

void SCH_SHEET_PATH::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-unit parts together.

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

Parameters

aRefList	Map of reference designators to reference lists
aSymbol	A symbol to add to aRefList
aIncludePowerSymbols	Set to false to only get normal symbols.

Definition at line 344 of file sch_sheet_path.cpp.

{
    // Skip pseudo-symbols, which have a reference starting with #.  This mainly
    // affects power symbols.
    if( !aIncludePowerSymbols && aSymbol->GetRef( this )[0] == wxT( '#' ) )
        return;

    LIB_SYMBOL* symbol = aSymbol->GetLibSymbolRef().get();

    if( symbol && symbol->GetUnitCount() > 1 )
    {
        SCH_REFERENCE schReference = SCH_REFERENCE( aSymbol, symbol, *this );
        schReference.SetSheetNumber( m_virtualPageNumber );
        wxString reference_str = schReference.GetRef();

        // Never lock unassigned references
        if( reference_str[reference_str.Len() - 1] == '?' )
            return;

        aRefList[reference_str].AddItem( schReference );
    }
}

References SCH_SYMBOL::GetLibSymbolRef(), SCH_REFERENCE::GetRef(), SCH_SYMBOL::GetRef(), LIB_SYMBOL::GetUnitCount(), m_virtualPageNumber, and SCH_REFERENCE::SetSheetNumber().

Referenced by EE_SELECTION::GetMultiUnitSymbols(), and GetMultiUnitSymbols().

AppendSymbol()

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

Parameters

aReferences	List of references to populate.
aSymbol	A symbol to add to aReferences
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 312 of file sch_sheet_path.cpp.

{
    // Skip pseudo-symbols, which have a reference starting with #.  This mainly
    // affects power symbols.
    if( aIncludePowerSymbols || aSymbol->GetRef( this )[0] != wxT( '#' ) )
    {
        LIB_SYMBOL* symbol = aSymbol->GetLibSymbolRef().get();

        if( symbol || aForceIncludeOrphanSymbols )
        {
            SCH_REFERENCE schReference( aSymbol, symbol, *this );

            schReference.SetSheetNumber( m_virtualPageNumber );
            aReferences.AddItem( schReference );
        }
    }
}

References SCH_REFERENCE_LIST::AddItem(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetRef(), m_virtualPageNumber, and SCH_REFERENCE::SetSheetNumber().

Referenced by SCH_SEXPR_PLUGIN::Format(), EE_SELECTION::GetSymbols(), and GetSymbols().

at()

SCH_SHEET* SCH_SHEET_PATH::at ( size_t  aIndex ) const

inline

Forwarded method from std::vector.

Definition at line 140 of file sch_sheet_path.h.

{ return m_sheets.at( aIndex ); }

References m_sheets.

Referenced by Cmp(), GetSheet(), SCH_EDIT_FRAME::GetUniqueFilenameForCurrentSheet(), IsContainedWithin(), PathAsString(), PathHumanReadable(), PathWithoutRootUuid(), and TestForRecursion().

clear()

void SCH_SHEET_PATH::clear ( )

inline

Forwarded method from std::vector.

Definition at line 143 of file sch_sheet_path.h.

    {
        m_sheets.clear();
        Rehash();
    }

References m_sheets, and Rehash().

Referenced by SCH_EDIT_FRAME::doCloseWindow(), TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), SCHEMATIC::Reset(), SCHEMATIC::SetRoot(), and HIERARCHY_NAVIG_DLG::UpdateHierarchyTree().

Cmp()

int SCH_SHEET_PATH::Cmp

(

const SCH_SHEET_PATH &

aSheetPathToTest

)

const

Compare if this is the same sheet path as aSheetPathToTest.

Parameters

aSheetPathToTest

is the sheet path to compare.

Returns

1 if this sheet path has more sheets than aSheetPathToTest, -1 if this sheet path has fewer sheets than aSheetPathToTest, or 0 if same

Definition at line 138 of file sch_sheet_path.cpp.

{
    if( size() > aSheetPathToTest.size() )
        return 1;

    if( size() < aSheetPathToTest.size() )
        return -1;

    //otherwise, same number of sheets.
    for( unsigned i = 0; i < size(); i++ )
    {
        if( at( i )->m_Uuid < aSheetPathToTest.at( i )->m_Uuid )
            return -1;

        if( at( i )->m_Uuid != aSheetPathToTest.at( i )->m_Uuid )
            return 1;
    }

    return 0;
}

References at(), EDA_ITEM::m_Uuid, and size().

Referenced by SCH_REFERENCE_LIST::sortByTimeStamp().

ComparePageNumAndName()

int SCH_SHEET_PATH::ComparePageNumAndName

(

const SCH_SHEET_PATH &

aSheetPathToTest

)

const

Compare sheets by their page number and then by their name.

Finally compare using Cmp()

Returns

-1 if aSheetPathToTest is greater than this (should appear later in the sort order) 0 if aSheetPathToTest is equal to this 1 if aSheetPathToTest is less than this (should appear earlier in the sort order)

Definition at line 160 of file sch_sheet_path.cpp.

{
    wxString pageA = GetPageNumber();
    wxString pageB = aSheetPathToTest.GetPageNumber();

    int pageNumComp = SCH_SHEET::ComparePageNum( pageA, pageB );

    if( pageNumComp == 0 )
    {
        wxString nameA = Last()->GetName();
        wxString nameB = aSheetPathToTest.Last()->GetName();

        return nameA.Cmp( nameB );
    }
    else
    {
        return pageNumComp;
    }
}

References SCH_SHEET::ComparePageNum(), SCH_SHEET::GetName(), GetPageNumber(), and Last().

Referenced by SCH_EDITOR_CONTROL::FindNext(), HIERARCHY_TREE::OnCompareItems(), and SCH_SHEET_LIST::SortByPageNumbers().

empty()

bool SCH_SHEET_PATH::empty ( ) const

inline

Forwarded method from std::vector.

Definition at line 150 of file sch_sheet_path.h.

{ return m_sheets.empty(); }

References m_sheets.

Referenced by Last(), and PathHumanReadable().

GetCurrentHash()

size_t SCH_SHEET_PATH::GetCurrentHash ( ) const

inline

Definition at line 171 of file sch_sheet_path.h.

{ return m_current_hash; }

References m_current_hash.

Referenced by SCH_EDITOR_CONTROL::FindNext(), and operator==().

GetMultiUnitSymbols()

void SCH_SHEET_PATH::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 sheet.

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 333 of file sch_sheet_path.cpp.

{
    for( SCH_ITEM* item : LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
    {
        SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
        AppendMultiUnitSymbol( aRefList, symbol, aIncludePowerSymbols );
    }
}

References AppendMultiUnitSymbol(), LastScreen(), and SCH_SYMBOL_T.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols().

GetPageNumber()

wxString SCH_SHEET_PATH::GetPageNumber

(

)

const

Definition at line 457 of file sch_sheet_path.cpp.

{
    SCH_SHEET* sheet = Last();

    wxCHECK( sheet, wxEmptyString );

    return sheet->GetPageNumber( *this );
}

References SCH_SHEET::GetPageNumber(), and Last().

Referenced by ComparePageNumAndName(), SCH_FIELD::DoHypertextMenu(), SCH_EDIT_TOOL::EditPageNumber(), SCH_EDITOR_CONTROL::FindNext(), SCH_NAVIGATE_TOOL::HypertextCommand(), SCH_SHEET_LIST::PageNumberExists(), SCHEMATIC::ResolveTextVar(), and SCH_GLOBALLABEL::ResolveTextVar().

GetSheet()

const SCH_SHEET* SCH_SHEET_PATH::GetSheet ( unsigned  aIndex ) const

inline

Definition at line 195 of file sch_sheet_path.h.

    {
        SCH_SHEET* retv = nullptr;

        if( aIndex < size() )
            retv = at( aIndex );

        return retv;
    }

References at(), and size().

Referenced by SCH_SHEET_LIST::TestForRecursion().

GetSymbols()

void SCH_SHEET_PATH::GetSymbols	(	SCH_REFERENCE_LIST &	aReferences,
		bool	aIncludePowerSymbols = true,
		bool	aForceIncludeOrphanSymbols = false
	)		const

Adds SCH_REFERENCE object to aReferences for each symbol in the sheet.

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 301 of file sch_sheet_path.cpp.

{
    for( SCH_ITEM* item : LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
    {
        SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
        AppendSymbol( aReferences, symbol, aIncludePowerSymbols, aForceIncludeOrphanSymbols );
    }
}

References AppendSymbol(), LastScreen(), and SCH_SYMBOL_T.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDIT_FRAME::CheckAnnotate(), CollectOtherUnits(), SCH_SHEET_LIST::GetSymbols(), SCH_SHEET_LIST::GetSymbolsWithinPath(), SCH_EDITOR_CONTROL::Paste(), and SCH_EDITOR_CONTROL::updatePastedSheet().

GetVirtualPageNumber()

int SCH_SHEET_PATH::GetVirtualPageNumber ( ) const

inline

Definition at line 184 of file sch_sheet_path.h.

{ return m_virtualPageNumber; }

References m_virtualPageNumber.

initFromOther()

void SCH_SHEET_PATH::initFromOther ( const SCH_SHEET_PATH &  aOther )

private

Definition at line 118 of file sch_sheet_path.cpp.

{
    m_sheets            = aOther.m_sheets;
    m_virtualPageNumber = aOther.m_virtualPageNumber;
    m_current_hash      = aOther.m_current_hash;

    // Note: don't copy m_recursion_test_cache as it is slow and we want SCH_SHEET_PATHS to be
    // very fast to construct for use in the connectivity algorithm.
}

References m_current_hash, m_sheets, and m_virtualPageNumber.

Referenced by operator=(), and SCH_SHEET_PATH().

IsContainedWithin()

bool SCH_SHEET_PATH::IsContainedWithin

(

const SCH_SHEET_PATH &

aSheetPathToTest

)

const

Check if this path is contained inside aSheetPathToTest.

Parameters

aSheetPathToTest

is the sheet path to compare against.

Returns

true if this path is contained inside or equal to aSheetPathToTest.

Definition at line 181 of file sch_sheet_path.cpp.

{
    if( aSheetPathToTest.size() > size() )
        return false;

    for( size_t i = 0; i < aSheetPathToTest.size(); ++i )
    {
        if( at( i )->m_Uuid != aSheetPathToTest.at( i )->m_Uuid )
            return false;
    }

    return true;
}

References at(), EDA_ITEM::m_Uuid, and size().

Referenced by SCH_SHEET_LIST::GetSheetsWithinPath(), and SCH_SHEET_LIST::GetSymbolsWithinPath().

Last()

SCH_SHEET * SCH_SHEET_PATH::Last

(

)

const

Return a pointer to the last SCH_SHEET of the list.

One can see the others sheet as the "path" to reach this last sheet.

Definition at line 196 of file sch_sheet_path.cpp.

{
    if( !empty() )
        return m_sheets.back();

    return nullptr;
}

References empty(), and m_sheets.

Referenced by SCH_SHEET_LIST::AllSheetPageNumbersEmpty(), ComparePageNumAndName(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::EditPageNumber(), GetPageNumber(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), HIERARCHY_NAVIG_DLG::HIERARCHY_NAVIG_DLG(), SCH_DRAWING_TOOLS::Init(), EE_SELECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), LastScreen(), SCH_NAVIGATE_TOOL::LeaveSheet(), SCH_EDITOR_CONTROL::LeaveSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), MakeFilePathRelativeToParentSheet(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_SHEET_LIST::NameExists(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), SCH_EDITOR_CONTROL::Paste(), SCH_EDITOR_CONTROL::SaveCurrSheetCopyAs(), SCH_SHEET_LIST::SetInitialPageNumbers(), SetPageNumber(), SCH_EDIT_FRAME::setupUIConditions(), HIERARCHY_NAVIG_DLG::UpdateHierarchyTree(), and SCH_SHEET_LIST::UpdateSheetInstances().

LastScreen() [1/2]

SCH_SCREEN * SCH_SHEET_PATH::LastScreen

(

)

Returns

the SCH_SCREEN relative to the last sheet in list.

the SCH_SCREEN relative to the last sheet in list.

Definition at line 205 of file sch_sheet_path.cpp.

{
    SCH_SHEET* lastSheet = Last();

    if( lastSheet )
        return lastSheet->GetScreen();

    return nullptr;
}

References SCH_SHEET::GetScreen(), and Last().

Referenced by SCH_SHEET_LIST::AnnotatePowerSymbols(), SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::applyChangelist(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SHEET_LIST::BuildSheetList(), SCH_EDIT_FRAME::CheckSheetForRecursion(), SCH_SHEET_LIST::ClearModifyStatus(), DIALOG_PLOT_SCHEMATIC::createDXFFiles(), DIALOG_PLOT_SCHEMATIC::createHPGLFiles(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::createPSFiles(), DIALOG_PLOT_SCHEMATIC::createSVGFiles(), SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::EditPageNumber(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), SCH_SHEET_LIST::FillItemMap(), SCH_SHEET_LIST::FindAllSheetsForScreen(), NETLIST_EXPORTER_BASE::findNextSymbol(), SCH_SHEET_LIST::FindSheetForScreen(), SCH_EDIT_FRAME::FixupJunctions(), SCH_SHEET_LIST::GetItem(), GetMultiUnitSymbols(), SCH_EDIT_FRAME::GetScreen(), GetSymbols(), DIALOG_EDIT_SYMBOLS_LIBID::initDlg(), SCH_SHEET_LIST::IsModified(), MakeFilePathRelativeToParentSheet(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_PRINTOUT::OnPrintPage(), DIALOG_ERC::OnRunERCClick(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Paste(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), BACK_ANNOTATE::processNetNameChange(), DIALOG_CHANGE_SYMBOLS::processSymbol(), RESCUER::RESCUER(), SCH_EDIT_FRAME::ResolveERCExclusions(), SCHEMATIC::ResolveTextVar(), SCH_EDIT_FRAME::SetCurrentSheet(), TestForRecursion(), ERC_TESTER::TestMultiunitFootprints(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), UpdateAllScreenReferences(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

LastScreen() [2/2]

SCH_SCREEN * SCH_SHEET_PATH::LastScreen

(

)

const

Definition at line 216 of file sch_sheet_path.cpp.

{
    SCH_SHEET* lastSheet = Last();

    if( lastSheet )
        return lastSheet->GetScreen();

    return nullptr;
}

References SCH_SHEET::GetScreen(), and Last().

MakeFilePathRelativeToParentSheet()

void SCH_SHEET_PATH::MakeFilePathRelativeToParentSheet

(

)

Make the sheet file name relative to its parent sheet.

This should only be called when changing the parent sheet path such performing a save as or a new schematic without a project in stand alone mode. The sheet file name is only made relative if the current file name is relative. Absolute sheet file name paths are a user choice so do not change them.

Sheet file name paths are set according to the following criteria:

• If the sheet file name path is in the same as the parent sheet file name path, set the sheet file name to just the file name and extension with no path.
• If the sheet file name path can be made relative to the parent sheet file name path, set the sheet file name using the relative path.
• If the sheet file name path cannot be converted to a relative path, then fall back to the absolute file name path.

Definition at line 477 of file sch_sheet_path.cpp.

{
    wxCHECK( m_sheets.size() > 1, /* void */  );

    wxFileName sheetFileName = Last()->GetFileName();

    // If the sheet file name is absolute, then the user requested is so don't make it relative.
    if( sheetFileName.IsAbsolute() )
        return;

    SCH_SCREEN* screen = LastScreen();
    SCH_SCREEN* parentScreen = m_sheets[ m_sheets.size() - 2 ]->GetScreen();

    wxCHECK( screen && parentScreen, /* void */ );

    wxFileName fileName = screen->GetFileName();
    wxFileName parentFileName = parentScreen->GetFileName();

    // SCH_SCREEN file names must be absolute.  If they are not, someone set them incorrectly
    // on load or on creation.
    wxCHECK( fileName.IsAbsolute() && parentFileName.IsAbsolute(), /* void */ );

    if( fileName.GetPath() == parentFileName.GetPath() )
    {
        Last()->SetFileName( fileName.GetFullName() );
    }
    else if( fileName.MakeRelativeTo( parentFileName.GetPath() ) )
    {
        Last()->SetFileName( fileName.GetFullPath() );
    }
    else
    {
        Last()->SetFileName( screen->GetFileName() );
    }

    wxLogTrace( tracePathsAndFiles,
                wxT( "\n    File name: '%s'"
                     "\n    parent file name '%s',"
                     "\n    sheet '%s' file name '%s'." ),
                screen->GetFileName(), parentScreen->GetFileName(), PathHumanReadable(),
                Last()->GetFileName() );
}

References SCH_SCREEN::GetFileName(), SCH_SHEET::GetFileName(), Last(), LastScreen(), m_sheets, PathHumanReadable(), SCH_SHEET::SetFileName(), and tracePathsAndFiles.

operator!=()

bool SCH_SHEET_PATH::operator!= ( const SCH_SHEET_PATH &  d1 ) const

inline

Definition at line 368 of file sch_sheet_path.h.

{ return !( *this == d1 ) ; }

operator<()

bool SCH_SHEET_PATH::operator< ( const SCH_SHEET_PATH &  d1 ) const

inline

Definition at line 370 of file sch_sheet_path.h.

{ return m_sheets < d1.m_sheets; }

References m_sheets.

operator=()

SCH_SHEET_PATH & SCH_SHEET_PATH::operator=

(

const SCH_SHEET_PATH &

aOther

)

Definition at line 111 of file sch_sheet_path.cpp.

{
    initFromOther( aOther );
    return *this;
}

References initFromOther().

operator==()

bool SCH_SHEET_PATH::operator==

(

const SCH_SHEET_PATH &

d1

)

const

Definition at line 370 of file sch_sheet_path.cpp.

{
    return m_current_hash == d1.GetCurrentHash();
}

References GetCurrentHash(), and m_current_hash.

Path()

KIID_PATH SCH_SHEET_PATH::Path

(

)

const

Get the sheet path as an KIID_PATH.

Note

This KIID_PATH includes the root sheet UUID prefixed to the path.

Definition at line 242 of file sch_sheet_path.cpp.

{
    KIID_PATH path;

    for( const SCH_SHEET* sheet : m_sheets )
        path.push_back( sheet->m_Uuid );

    return path;
}

References m_sheets, and path.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), SCH_SYMBOL::ClearAnnotation(), SCH_EDIT_FRAME::CreateScreens(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_SYMBOL::GetFootprint(), SCH_SHEET::GetPageNumber(), SCH_SHEET_LIST::GetPaths(), SCH_SYMBOL::GetRef(), SCH_SYMBOL::GetUnitSelection(), SCH_SYMBOL::GetValue(), SCH_SYMBOL::IsAnnotated(), SCH_REFERENCE::IsSameInstance(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), SCH_SYMBOL::SetFootprint(), SCH_SHEET_LIST::SetInitialPageNumbers(), SCH_SHEET::SetPageNumber(), SCH_SYMBOL::SetRef(), SCH_EDIT_FRAME::SetSheetNumberAndCount(), SCH_SYMBOL::SetUnitSelection(), SCH_SYMBOL::SetValue(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), SCH_EDITOR_CONTROL::updatePastedSheet(), and SCH_SHEET_LIST::UpdateSheetInstances().

PathAsString()

wxString SCH_SHEET_PATH::PathAsString

(

)

const

Return the path of time stamps which do not changes even when editing sheet parameters.

A path is something like / (root) or /34005677 or /34005677/00AE4523.

Definition at line 227 of file sch_sheet_path.cpp.

{
    wxString s;

    s = wxT( "/" );     // This is the root path

    // Start at 1 to avoid the root sheet, which does not need to be added to the path.
    // Its timestamp changes anyway.
    for( unsigned i = 1; i < size(); i++ )
        s += at( i )->m_Uuid.AsString() + "/";

    return s;
}

References KIID::AsString(), at(), EDA_ITEM::m_Uuid, and size().

Referenced by SCH_REFERENCE::GetPath(), SCH_EAGLE_PLUGIN::loadInstance(), NETLIST_EXPORTER_XML::makeSymbols(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

PathHumanReadable()

wxString SCH_SHEET_PATH::PathHumanReadable

(

bool

aUseShortRootName = true

)

const

Return the sheet path in a human readable form made from the sheet names.

The "normal" path instead uses the KIID objects in the path that do not change even when editing sheet parameters.

Definition at line 264 of file sch_sheet_path.cpp.

{
    wxString s;
    wxString fileName;

    if( !empty() && at( 0 )->GetScreen() )
        fileName = at( 0 )->GetScreen()->GetFileName();

    wxFileName  fn = fileName;

    if( aUseShortRootName )
        s = wxT( "/" );  // Use only the short name in netlists
    else
        s = fn.GetName() + wxT( "/" );

    // Start at 1 since we've already processed the root sheet.
    for( unsigned i = 1; i < size(); i++ )
        s = s + at( i )->GetFields()[ SHEETNAME ].GetShownText() + wxT( "/" );

    return s;
}

References at(), empty(), SCH_SHEET::GetFields(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetScreen(), SHEETNAME, and size().

Referenced by SCH_EDIT_TOOL::EditPageNumber(), SCH_EDIT_FRAME::GetScreenDesc(), inheritNetclass(), MakeFilePathRelativeToParentSheet(), NETLIST_EXPORTER_XML::makeSymbols(), DIALOG_SHEET_PROPERTIES::OnUpdateUI(), SCH_CONNECTION::recacheName(), and SCHEMATIC::ResolveTextVar().

PathWithoutRootUuid()

KIID_PATH SCH_SHEET_PATH::PathWithoutRootUuid

(

)

const

Get the sheet path as an KIID_PATH without the root sheet UUID prefix.

Note

This KIID_PATH does not include the root sheet UUID prefixed to the path.

Definition at line 253 of file sch_sheet_path.cpp.

{
    KIID_PATH path;

    for( size_t i = 1; i < size(); i++ )
        path.push_back( at( i )->m_Uuid );

    return path;
}

References at(), path, and size().

Referenced by SCH_SEXPR_PLUGIN::Format(), and SCH_SHEET_LIST::UpdateSheetInstances().

pop_back()

void SCH_SHEET_PATH::pop_back ( )

inline

Forwarded method from std::vector.

Definition at line 153 of file sch_sheet_path.h.

    {
        m_sheets.pop_back();
        Rehash();
    }

References m_sheets, and Rehash().

Referenced by HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SHEET_LIST::BuildSheetList(), SCH_EDIT_TOOL::EditPageNumber(), SCH_NAVIGATE_TOOL::LeaveSheet(), SCH_EDITOR_CONTROL::LeaveSheet(), and SCH_SHEET::LocatePathOfScreen().

push_back()

void SCH_SHEET_PATH::push_back ( SCH_SHEET *  aSheet )

inline

Forwarded method from std::vector.

Definition at line 160 of file sch_sheet_path.h.

    {
        m_sheets.push_back( aSheet );
        Rehash();
    }

References m_sheets, and Rehash().

Referenced by HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SHEET_LIST::BuildSheetList(), SCH_EDIT_FRAME::CreateScreens(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::EditPageNumber(), SCH_NAVIGATE_TOOL::EnterSheet(), SCH_EDITOR_CONTROL::EnterSheet(), SCH_SEXPR_PLUGIN::Format(), HIERARCHY_NAVIG_DLG::getRootString(), HIERARCHY_NAVIG_DLG::HIERARCHY_NAVIG_DLG(), SCH_ALTIUM_PLUGIN::Load(), TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), TEST_NETLISTS_FIXTURE::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_SHEET::LocatePathOfScreen(), SCH_ALTIUM_PLUGIN::ParseSheetSymbol(), CONNECTION_GRAPH::propagateToNeighbors(), SCHEMATIC::SetRoot(), TEST_SCH_SHEET_PATH_FIXTURE::TEST_SCH_SHEET_PATH_FIXTURE(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), HIERARCHY_NAVIG_DLG::UpdateHierarchyTree(), and SCH_EDITOR_CONTROL::updatePastedSheet().

Rehash()

void SCH_SHEET_PATH::Rehash

(

)

Definition at line 129 of file sch_sheet_path.cpp.

{
    m_current_hash = 0;

    for( auto sheet : m_sheets )
        boost::hash_combine( m_current_hash, sheet->m_Uuid.Hash() );
}

References hash_combine(), m_current_hash, and m_sheets.

Referenced by clear(), pop_back(), and push_back().

SetPageNumber()

void SCH_SHEET_PATH::SetPageNumber

(

const wxString &

aPageNumber

)

Set the sheet instance user definable page number.

Note

User definable page numbers can be any string devoid of white space characters.

Definition at line 467 of file sch_sheet_path.cpp.

{
    SCH_SHEET* sheet = Last();

    wxCHECK( sheet, /* void */ );

    sheet->SetPageNumber( *this, aPageNumber );
}

References Last(), and SCH_SHEET::SetPageNumber().

Referenced by SCH_EDIT_TOOL::EditPageNumber().

SetVirtualPageNumber()

void SCH_SHEET_PATH::SetVirtualPageNumber ( int  aPageNumber )

inline

Set the sheet instance virtual page number.

Virtual page numbers are incremental integers set automatically when the sheet path hierarchy is created (

See also

SCH_SHEET_LIST::BuildSheetList). The virtual page numbering is ordered by the X and Y position of the sheet in a schematic which mimics the page numbering code prior to the addition of actual user definable page numbers. Virtual page numbers should only be use when annotating schematics.

Definition at line 182 of file sch_sheet_path.h.

{ m_virtualPageNumber = aPageNumber; }

References m_virtualPageNumber.

Referenced by SCH_SHEET_LIST::BuildSheetList(), SCH_EDIT_FRAME::SetSheetNumberAndCount(), and SCH_SHEET_LIST::SortByPageNumbers().

size()

size_t SCH_SHEET_PATH::size ( ) const

inline

Forwarded method from std::vector.

Definition at line 167 of file sch_sheet_path.h.

{ return m_sheets.size(); }

References m_sheets.

Referenced by Cmp(), SCH_EDIT_TOOL::EditPageNumber(), GetSheet(), SCH_EDIT_FRAME::GetUniqueFilenameForCurrentSheet(), IsContainedWithin(), PathAsString(), PathHumanReadable(), PathWithoutRootUuid(), CONNECTION_GRAPH::propagateToNeighbors(), TestForRecursion(), and SCH_SHEET_LIST::TestForRecursion().

TestForRecursion()

bool SCH_SHEET_PATH::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 sheet stored in file aDestFileName will cause a sheet path recursion.

Parameters

aSrcFileName	is the source file name of the 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.

Todo:

Store sheet file names with full path, either relative to project path or absolute path. The current design always assumes subsheet files are located in the project folder which may or may not be desirable.

Definition at line 376 of file sch_sheet_path.cpp.

{
    auto pair = std::make_pair( aSrcFileName, aDestFileName );

    if( m_recursion_test_cache.count( pair ) )
        return m_recursion_test_cache.at( pair );

    SCHEMATIC* sch = LastScreen()->Schematic();

    wxCHECK_MSG( sch, false, "No SCHEMATIC found in SCH_SHEET_PATH::TestForRecursion!" );

    wxFileName rootFn = sch->GetFileName();
    wxFileName srcFn = aSrcFileName;
    wxFileName destFn = aDestFileName;

    if( srcFn.IsRelative() )
        srcFn.MakeAbsolute( rootFn.GetPath() );

    if( destFn.IsRelative() )
        destFn.MakeAbsolute( rootFn.GetPath() );


    // The source and destination sheet file names cannot be the same.
    if( srcFn == destFn )
    {
        m_recursion_test_cache[pair] = true;
        return true;
    }

    unsigned i = 0;

    while( i < size() )
    {
        wxFileName cmpFn = at( i )->GetFileName();

        if( cmpFn.IsRelative() )
            cmpFn.MakeAbsolute( rootFn.GetPath() );

        // Test if the file name of the destination sheet is in anywhere in this sheet path.
        if( cmpFn == destFn )
            break;

        i++;
    }

    // The destination sheet file name was not found in the sheet path or the destination
    // sheet file name is the root sheet so no recursion is possible.
    if( i >= size() || i == 0 )
    {
        m_recursion_test_cache[pair] = false;
        return false;
    }

    // Walk back up to the root sheet to see if the source file name is already a parent in
    // the sheet path.  If so, recursion will occur.
    do
    {
        i -= 1;

        wxFileName cmpFn = at( i )->GetFileName();

        if( cmpFn.IsRelative() )
            cmpFn.MakeAbsolute( rootFn.GetPath() );

        if( cmpFn == srcFn )
        {
            m_recursion_test_cache[pair] = true;
            return true;
        }

    } while( i != 0 );

    // The source sheet file name is not a parent of the destination sheet file name.
    m_recursion_test_cache[pair] = false;
    return false;
}

References at(), SCHEMATIC::GetFileName(), SCH_SHEET::GetFileName(), LastScreen(), m_recursion_test_cache, SCH_SCREEN::Schematic(), and size().

Referenced by SCH_SHEET_LIST::BuildSheetList().

UpdateAllScreenReferences()

void SCH_SHEET_PATH::UpdateAllScreenReferences

(

)

Update all the symbol references for this sheet path.

Mandatory in complex hierarchies because sheets may use the same screen (basic schematic) more than once but with different references and units according to the displayed sheet.

Definition at line 287 of file sch_sheet_path.cpp.

{
    for( SCH_ITEM* item : LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
    {
        SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
        symbol->GetField( REFERENCE_FIELD )->SetText( symbol->GetRef( this ) );
        symbol->GetField( VALUE_FIELD )->SetText( symbol->GetValue( this, false ) );
        symbol->GetField( FOOTPRINT_FIELD )->SetText( symbol->GetFootprint( this, false ) );
        symbol->UpdateUnit( symbol->GetUnitSelection( this ) );
    }
}

References FOOTPRINT_FIELD, SCH_SYMBOL::GetField(), SCH_SYMBOL::GetFootprint(), SCH_SYMBOL::GetRef(), SCH_SYMBOL::GetUnitSelection(), SCH_SYMBOL::GetValue(), LastScreen(), REFERENCE_FIELD, SCH_SYMBOL_T, EDA_TEXT::SetText(), SCH_SYMBOL::UpdateUnit(), and VALUE_FIELD.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), DIALOG_PLOT_SCHEMATIC::createDXFFiles(), DIALOG_PLOT_SCHEMATIC::createHPGLFiles(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::createPSFiles(), DIALOG_PLOT_SCHEMATIC::createSVGFiles(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_EDITOR_CONTROL::FindNext(), SCH_EDIT_FRAME::FixupJunctions(), DIALOG_MIGRATE_BUSES::onItemSelected(), SCH_PRINTOUT::OnPrintPage(), DIALOG_UPDATE_FROM_PCB::OnUpdateClick(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::Paste(), DIALOG_CHANGE_SYMBOLS::processMatchingSymbols(), SCH_EDITOR_CONTROL::ReplaceAll(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and DIALOG_PLOT_SCHEMATIC::restoreEnvironment().

Member Data Documentation

m_current_hash

size_t SCH_SHEET_PATH::m_current_hash

protected

Definition at line 378 of file sch_sheet_path.h.

Referenced by GetCurrentHash(), initFromOther(), operator==(), Rehash(), and SCH_SHEET_PATH().

m_recursion_test_cache

std::map<std::pair<wxString, wxString>, bool> SCH_SHEET_PATH::m_recursion_test_cache

protected

Page numbers are maintained by the sheet load order.

Definition at line 382 of file sch_sheet_path.h.

Referenced by TestForRecursion().

m_sheets

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

protected

Definition at line 376 of file sch_sheet_path.h.

Referenced by at(), clear(), empty(), initFromOther(), Last(), MakeFilePathRelativeToParentSheet(), operator<(), Path(), pop_back(), push_back(), Rehash(), and size().

m_virtualPageNumber

int SCH_SHEET_PATH::m_virtualPageNumber

protected

Definition at line 380 of file sch_sheet_path.h.

Referenced by AppendMultiUnitSymbol(), AppendSymbol(), GetVirtualPageNumber(), initFromOther(), SCH_SHEET_PATH(), and SetVirtualPageNumber().

---

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

• sch_sheet_path.h
• sch_sheet_path.cpp