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 *	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...
SCH_SHEET *	Last () const
	Return a pointer to the last SCH_SHEET of the list. More...
SCH_SCREEN *	LastScreen ()
SCH_SCREEN *	LastScreen () const
	More...
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 thesheet names. More...
void	UpdateAllScreenReferences ()
	Update all the symbol references for this sheet path. More...
void	GetSymbols (SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanComponents=false) const
	Adds SCH_REFERENCE object to aReferences for each component in the sheet. More...
void	GetMultiUnitComponents (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...
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 130 of file sch_sheet_path.h.

Constructor & Destructor Documentation

SCH_SHEET_PATH() [1/2]

SCH_SHEET_PATH::SCH_SHEET_PATH

(

)

Definition at line 97 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 104 of file sch_sheet_path.cpp.

{
    initFromOther( aOther );
}

References initFromOther().

Member Function Documentation

at()

SCH_SHEET* SCH_SHEET_PATH::at ( size_t  aIndex ) const

inline

Forwarded method from std::vector.

Definition at line 149 of file sch_sheet_path.h.

{ return m_sheets.at( aIndex ); }

References m_sheets.

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

clear()

void SCH_SHEET_PATH::clear ( )

inline

Forwarded method from std::vector.

Definition at line 152 of file sch_sheet_path.h.

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

References m_sheets, and Rehash().

Referenced by SCH_EDIT_FRAME::doCloseWindow(), 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

= 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 137 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().

empty()

bool SCH_SHEET_PATH::empty ( ) const

inline

Forwarded method from std::vector.

Definition at line 159 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 180 of file sch_sheet_path.h.

{ return m_current_hash; }

References m_current_hash.

Referenced by std::hash< SCH_SHEET_PATH >::operator()(), and operator==().

GetMultiUnitComponents()

void SCH_SHEET_PATH::GetMultiUnitComponents	(	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	: false to only get normal components.

Definition at line 289 of file sch_sheet_path.cpp.

{
    for( auto item : LastScreen()->Items().OfType( SCH_COMPONENT_T ) )
    {
        auto component = static_cast<SCH_COMPONENT*>( item );

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

        LIB_PART* part = component->GetPartRef().get();

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

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

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

References SCH_REFERENCE::GetRef(), LIB_PART::GetUnitCount(), LastScreen(), m_virtualPageNumber, SCH_COMPONENT_T, and SCH_REFERENCE::SetSheetNumber().

Referenced by SCH_EDIT_FRAME::AnnotateComponents().

GetPageNumber()

wxString SCH_SHEET_PATH::GetPageNumber

(

)

const

Definition at line 406 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 SCH_EDIT_TOOL::EditPageNumber(), SCH_NAVIGATE_TOOL::HypertextCommand(), and SCH_SHEET_LIST::SortByPageNumbers().

GetSheet()

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

inline

Definition at line 204 of file sch_sheet_path.h.

    {
        SCH_SHEET* retv = NULL;

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

        return const_cast< SCH_SHEET* >( retv );
    }

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

Referenced by SCH_SHEET_LIST::TestForRecursion().

GetSymbols()

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

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

Parameters

aReferences	List of references to populate.
aIncludePowerSymbols	: false to only get normal components.
aForceIncludeOrphanComponents	: true to include components having no symbol found in lib. ( orphan components) The normal option is false, and set to true only to build the full list of components.

Definition at line 264 of file sch_sheet_path.cpp.

{
    for( SCH_ITEM* item : LastScreen()->Items().OfType( SCH_COMPONENT_T ) )
    {
        SCH_COMPONENT* component = static_cast<SCH_COMPONENT*>( item );

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

            if( part || aForceIncludeOrphanComponents )
            {
                SCH_REFERENCE schReference( component, part, *this );

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

References SCH_REFERENCE_LIST::AddItem(), SCH_COMPONENT::GetPartRef(), SCH_COMPONENT::GetRef(), LastScreen(), m_virtualPageNumber, SCH_COMPONENT_T, and SCH_REFERENCE::SetSheetNumber().

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDIT_FRAME::CheckAnnotate(), CollectOtherUnits(), and SCH_SHEET_LIST::GetSymbols().

GetVirtualPageNumber()

int SCH_SHEET_PATH::GetVirtualPageNumber ( ) const

inline

Definition at line 193 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 117 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().

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 159 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(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_EDIT_TOOL::Duplicate(), 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(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_SHEET_LIST::NameExists(), HIERARCHY_TREE::OnCompareItems(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), SCH_EDITOR_CONTROL::Paste(), SCH_EDIT_FRAME::SaveEEFile(), 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.

Definition at line 168 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 LIB_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AnnotateComponents(), SCH_SHEET_LIST::AnnotatePowerSymbols(), BACK_ANNOTATE::applyChangelist(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SHEET_LIST::BuildSheetList(), SCH_EDIT_FRAME::CheckSheetForRecursion(), SCH_SHEET_LIST::ClearModifyStatus(), DIALOG_PLOT_SCHEMATIC::CreateDXFFile(), DIALOG_PLOT_SCHEMATIC::createHPGLFile(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::createPSFile(), DIALOG_PLOT_SCHEMATIC::createSVGFile(), SCH_EDIT_FRAME::DisplayCurrentSheet(), SCH_EDIT_TOOL::EditPageNumber(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), SCH_SHEET_LIST::FillItemMap(), SCH_SHEET_LIST::FindSheetForScreen(), SCH_EDIT_FRAME::FixupJunctions(), SCH_SHEET_LIST::GetItem(), GetMultiUnitComponents(), SCH_EDIT_FRAME::GetScreen(), GetSymbols(), DIALOG_EDIT_COMPONENTS_LIBID::initDlg(), SCH_SHEET_LIST::IsModified(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), BACK_ANNOTATE::processNetNameChange(), DIALOG_CHANGE_SYMBOLS::processSymbol(), RESCUER::RESCUER(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_EDIT_FRAME::ResolveERCExclusions(), SCH_EDIT_FRAME::SetCurrentSheet(), TestForRecursion(), ERC_TESTER::TestMultiunitFootprints(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSimilarLabels(), UpdateAllScreenReferences(), CONNECTION_GRAPH::updateItemConnectivity(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

LastScreen() [2/2]

SCH_SCREEN * SCH_SHEET_PATH::LastScreen

(

)

const

Returns

the SCH_SCREEN relative to the last sheet in list.

Definition at line 179 of file sch_sheet_path.cpp.

{
    SCH_SHEET* lastSheet = Last();

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

    return nullptr;
}

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

operator!=()

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

inline

Definition at line 317 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 319 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 110 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 319 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.

Returns

Definition at line 205 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.

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), SCH_COMPONENT::ClearAnnotation(), SCH_EDITOR_CONTROL::doCopy(), SCH_COMPONENT::GetFootprint(), SCH_SHEET::GetPageNumber(), SCH_SHEET_LIST::GetPaths(), SCH_COMPONENT::GetRef(), SCH_COMPONENT::GetUnitSelection(), SCH_COMPONENT::GetValue(), SCH_COMPONENT::IsAnnotated(), SCH_REFERENCE::IsSameInstance(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_COMPONENT::SetFootprint(), SCH_SHEET_LIST::SetInitialPageNumbers(), SCH_SHEET::SetPageNumber(), SCH_COMPONENT::SetRef(), SCH_EDIT_FRAME::SetSheetNumberAndCount(), SCH_COMPONENT::SetUnitSelection(), SCH_COMPONENT::SetValue(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), 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 190 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.
    // It's 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(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), 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 thesheet names.

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

Definition at line 227 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_SHEET::GetMsgPanelInfo(), SCH_EDIT_FRAME::GetScreenDesc(), inheritNetclass(), NETLIST_EXPORTER_XML::makeSymbols(), DIALOG_SHEET_PROPERTIES::OnUpdateUI(), SCH_CONNECTION::recacheName(), and SCH_EDIT_FRAME::UpdateTitle().

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.

Returns

Definition at line 216 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(), and size().

Referenced by SCH_SHEET_LIST::UpdateSheetInstances().

pop_back()

void SCH_SHEET_PATH::pop_back ( )

inline

Forwarded method from std::vector.

Definition at line 162 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(), SCH_SHEET::LocatePathOfScreen(), and CONNECTION_GRAPH::propagateToNeighbors().

push_back()

void SCH_SHEET_PATH::push_back ( SCH_SHEET *  aSheet )

inline

Forwarded method from std::vector.

Definition at line 169 of file sch_sheet_path.h.

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

References m_sheets, and Rehash().

Referenced by CONNECTION_GRAPH::buildConnectionGraph(), HIERARCHY_NAVIG_DLG::buildHierarchyTree(), SCH_SHEET_LIST::BuildSheetList(), SCH_EDIT_TOOL::EditPageNumber(), SCH_NAVIGATE_TOOL::EnterSheet(), SCH_EDITOR_CONTROL::EnterSheet(), SCH_COMPONENT::GetMsgPanelInfo(), SCH_SHEET::GetMsgPanelInfo(), HIERARCHY_NAVIG_DLG::getRootString(), HIERARCHY_NAVIG_DLG::HIERARCHY_NAVIG_DLG(), TEST_NETLISTS_FIXTURE::loadSchematic(), TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SCH_SHEET::LocatePathOfScreen(), SCH_EDITOR_CONTROL::Paste(), 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::updatePastedInstances().

Rehash()

void SCH_SHEET_PATH::Rehash

(

)

Definition at line 128 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 416 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 191 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 176 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(), 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 325 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 250 of file sch_sheet_path.cpp.

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

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

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), DIALOG_PLOT_SCHEMATIC::CreateDXFFile(), DIALOG_PLOT_SCHEMATIC::createHPGLFile(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::createPSFile(), DIALOG_PLOT_SCHEMATIC::createSVGFile(), 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(), DIALOG_CHANGE_SYMBOLS::processMatchingSymbols(), ReannotateFromPCBNew(), and DIALOG_PLOT_SCHEMATIC::restoreEnvironment().

Member Data Documentation

m_current_hash

size_t SCH_SHEET_PATH::m_current_hash

protected

Definition at line 135 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 139 of file sch_sheet_path.h.

Referenced by TestForRecursion().

m_sheets

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

protected

Definition at line 133 of file sch_sheet_path.h.

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

m_virtualPageNumber

int SCH_SHEET_PATH::m_virtualPageNumber

protected

Definition at line 137 of file sch_sheet_path.h.

Referenced by GetMultiUnitComponents(), GetSymbols(), 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