KiCad PCB EDA Suite
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_PATHoperator= (const SCH_SHEET_PATH &aOther)
 
 ~SCH_SHEET_PATH ()=default
 
SCH_SHEETat (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_SHEETGetSheet (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_SHEETLast () const
 Return a pointer to the last SCH_SHEET of the list. More...
 
SCH_SCREENLastScreen ()
 
SCH_SCREENLastScreen () 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.

99 {
101  m_current_hash = 0;
102 }

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.

106 {
107  initFromOther( aOther );
108 }
void initFromOther(const SCH_SHEET_PATH &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
aRefListMap of reference designators to reference lists
aSymbolA symbol to add to aRefList
aIncludePowerSymbolsSet to false to only get normal symbols.

Definition at line 344 of file sch_sheet_path.cpp.

347 {
348  // Skip pseudo-symbols, which have a reference starting with #. This mainly
349  // affects power symbols.
350  if( !aIncludePowerSymbols && aSymbol->GetRef( this )[0] == wxT( '#' ) )
351  return;
352 
353  LIB_SYMBOL* symbol = aSymbol->GetLibSymbolRef().get();
354 
355  if( symbol && symbol->GetUnitCount() > 1 )
356  {
357  SCH_REFERENCE schReference = SCH_REFERENCE( aSymbol, symbol, *this );
358  schReference.SetSheetNumber( m_virtualPageNumber );
359  wxString reference_str = schReference.GetRef();
360 
361  // Never lock unassigned references
362  if( reference_str[reference_str.Len() - 1] == '?' )
363  return;
364 
365  aRefList[reference_str].AddItem( schReference );
366  }
367 }
void SetSheetNumber(int aSheetNumber)
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:441
Define a library symbol object.
Definition: lib_symbol.h:96
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
Definition: sch_symbol.h:164
wxString GetRef() const
int GetUnitCount() const override
For items with units, return the number of units.
A helper to define a symbol's reference designator in a schematic.

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
aReferencesList of references to populate.
aSymbolA symbol to add to aReferences
aIncludePowerSymbolsset to false to only get normal symbols.
aForceIncludeOrphanSymbolsset 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.

315 {
316  // Skip pseudo-symbols, which have a reference starting with #. This mainly
317  // affects power symbols.
318  if( aIncludePowerSymbols || aSymbol->GetRef( this )[0] != wxT( '#' ) )
319  {
320  LIB_SYMBOL* symbol = aSymbol->GetLibSymbolRef().get();
321 
322  if( symbol || aForceIncludeOrphanSymbols )
323  {
324  SCH_REFERENCE schReference( aSymbol, symbol, *this );
325 
326  schReference.SetSheetNumber( m_virtualPageNumber );
327  aReferences.AddItem( schReference );
328  }
329  }
330 }
void AddItem(const SCH_REFERENCE &aItem)
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:441
Define a library symbol object.
Definition: lib_symbol.h:96
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
Definition: sch_symbol.h:164
A helper to define a symbol's reference designator in a schematic.

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.

140 { return m_sheets.at( aIndex ); }
std::vector< SCH_SHEET * > m_sheets

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.

144  {
145  m_sheets.clear();
146  Rehash();
147  }
std::vector< SCH_SHEET * > m_sheets

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

139 {
140  if( size() > aSheetPathToTest.size() )
141  return 1;
142 
143  if( size() < aSheetPathToTest.size() )
144  return -1;
145 
146  //otherwise, same number of sheets.
147  for( unsigned i = 0; i < size(); i++ )
148  {
149  if( at( i )->m_Uuid < aSheetPathToTest.at( i )->m_Uuid )
150  return -1;
151 
152  if( at( i )->m_Uuid != aSheetPathToTest.at( i )->m_Uuid )
153  return 1;
154  }
155 
156  return 0;
157 }
size_t size() const
Forwarded method from std::vector.
const KIID m_Uuid
Definition: eda_item.h:475
SCH_SHEET * at(size_t aIndex) const
Forwarded method from std::vector.

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.

161 {
162  wxString pageA = GetPageNumber();
163  wxString pageB = aSheetPathToTest.GetPageNumber();
164 
165  int pageNumComp = SCH_SHEET::ComparePageNum( pageA, pageB );
166 
167  if( pageNumComp == 0 )
168  {
169  wxString nameA = Last()->GetName();
170  wxString nameB = aSheetPathToTest.Last()->GetName();
171 
172  return nameA.Cmp( nameB );
173  }
174  else
175  {
176  return pageNumComp;
177  }
178 }
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
static int ComparePageNum(const wxString &aPageNumberA, const wxString &aPageNumberB)
Compares page numbers of schematic sheets.
Definition: sch_sheet.cpp:1145
wxString GetName() const
Definition: sch_sheet.h:101
wxString GetPageNumber() const

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.

150 { return m_sheets.empty(); }
std::vector< SCH_SHEET * > m_sheets

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.

171 { 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
aRefListMap of reference designators to reference lists
aIncludePowerSymbolsSet to false to only get normal symbols.

Definition at line 333 of file sch_sheet_path.cpp.

335 {
336  for( SCH_ITEM* item : LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
337  {
338  SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
339  AppendMultiUnitSymbol( aRefList, symbol, aIncludePowerSymbols );
340  }
341 }
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-...
Schematic symbol object.
Definition: sch_symbol.h:78
SCH_SCREEN * LastScreen()
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182

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.

458 {
459  SCH_SHEET* sheet = Last();
460 
461  wxCHECK( sheet, wxEmptyString );
462 
463  return sheet->GetPageNumber( *this );
464 }
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54
wxString GetPageNumber(const SCH_SHEET_PATH &aInstance) const
Return the sheet page number for aInstance.
Definition: sch_sheet.cpp:1112

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.

196  {
197  SCH_SHEET* retv = nullptr;
198 
199  if( aIndex < size() )
200  retv = at( aIndex );
201 
202  return retv;
203  }
size_t size() const
Forwarded method from std::vector.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54
SCH_SHEET * at(size_t aIndex) const
Forwarded method from std::vector.

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
aReferencesList of references to populate.
aIncludePowerSymbolsset to false to only get normal symbols.
aForceIncludeOrphanSymbolsset 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.

303 {
304  for( SCH_ITEM* item : LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
305  {
306  SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
307  AppendSymbol( aReferences, symbol, aIncludePowerSymbols, aForceIncludeOrphanSymbols );
308  }
309 }
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.
Schematic symbol object.
Definition: sch_symbol.h:78
SCH_SCREEN * LastScreen()
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182

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.

184 { 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.

119 {
120  m_sheets = aOther.m_sheets;
123 
124  // Note: don't copy m_recursion_test_cache as it is slow and we want SCH_SHEET_PATHS to be
125  // very fast to construct for use in the connectivity algorithm.
126 }
std::vector< SCH_SHEET * > m_sheets

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

182 {
183  if( aSheetPathToTest.size() > size() )
184  return false;
185 
186  for( size_t i = 0; i < aSheetPathToTest.size(); ++i )
187  {
188  if( at( i )->m_Uuid != aSheetPathToTest.at( i )->m_Uuid )
189  return false;
190  }
191 
192  return true;
193 }
size_t size() const
Forwarded method from std::vector.
const KIID m_Uuid
Definition: eda_item.h:475
SCH_SHEET * at(size_t aIndex) const
Forwarded method from std::vector.

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

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

◆ Last()

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

206 {
207  SCH_SHEET* lastSheet = Last();
208 
209  if( lastSheet )
210  return lastSheet->GetScreen();
211 
212  return nullptr;
213 }
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
SCH_SCREEN * GetScreen() const
Definition: sch_sheet.h:103
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54

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.

217 {
218  SCH_SHEET* lastSheet = Last();
219 
220  if( lastSheet )
221  return lastSheet->GetScreen();
222 
223  return nullptr;
224 }
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
SCH_SCREEN * GetScreen() const
Definition: sch_sheet.h:103
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54

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.

478 {
479  wxCHECK( m_sheets.size() > 1, /* void */ );
480 
481  wxFileName sheetFileName = Last()->GetFileName();
482 
483  // If the sheet file name is absolute, then the user requested is so don't make it relative.
484  if( sheetFileName.IsAbsolute() )
485  return;
486 
487  SCH_SCREEN* screen = LastScreen();
488  SCH_SCREEN* parentScreen = m_sheets[ m_sheets.size() - 2 ]->GetScreen();
489 
490  wxCHECK( screen && parentScreen, /* void */ );
491 
492  wxFileName fileName = screen->GetFileName();
493  wxFileName parentFileName = parentScreen->GetFileName();
494 
495  // SCH_SCREEN file names must be absolute. If they are not, someone set them incorrectly
496  // on load or on creation.
497  wxCHECK( fileName.IsAbsolute() && parentFileName.IsAbsolute(), /* void */ );
498 
499  if( fileName.GetPath() == parentFileName.GetPath() )
500  {
501  Last()->SetFileName( fileName.GetFullName() );
502  }
503  else if( fileName.MakeRelativeTo( parentFileName.GetPath() ) )
504  {
505  Last()->SetFileName( fileName.GetFullPath() );
506  }
507  else
508  {
509  Last()->SetFileName( screen->GetFileName() );
510  }
511 
512  wxLogTrace( tracePathsAndFiles,
513  wxT( "\n File name: '%s'"
514  "\n parent file name '%s',"
515  "\n sheet '%s' file name '%s'." ),
516  screen->GetFileName(), parentScreen->GetFileName(), PathHumanReadable(),
517  Last()->GetFileName() );
518 }
const wxString & GetFileName() const
Definition: sch_screen.h:145
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
void SetFileName(const wxString &aFilename)
Definition: sch_sheet.h:321
wxString PathHumanReadable(bool aUseShortRootName=true) const
Return the sheet path in a human readable form made from the sheet names.
const wxChar *const tracePathsAndFiles
Flag to enable path and file name debug output.
std::vector< SCH_SHEET * > m_sheets
wxString GetFileName() const
Return the filename corresponding to this sheet.
Definition: sch_sheet.h:315
SCH_SCREEN * LastScreen()

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.

368 { 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.

370 { return m_sheets < d1.m_sheets; }
std::vector< SCH_SHEET * > 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.

112 {
113  initFromOther( aOther );
114  return *this;
115 }
void initFromOther(const SCH_SHEET_PATH &aOther)

References initFromOther().

◆ operator==()

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

Definition at line 370 of file sch_sheet_path.cpp.

371 {
372  return m_current_hash == d1.GetCurrentHash();
373 }
size_t GetCurrentHash() const

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.

243 {
244  KIID_PATH path;
245 
246  for( const SCH_SHEET* sheet : m_sheets )
247  path.push_back( sheet->m_Uuid );
248 
249  return path;
250 }
std::vector< SCH_SHEET * > m_sheets
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54

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.

228 {
229  wxString s;
230 
231  s = wxT( "/" ); // This is the root path
232 
233  // Start at 1 to avoid the root sheet, which does not need to be added to the path.
234  // Its timestamp changes anyway.
235  for( unsigned i = 1; i < size(); i++ )
236  s += at( i )->m_Uuid.AsString() + "/";
237 
238  return s;
239 }
wxString AsString() const
Definition: kiid.cpp:218
size_t size() const
Forwarded method from std::vector.
const KIID m_Uuid
Definition: eda_item.h:475
SCH_SHEET * at(size_t aIndex) const
Forwarded method from std::vector.

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.

265 {
266  wxString s;
267  wxString fileName;
268 
269  if( !empty() && at( 0 )->GetScreen() )
270  fileName = at( 0 )->GetScreen()->GetFileName();
271 
272  wxFileName fn = fileName;
273 
274  if( aUseShortRootName )
275  s = wxT( "/" ); // Use only the short name in netlists
276  else
277  s = fn.GetName() + wxT( "/" );
278 
279  // Start at 1 since we've already processed the root sheet.
280  for( unsigned i = 1; i < size(); i++ )
281  s = s + at( i )->GetFields()[ SHEETNAME ].GetShownText() + wxT( "/" );
282 
283  return s;
284 }
const wxString & GetFileName() const
Definition: sch_screen.h:145
SCH_SCREEN * GetScreen() const
Definition: sch_sheet.h:103
std::vector< SCH_FIELD > & GetFields()
Definition: sch_sheet.h:88
size_t size() const
Forwarded method from std::vector.
SCH_SHEET * at(size_t aIndex) const
Forwarded method from std::vector.
bool empty() const
Forwarded method from std::vector.

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.

254 {
255  KIID_PATH path;
256 
257  for( size_t i = 1; i < size(); i++ )
258  path.push_back( at( i )->m_Uuid );
259 
260  return path;
261 }
size_t size() const
Forwarded method from std::vector.
SCH_SHEET * at(size_t aIndex) const
Forwarded method from std::vector.

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.

154  {
155  m_sheets.pop_back();
156  Rehash();
157  }
std::vector< SCH_SHEET * > m_sheets

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()

◆ Rehash()

void SCH_SHEET_PATH::Rehash ( )

Definition at line 129 of file sch_sheet_path.cpp.

130 {
131  m_current_hash = 0;
132 
133  for( auto sheet : m_sheets )
134  boost::hash_combine( m_current_hash, sheet->m_Uuid.Hash() );
135 }
static void hash_combine(std::size_t &seed)
This is a dummy function to take the final case of hash_combine below.
Definition: hash_eda.h:67
std::vector< SCH_SHEET * > m_sheets

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.

468 {
469  SCH_SHEET* sheet = Last();
470 
471  wxCHECK( sheet, /* void */ );
472 
473  sheet->SetPageNumber( *this, aPageNumber );
474 }
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
void SetPageNumber(const SCH_SHEET_PATH &aInstance, const wxString &aPageNumber)
Set the page number for the sheet instance aInstance.
Definition: sch_sheet.cpp:1130
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:54

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.

182 { 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

◆ 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
aSrcFileNameis the source file name of the sheet add to aDestFileName.
aDestFileNameis 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.

377 {
378  auto pair = std::make_pair( aSrcFileName, aDestFileName );
379 
380  if( m_recursion_test_cache.count( pair ) )
381  return m_recursion_test_cache.at( pair );
382 
383  SCHEMATIC* sch = LastScreen()->Schematic();
384 
385  wxCHECK_MSG( sch, false, "No SCHEMATIC found in SCH_SHEET_PATH::TestForRecursion!" );
386 
387  wxFileName rootFn = sch->GetFileName();
388  wxFileName srcFn = aSrcFileName;
389  wxFileName destFn = aDestFileName;
390 
391  if( srcFn.IsRelative() )
392  srcFn.MakeAbsolute( rootFn.GetPath() );
393 
394  if( destFn.IsRelative() )
395  destFn.MakeAbsolute( rootFn.GetPath() );
396 
397 
398  // The source and destination sheet file names cannot be the same.
399  if( srcFn == destFn )
400  {
401  m_recursion_test_cache[pair] = true;
402  return true;
403  }
404 
408  unsigned i = 0;
409 
410  while( i < size() )
411  {
412  wxFileName cmpFn = at( i )->GetFileName();
413 
414  if( cmpFn.IsRelative() )
415  cmpFn.MakeAbsolute( rootFn.GetPath() );
416 
417  // Test if the file name of the destination sheet is in anywhere in this sheet path.
418  if( cmpFn == destFn )
419  break;
420 
421  i++;
422  }
423 
424  // The destination sheet file name was not found in the sheet path or the destination
425  // sheet file name is the root sheet so no recursion is possible.
426  if( i >= size() || i == 0 )
427  {
428  m_recursion_test_cache[pair] = false;
429  return false;
430  }
431 
432  // Walk back up to the root sheet to see if the source file name is already a parent in
433  // the sheet path. If so, recursion will occur.
434  do
435  {
436  i -= 1;
437 
438  wxFileName cmpFn = at( i )->GetFileName();
439 
440  if( cmpFn.IsRelative() )
441  cmpFn.MakeAbsolute( rootFn.GetPath() );
442 
443  if( cmpFn == srcFn )
444  {
445  m_recursion_test_cache[pair] = true;
446  return true;
447  }
448 
449  } while( i != 0 );
450 
451  // The source sheet file name is not a parent of the destination sheet file name.
452  m_recursion_test_cache[pair] = false;
453  return false;
454 }
Holds all the data relating to one schematic.
Definition: schematic.h:59
std::map< std::pair< wxString, wxString >, bool > m_recursion_test_cache
Page numbers are maintained by the sheet load order.
size_t size() const
Forwarded method from std::vector.
wxString GetFileName() const override
Helper to retrieve the filename from the root sheet screen.
Definition: schematic.cpp:161
wxString GetFileName() const
Return the filename corresponding to this sheet.
Definition: sch_sheet.h:315
SCH_SCREEN * LastScreen()
SCHEMATIC * Schematic() const
Definition: sch_screen.cpp:92
SCH_SHEET * at(size_t aIndex) const
Forwarded method from std::vector.

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.

288 {
289  for( SCH_ITEM* item : LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
290  {
291  SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
292  symbol->GetField( REFERENCE_FIELD )->SetText( symbol->GetRef( this ) );
293  symbol->GetField( VALUE_FIELD )->SetText( symbol->GetValue( this, false ) );
294  symbol->GetField( FOOTPRINT_FIELD )->SetText( symbol->GetFootprint( this, false ) );
295  symbol->UpdateUnit( symbol->GetUnitSelection( this ) );
296  }
297 }
Field Reference of part, i.e. "IC21".
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
Definition: sch_symbol.cpp:675
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:441
void UpdateUnit(int aUnit)
Change the unit number to aUnit without setting any internal flags.
Definition: sch_symbol.cpp:341
Field Value of part, i.e. "3.3K".
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:114
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
Return the instance-specific unit selection for the given sheet path.
Definition: sch_symbol.cpp:531
const wxString GetValue(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific value for the given sheet path.
Definition: sch_symbol.cpp:573
Schematic symbol object.
Definition: sch_symbol.h:78
SCH_SCREEN * LastScreen()
const wxString GetFootprint(const SCH_SHEET_PATH *sheet, bool aResolve) const
Return the instance-specific footprint assignment for the given sheet path.
Definition: sch_symbol.cpp:624
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:182
Field Name Module PCB, i.e. "16DIP300".

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

◆ m_virtualPageNumber

int SCH_SHEET_PATH::m_virtualPageNumber
protected

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