|
KiCad PCB EDA Suite
|
One change record on a single item. More...
#include <kicad_diff_types.h>
Public Member Functions | |
| const wxString & | DisplayType () const |
| bool | operator== (const ITEM_CHANGE &aOther) const |
| nlohmann::json | ToJson () const |
Static Public Member Functions | |
| static ITEM_CHANGE | FromJson (const nlohmann::json &aJson) |
Public Attributes | |
| KIID_PATH | id |
| wxString | typeName |
| wxString | typeLabel |
| CHANGE_KIND | kind = CHANGE_KIND::MODIFIED |
| std::vector< PROPERTY_DELTA > | properties |
| BOX2I | bbox |
| std::optional< wxString > | refdes |
| std::vector< ITEM_CHANGE > | children |
One change record on a single item.
The id is a KIID_PATH so that hierarchical context (sheet path for schematics, footprint path for child pads) is preserved across the diff/merge pipeline. The refdes field is presentation only and is not used to key items in the engine.
kind defaults to MODIFIED because that is the only kind an applier can act on without materializing or deleting an item, so a record whose kind was never set stays inert.
typeLabel is the translated name shown to the user. It is presentation only, so it is neither serialized nor compared; typeName stays the identity.
Definition at line 315 of file kicad_diff_types.h.
|
inline |
Definition at line 326 of file kicad_diff_types.h.
References typeLabel, and typeName.
Referenced by KICAD_DIFF::ChangeDisplayLabel(), and DIALOG_KICAD_DIFF::showChange().
|
static |
Definition at line 693 of file kicad_diff_types.cpp.
References bbox, KICAD_DIFF::ChangeKindFromString(), children, FromJson(), KICAD_DIFF::PROPERTY_DELTA::FromJson(), id, kind, properties, refdes, and typeName.
Referenced by BOOST_AUTO_TEST_CASE(), KICAD_DIFF::DOCUMENT_DIFF::FromJson(), and FromJson().
| bool KICAD_DIFF::ITEM_CHANGE::operator== | ( | const ITEM_CHANGE & | aOther | ) | const |
Definition at line 651 of file kicad_diff_types.cpp.
References bbox, children, id, kind, operator==(), properties, refdes, and typeName.
Referenced by operator==().
| nlohmann::json KICAD_DIFF::ITEM_CHANGE::ToJson | ( | ) | const |
Definition at line 663 of file kicad_diff_types.cpp.
References bbox, KICAD_DIFF::ChangeKindToString(), children, kind, properties, refdes, ToJson(), and typeName.
Referenced by BOOST_AUTO_TEST_CASE(), and ToJson().
| BOX2I KICAD_DIFF::ITEM_CHANGE::bbox |
Definition at line 322 of file kicad_diff_types.h.
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(), KICAD_DIFF::PCB_DIFFER::Diff(), KICAD_DIFF::SCH_DIFFER::Diff(), KICAD_DIFF::PCB_DIFFER::diffFootprintChildren(), KICAD_DIFF::DiffLibraryByName(), FromJson(), operator==(), and ToJson().
| std::vector<ITEM_CHANGE> KICAD_DIFF::ITEM_CHANGE::children |
Definition at line 324 of file kicad_diff_types.h.
Referenced by KICAD_DIFF::AppendElementChanges(), 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_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KICAD_DIFF::BuildChangeTreeGroups(), KICAD_DIFF::CombineSymbolEdits(), KICAD_DIFF::PCB_DIFFER::Diff(), KICAD_DIFF::EditedNames(), KICAD_DIFF::FormatDiffAsText(), FromJson(), operator==(), KICAD_DIFF::KICAD_MERGE_ENGINE::Plan(), DIALOG_KICAD_DIFF::showChange(), and ToJson().
| KIID_PATH KICAD_DIFF::ITEM_CHANGE::id |
Definition at line 317 of file kicad_diff_types.h.
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(), 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_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DIALOG_KICAD_DIFF::changeRowIds(), KICAD_DIFF::PCB_DIFFER::Diff(), KICAD_DIFF::SCH_DIFFER::Diff(), KICAD_DIFF::PCB_DIFFER::diffFootprintChildren(), KICAD_DIFF::DiffLibraryByName(), findDocLevelChange(), findRootDocLevelChange(), KICAD_DIFF::FormatDiffAsText(), FromJson(), EESCHEMA_JOBS_HANDLER::OpenDiffDialog(), operator==(), and DIALOG_KICAD_DIFF::showChange().
| CHANGE_KIND KICAD_DIFF::ITEM_CHANGE::kind = CHANGE_KIND::MODIFIED |
Definition at line 320 of file kicad_diff_types.h.
Referenced by KICAD_DIFF::AppendElementChanges(), 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_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_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DIALOG_KICAD_DIFF::changeRowIds(), KICAD_DIFF::FP_LIB_DIFFER::Diff(), KICAD_DIFF::PCB_DIFFER::Diff(), KICAD_DIFF::SCH_DIFFER::Diff(), KICAD_DIFF::SYM_LIB_DIFFER::Diff(), KICAD_DIFF::PCB_DIFFER::diffFootprintChildren(), KICAD_DIFF::DiffLibraryByName(), KICAD_DIFF::FormatDiffAsText(), FromJson(), EESCHEMA_JOBS_HANDLER::OpenDiffDialog(), operator==(), KICAD_DIFF::KICAD_MERGE_ENGINE::Plan(), DIALOG_KICAD_DIFF::showChange(), and ToJson().
| std::vector<PROPERTY_DELTA> KICAD_DIFF::ITEM_CHANGE::properties |
Definition at line 321 of file kicad_diff_types.h.
Referenced by KICAD_DIFF::AppendElementChanges(), 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_AUTO_TEST_CASE(), KICAD_DIFF::CombineSymbolEdits(), KICAD_DIFF::PCB_DIFFER::Diff(), KICAD_DIFF::SCH_DIFFER::Diff(), KICAD_DIFF::SYM_LIB_DIFFER::Diff(), KICAD_DIFF::PCB_DIFFER::diffFootprintChildren(), KICAD_DIFF::EditedNames(), findProperty(), findProperty(), KICAD_DIFF::FormatDiffAsText(), FromJson(), KICAD_DIFF::IndexPropertiesByName(), operator==(), KICAD_DIFF::KICAD_MERGE_ENGINE::Plan(), DIALOG_KICAD_DIFF::showChange(), and ToJson().
| std::optional<wxString> KICAD_DIFF::ITEM_CHANGE::refdes |
Definition at line 323 of file kicad_diff_types.h.
Referenced by KICAD_DIFF::AppendElementChanges(), 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(), KICAD_DIFF::ChangeDisplayLabel(), KICAD_DIFF::ChangeMatchesSearchFilter(), DIALOG_KICAD_DIFF::changeRowIds(), KICAD_DIFF::CombineSymbolEdits(), KICAD_DIFF::FP_LIB_DIFFER::Diff(), KICAD_DIFF::PCB_DIFFER::Diff(), KICAD_DIFF::SCH_DIFFER::Diff(), KICAD_DIFF::SYM_LIB_DIFFER::Diff(), KICAD_DIFF::PCB_DIFFER::diffFootprintChildren(), KICAD_DIFF::DiffLibraryByName(), KICAD_DIFF::EditedNames(), KICAD_DIFF::FormatDiffAsText(), FromJson(), KICAD_DIFF::IsRoutingNetChange(), operator==(), EESCHEMA_JOBS_HANDLER::runSymLibMerge(), DIALOG_KICAD_DIFF::showChange(), and ToJson().
| wxString KICAD_DIFF::ITEM_CHANGE::typeLabel |
Definition at line 319 of file kicad_diff_types.h.
Referenced by KICAD_DIFF::ChangeMatchesSearchFilter(), KICAD_DIFF::PCB_DIFFER::Diff(), KICAD_DIFF::SCH_DIFFER::Diff(), KICAD_DIFF::PCB_DIFFER::diffFootprintChildren(), KICAD_DIFF::DiffLibraryByName(), and DisplayType().
| wxString KICAD_DIFF::ITEM_CHANGE::typeName |
Definition at line 318 of file kicad_diff_types.h.
Referenced by KICAD_DIFF::AppendElementChanges(), 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_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_AUTO_TEST_CASE(), KICAD_DIFF::ChangeInvalidatesZone(), KICAD_DIFF::ChangeMatchesSearchFilter(), KICAD_DIFF::ChangeRequiresConnectivityRebuild(), KICAD_DIFF::PCB_DIFFER::Diff(), KICAD_DIFF::SCH_DIFFER::Diff(), KICAD_DIFF::PCB_DIFFER::diffFootprintChildren(), KICAD_DIFF::DiffLibraryByName(), DisplayType(), KICAD_DIFF::EditedNames(), KICAD_DIFF::FormatDiffAsText(), FromJson(), KICAD_DIFF::IsRoutingNetChange(), operator==(), and ToJson().