KiCad PCB EDA Suite
sch_sheet_path.h File Reference

Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema. More...

#include <map>
#include <optional>
#include <kiid.h>
#include <wx/string.h>

Go to the source code of this file.

Classes

struct  SCH_SYMBOL_INSTANCE
 A simple container for schematic symbol instance information. More...
 
struct  SCH_SHEET_INSTANCE
 A simple container for sheet instance information. More...
 
class  SCH_SHEET_PATH
 Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened schematic hierarchy. More...
 
struct  std::hash< SCH_SHEET_PATH >
 
struct  SHEET_PATH_HASH
 
struct  SHEET_PATH_CMP
 
class  SCH_SHEET_LIST
 A container for handling SCH_SHEET_PATH objects in a flattened hierarchy. More...
 

Namespaces

namespace  std
 

Typedefs

typedef std::map< wxString, SCH_REFERENCE_LISTSCH_MULTI_UNIT_REFERENCE_MAP
 Container to map reference designators for multi-unit parts. More...
 
typedef std::vector< SCH_SHEET_PATHSCH_SHEET_PATHS
 
typedef SCH_SHEET_PATHS::iterator SCH_SHEET_PATHS_ITER
 

Functions

bool SortSymbolInstancesByProjectUuid (const SCH_SYMBOL_INSTANCE &aLhs, const SCH_SYMBOL_INSTANCE &aRhs)
 

Detailed Description

Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.

Definition in file sch_sheet_path.h.

Typedef Documentation

◆ SCH_MULTI_UNIT_REFERENCE_MAP

typedef std::map<wxString, SCH_REFERENCE_LIST> SCH_MULTI_UNIT_REFERENCE_MAP

Container to map reference designators for multi-unit parts.

Definition at line 129 of file sch_sheet_path.h.

◆ SCH_SHEET_PATHS

typedef std::vector< SCH_SHEET_PATH > SCH_SHEET_PATHS

Definition at line 448 of file sch_sheet_path.h.

◆ SCH_SHEET_PATHS_ITER

typedef SCH_SHEET_PATHS::iterator SCH_SHEET_PATHS_ITER

Definition at line 449 of file sch_sheet_path.h.

Function Documentation

◆ SortSymbolInstancesByProjectUuid()

bool SortSymbolInstancesByProjectUuid ( const SCH_SYMBOL_INSTANCE aLhs,
const SCH_SYMBOL_INSTANCE aRhs 
)

Definition at line 89 of file sch_sheet_path.cpp.

91{
92 wxCHECK( !aLhs.m_Path.empty() && !aRhs.m_Path.empty(), false );
93
94 return aLhs.m_Path[0] < aRhs.m_Path[0];
95}

References SCH_SYMBOL_INSTANCE::m_Path.

Referenced by SCH_SEXPR_PLUGIN::saveSymbol().