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)
wxString	AsString () const
bool	operator== (KIID_PATH const &rhs) const
bool	operator< (KIID_PATH const &rhs) const

Detailed Description

Definition at line 107 of file kiid.h.

Constructor & Destructor Documentation

KIID_PATH() [1/2]

KIID_PATH::KIID_PATH ( )

inline

Definition at line 110 of file kiid.h.

    {
    }

KIID_PATH() [2/2]

KIID_PATH::KIID_PATH

(

const wxString &

aString

)

Definition at line 246 of file kiid.cpp.

{
    for( const wxString& pathStep : wxSplit( aString, '/' ) )
    {
        if( !pathStep.empty() )
            emplace_back( KIID( pathStep ) );
    }
}

Member Function Documentation

AsString()

wxString KIID_PATH::AsString

(

)

const

Definition at line 277 of file kiid.cpp.

{
    wxString path;

    for( const KIID& pathStep : *this )
        path += '/' + pathStep.AsString();

    return path;
}

References KIID::AsString(), and path.

Referenced by SCH_SYMBOL::AddHierarchicalReference(), SCH_EDIT_FRAME::AnnotateSymbols(), PCB_IO::format(), MakeRelativeTo(), SCH_EDIT_FRAME::mapExistingAnnotation(), SCH_SYMBOL::ReplaceInstanceSheetPath(), PCB_SELECTION_TOOL::selectAllItemsOnSheet(), PCB_SELECTION_TOOL::selectSameSheet(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), and SCH_SHEET_LIST::UpdateSheetInstances().

MakeRelativeTo()

bool KIID_PATH::MakeRelativeTo

(

const KIID_PATH &

aPath

)

Definition at line 256 of file kiid.cpp.

{
    KIID_PATH copy = *this;
    clear();

    if( aPath.size() > copy.size() )
        return false; // this path is not contained within aPath

    for( size_t i = 0; i < aPath.size(); ++i )
    {
        if( copy.at( i ).AsString() != aPath.at( i ).AsString() )
            return false; // this path is not contained within aPath
    }

    for( size_t i = aPath.size(); i < copy.size(); ++i )
        push_back( copy.at( i ) );

    return true;
}

References AsString(), and copy.

operator<()

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

inline

Definition at line 134 of file kiid.h.

    {
        if( size() != rhs.size() )
            return size() < rhs.size();

        for( size_t i = 0; i < size(); ++i )
        {
            if( at( i ) < rhs.at( i ) )
                return true;

            if( at( i ) != rhs.at( i ) )
                return false;
        }

        return false;
    }

operator==()

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

inline

Definition at line 120 of file kiid.h.

    {
        if( size() != rhs.size() )
            return false;

        for( size_t i = 0; i < size(); ++i )
        {
            if( at( i ) != rhs.at( i ) )
                return false;
        }

        return true;
    }

---

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

• kiid.h
• kiid.cpp