KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
SCH_CONNECTIVITY::NAVIGATION_QUERY Class Reference

One UI operation's hierarchy index. More...

#include <conn_navigation.h>

Public Member Functions

 NAVIGATION_QUERY (const SCHEMATIC &aSchematic)
 
std::vector< wxString > NetNames () const
 
std::vector< wxString > SignalNames (const wxString &aName) const
 
bool HasNet (const wxString &aName) const
 
std::set< KIID_PATH > NetSheets (const wxString &aName) const
 
NET_ITEMS_BY_SHEET NetItems (const wxString &aName, bool aIncludeBusParents, bool aIncludeBusMembers=false) const
 
void CollectNetItems (const wxString &aName, const SCH_SHEET_PATH &aSheet, std::unordered_set< SCH_ITEM * > &aItems, bool aIncludeBusParents=false, bool aIncludeBusMembers=false) const
 
std::vector< SCH_ITEM * > WholeNetItems (const std::vector< SCH_ITEM * > &aSeeds, const SCH_SHEET_PATH &aSheet) const
 

Private Types

using PATH_INDEX = std::map<KIID_PATH, SCH_SHEET_PATH>
 

Private Member Functions

std::set< const CONNECTION_SUBGRAPH * > netSubgraphs (const wxString &aName, bool aIncludeBusParents, bool aIncludeBusMembers) const
 
NET_ITEMS_BY_SHEET netItemsByEngine (const wxString &aName, bool aIncludeBusParents, bool aIncludeBusMembers) const
 
const PATH_INDEX & paths () const
 

Private Attributes

const SCHEMATIC & m_schematic
 
std::optional< PATH_INDEX > m_paths
 

Detailed Description

One UI operation's hierarchy index.

Recreate after the schematic changes. Returned item pointers are borrowed for immediate use.

Definition at line 41 of file conn_navigation.h.

Member Typedef Documentation

◆ PATH_INDEX

using SCH_CONNECTIVITY::NAVIGATION_QUERY::PATH_INDEX = std::map<KIID_PATH, SCH_SHEET_PATH>
private

Definition at line 66 of file conn_navigation.h.

Constructor & Destructor Documentation

◆ NAVIGATION_QUERY()

SCH_CONNECTIVITY::NAVIGATION_QUERY::NAVIGATION_QUERY ( const SCHEMATIC & aSchematic)
explicit

Definition at line 31 of file conn_navigation.cpp.

References m_schematic.

Member Function Documentation

◆ CollectNetItems()

void SCH_CONNECTIVITY::NAVIGATION_QUERY::CollectNetItems ( const wxString & aName,
const SCH_SHEET_PATH & aSheet,
std::unordered_set< SCH_ITEM * > & aItems,
bool aIncludeBusParents = false,
bool aIncludeBusMembers = false ) const

Definition at line 326 of file conn_navigation.cpp.

References ADVANCED_CFG::GetCfg(), netItemsByEngine(), netSubgraphs(), and result.

Referenced by SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and WholeNetItems().

◆ HasNet()

bool SCH_CONNECTIVITY::NAVIGATION_QUERY::HasNet ( const wxString & aName) const

Definition at line 270 of file conn_navigation.cpp.

References ADVANCED_CFG::GetCfg(), netItemsByEngine(), and netSubgraphs().

Referenced by SCH_EDIT_FRAME::HandleRemoteNetHighlight().

◆ NetItems()

NET_ITEMS_BY_SHEET SCH_CONNECTIVITY::NAVIGATION_QUERY::NetItems ( const wxString & aName,
bool aIncludeBusParents,
bool aIncludeBusMembers = false ) const

Definition at line 298 of file conn_navigation.cpp.

References ADVANCED_CFG::GetCfg(), EDA_ITEM::m_Uuid, netItemsByEngine(), netSubgraphs(), path, and result.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and SCH_EDIT_FRAME::MakeNetNavigatorNode().

