KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Friends | List of all members
KIID_PATH Class Reference

#include <kiid.h>

Inheritance diagram for KIID_PATH:

Public Member Functions

 KIID_PATH ()
 
 KIID_PATH (const wxString &aString)
 
bool MakeRelativeTo (const KIID_PATH &aPath)
 
bool EndsWith (const KIID_PATH &aPath) const
 Test if aPath from the last path towards the first path.
 
bool IsContainedWithin (const KIID_PATH &aParentPath) const
 
wxString AsString () const
 
bool operator== (KIID_PATH const &rhs) const
 
bool operator< (KIID_PATH const &rhs) const
 
bool operator> (KIID_PATH const &rhs) const
 
KIID_PATH & operator+= (const KIID_PATH &aRhs)
 

Public Attributes

T elements
 STL member.
 

Friends

KIID_PATH operator+ (KIID_PATH aLhs, const KIID_PATH &aRhs)
 

Detailed Description

Definition at line 173 of file kiid.h.

Constructor & Destructor Documentation

◆ KIID_PATH() [1/2]

KIID_PATH::KIID_PATH ( )
inline

Definition at line 176 of file kiid.h.

Referenced by EndsWith(), IsContainedWithin(), MakeRelativeTo(), operator+, operator+=(), operator<(), operator==(), and operator>().

◆ KIID_PATH() [2/2]

KIID_PATH::KIID_PATH ( const wxString & aString)

Definition at line 368 of file kiid.cpp.

Member Function Documentation

◆ AsString()

wxString KIID_PATH::AsString ( ) const

Definition at line 423 of file kiid.cpp.

References KIID::AsString(), and path.

Referenced by SCH_SYMBOL::AddHierarchicalReference(), SCH_SHEET::addInstance(), SCH_EDIT_FRAME::AnnotateSymbols(), KICAD_DIFF::ApplyAutoResolutions(), 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(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), KICAD_DIFF::BuildConflictDetailText(), KICAD_DIFF::BuildConflictList(), SCH_SHEET_LIST::CheckForMissingSymbolInstances(), SCH_SHEET_PATH::CheckForMissingSymbolInstances(), DIALOG_KICAD_MERGE_3WAY::DIALOG_KICAD_MERGE_3WAY(), PCB_IO_KICAD_SEXPR::format(), KICAD_DIFF::FormatDiffAsText(), SCH_FIELD::GetShownText(), SCH_FIELD::getUnescapedText(), API_HANDLER_SCH::handlePlaceSymbolFromLibrary(), SCH_SHEET_PATH::IsContainedWithin(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_IO_ALTIUM::NormalizeRepeatedSheetInstances(), SCH_SHEET::RemoveInstance(), SCH_SYMBOL::RemoveInstance(), SCH_IO_KICAD_SEXPR::saveSymbol(), PCB_SELECTION_TOOL::selectSameSheet(), SCH_EDIT_FRAME::SetCurrentSheet(), DIALOG_KICAD_MERGE_3WAY::showConflict(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), BOARD_NETLIST_UPDATER::updateGroups(), HIERARCHY_PANE::UpdateNetHighlight(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and SCH_SHEET_LIST::UpdateSymbolInstanceData().

◆ EndsWith()

bool KIID_PATH::EndsWith ( const KIID_PATH & aPath) const

Test if aPath from the last path towards the first path.

This is useful for testing for existing schematic symbol and sheet instances when copying or adding a new sheet that is lower in the hierarchy than the current path.

Parameters
aPathis the path to compare this path against.
Returns
true if this path ends with aPath or false if it does not.

Definition at line 402 of file kiid.cpp.

References KIID_PATH().

Referenced by BOOST_AUTO_TEST_CASE(), and SCH_EDITOR_CONTROL::updatePastedSymbol().

◆ IsContainedWithin()

bool KIID_PATH::IsContainedWithin ( const KIID_PATH & aParentPath) const
inline

Definition at line 193 of file kiid.h.

References KIID_PATH().

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ MakeRelativeTo()

bool KIID_PATH::MakeRelativeTo ( const KIID_PATH & aPath)

Definition at line 378 of file kiid.cpp.

References clear(), copy, and KIID_PATH().

Referenced by SCH_IO_KICAD_SEXPR::saveSymbol().

◆ operator+=()

KIID_PATH & KIID_PATH::operator+= ( const KIID_PATH & aRhs)
inline

Definition at line 248 of file kiid.h.

References KIID_PATH().

◆ operator<()

bool KIID_PATH::operator< ( KIID_PATH const & rhs) const
inline

Definition at line 214 of file kiid.h.

References KIID_PATH().

◆ operator==()

bool KIID_PATH::operator== ( KIID_PATH const & rhs) const
inline

Definition at line 200 of file kiid.h.

References KIID_PATH().

◆ operator>()

bool KIID_PATH::operator> ( KIID_PATH const & rhs) const
inline

Definition at line 231 of file kiid.h.

References KIID_PATH().

Friends And Related Symbol Documentation

◆ operator+

KIID_PATH operator+ ( KIID_PATH aLhs,
const KIID_PATH & aRhs )
friend

Definition at line 256 of file kiid.h.

References KIID_PATH().

Member Data Documentation

◆ elements

T std::vector< T >::elements
inherited

STL member.

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