SCH_CONNECTIVITY::NAVIGATION_QUERY Class Reference

Net membership for one UI operation. 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
	Signal itself or leaf signals of a bus, suitable for PCB cross-probing.
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
	Add the items of a net on one sheet to aItems without building other sheets.
std::vector< SCH_ITEM * >	WholeNetItems (const std::vector< SCH_ITEM * > &aSeeds, const SCH_SHEET_PATH &aSheet) const
	Whole nets containing the seeds on this instance; excludes bus parents and members.

Private Member Functions
std::set< const CONNECTION_SUBGRAPH * >	netSubgraphs (const wxString &aName, bool aIncludeBusParents, bool aIncludeBusMembers) const

Private Attributes
const SCHEMATIC &	m_schematic

Detailed Description

Net membership for one UI operation.

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

Definition at line 39 of file conn_navigation.h.

Constructor & Destructor Documentation

NAVIGATION_QUERY()

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

explicit

Definition at line 29 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

Add the items of a net on one sheet to aItems without building other sheets.

Definition at line 194 of file conn_navigation.cpp.

References netSubgraphs().

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

HasNet()

bool SCH_CONNECTIVITY::NAVIGATION_QUERY::HasNet

(

const wxString &

aName

)

const

Definition at line 156 of file conn_navigation.cpp.

References 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 173 of file conn_navigation.cpp.

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

Referenced by SCH_EDIT_FRAME::MakeNetNavigatorNode().

NetNames()

std::vector< wxString > SCH_CONNECTIVITY::NAVIGATION_QUERY::NetNames

(

)

const

Definition at line 33 of file conn_navigation.cpp.

References m_schematic.

Referenced by SCH_EDIT_FRAME::RefreshNetNavigator().

NetSheets()

std::set< KIID_PATH > SCH_CONNECTIVITY::NAVIGATION_QUERY::NetSheets

(

const wxString &

aName

)

const

Definition at line 162 of file conn_navigation.cpp.

References 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 102 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().

SignalNames()

std::vector< wxString > SCH_CONNECTIVITY::NAVIGATION_QUERY::SignalNames

(

const wxString &

aName

)

const

Signal itself or leaf signals of a bus, suitable for PCB cross-probing.

Definition at line 73 of file conn_navigation.cpp.

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

Referenced by 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

Whole nets containing the seeds on this instance; excludes bus parents and members.

Definition at line 50 of file conn_navigation.cpp.

References CollectNetItems(), and name.

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

Member Data Documentation

m_schematic

const SCHEMATIC& SCH_CONNECTIVITY::NAVIGATION_QUERY::m_schematic

private

Definition at line 62 of file conn_navigation.h.

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

---

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

• conn_navigation.h
• conn_navigation.cpp