◆ netItemsByEngine()

NET_ITEMS_BY_SHEET SCH_CONNECTIVITY::NAVIGATION_QUERY::netItemsByEngine ( const wxString & aName,
bool aIncludeBusParents,
bool aIncludeBusMembers ) const
private

Definition at line 209 of file conn_navigation.cpp.

References equivalent(), group, index, SCH_CONNECTIVITY::NET_VIEW::Instance(), SCH_CONNECTIVITY::NET_VIEW::Items(), m_schematic, path, paths(), and result.

Referenced by CollectNetItems(), HasNet(), NetItems(), and NetSheets().

◆ NetNames()

std::vector< wxString > SCH_CONNECTIVITY::NAVIGATION_QUERY::NetNames ( ) const

Definition at line 58 of file conn_navigation.cpp.

References ADVANCED_CFG::GetCfg(), and m_schematic.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and SCH_EDIT_FRAME::RefreshNetNavigator().

◆ NetSheets()

std::set< KIID_PATH > SCH_CONNECTIVITY::NAVIGATION_QUERY::NetSheets ( const wxString & aName) const

Definition at line 279 of file conn_navigation.cpp.

References ADVANCED_CFG::GetCfg(), netItemsByEngine(), and netSubgraphs().

Referenced by HIERARCHY_PANE::UpdateNetHighlight().

◆ netSubgraphs()

std::set< const CONNECTION_SUBGRAPH * > SCH_CONNECTIVITY::NAVIGATION_QUERY::netSubgraphs ( const wxString & aName,
bool aIncludeBusParents,
bool aIncludeBusMembers ) const
private

Definition at line 155 of file conn_navigation.cpp.

References equivalent(), CONNECTION_SUBGRAPH::GetItems(), CONNECTION_SUBGRAPH::GetSheet(), SCH_SHEET_PATH::LastScreen(), m_schematic, name, and SignalNames().

Referenced by CollectNetItems(), HasNet(), NetItems(), and NetSheets().

◆ paths()

const NAVIGATION_QUERY::PATH_INDEX & SCH_CONNECTIVITY::NAVIGATION_QUERY::paths ( ) const
private

Definition at line 35 of file conn_navigation.cpp.

References index, m_paths, m_schematic, and path.

Referenced by netItemsByEngine().

◆ SignalNames()

std::vector< wxString > SCH_CONNECTIVITY::NAVIGATION_QUERY::SignalNames ( const wxString & aName) const

Definition at line 105 of file conn_navigation.cpp.

References SCH_CONNECTION::AllMembers(), ADVANCED_CFG::GetCfg(), group, SCH_CONNECTION::IsNet(), m_schematic, and SCH_CONNECTION::Name().

Referenced by BOOST_AUTO_TEST_CASE(), netSubgraphs(), and SCH_EDIT_FRAME::SetCrossProbeConnection().

◆ WholeNetItems()

std::vector< SCH_ITEM * > SCH_CONNECTIVITY::NAVIGATION_QUERY::WholeNetItems ( const std::vector< SCH_ITEM * > & aSeeds,
const SCH_SHEET_PATH & aSheet ) const

Definition at line 82 of file conn_navigation.cpp.

References CollectNetItems(), and name.

Referenced by BOOST_AUTO_TEST_CASE(), and SCH_SELECTION_TOOL::expandConnectionWithGraph().

Member Data Documentation

◆ m_paths

std::optional<PATH_INDEX> SCH_CONNECTIVITY::NAVIGATION_QUERY::m_paths
mutableprivate

Definition at line 70 of file conn_navigation.h.

Referenced by paths().

◆ m_schematic

const SCHEMATIC& SCH_CONNECTIVITY::NAVIGATION_QUERY::m_schematic
private

Definition at line 69 of file conn_navigation.h.

Referenced by NAVIGATION_QUERY(), netItemsByEngine(), NetNames(), netSubgraphs(), paths(), and SignalNames().

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