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

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

Detailed Description

Definition at line 139 of file kiid.h.

Constructor & Destructor Documentation

KIID_PATH() [1/2]

KIID_PATH::KIID_PATH ( )

inline

Definition at line 142 of file kiid.h.

KIID_PATH() [2/2]

KIID_PATH::KIID_PATH

(

const wxString &

aString

)

Definition at line 301 of file kiid.cpp.

Member Function Documentation

AsString()

wxString KIID_PATH::AsString

(

)

const

Definition at line 356 of file kiid.cpp.

References KIID::AsString(), and path.

Referenced by SCH_SYMBOL::AddHierarchicalReference(), SCH_SHEET::addInstance(), SCH_EDIT_FRAME::AnnotateSymbols(), PCB_IO_KICAD_SEXPR::format(), SCH_SHEET_PATH::IsContainedWithin(), SCH_EDIT_FRAME::mapExistingAnnotation(), kiapi::common::PackSheetPath(), SCH_SHEET::RemoveInstance(), SCH_SYMBOL::RemoveInstance(), SCH_IO_KICAD_SEXPR::saveSymbol(), PCB_SELECTION_TOOL::selectSameSheet(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), 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

aPath

is the path to compare this path against.

Returns

true if this path ends with aPath or false if it does not.

Definition at line 335 of file kiid.cpp.

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

MakeRelativeTo()

bool KIID_PATH::MakeRelativeTo

(

const KIID_PATH &

aPath

)

Definition at line 311 of file kiid.cpp.

References copy.

Referenced by SCH_IO_KICAD_SEXPR::saveSymbol().

operator+=()

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

inline

Definition at line 211 of file kiid.h.

operator<()

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

inline

Definition at line 177 of file kiid.h.

operator==()

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

inline

Definition at line 163 of file kiid.h.

operator>()

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

inline

Definition at line 194 of file kiid.h.

Friends And Related Function Documentation

operator+

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

friend

Definition at line 219 of file kiid.h.

---

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

• kiid.h
• kiid.cpp