KiCad PCB EDA Suite
Loading...
Searching...
No Matches
KICAD_DIFF::PCB_MERGE_APPLIER::REPORT Struct Reference

Report on the application after Apply() runs. More...

#include <pcb_merge_applier.h>

Public Attributes

std::size_t itemsTakenOurs = 0
 
std::size_t itemsTakenTheirs = 0
 
std::size_t itemsMergedProps = 0
 
std::size_t itemsDeleted = 0
 
std::size_t itemsKept = 0
 
std::size_t propertiesApplied = 0
 
std::size_t propertiesFailed = 0
 
bool requiresZoneRefill = false
 
bool requiresConnectivityRebuild = false
 
bool projectFileTouched = false
 True iff the applier resolved state that lives in the .kicad_pro or a project sibling file.
 
bool drcSeveritiesTouched = false
 
bool netClassesTouched = false
 
wxString drawingSheetFile
 Drawing sheet path the applier resolved (from a doc-level resolution).
 
bool drawingSheetFileSet = false
 
wxString customDrcRules
 Custom DRC rules (.kicad_dru) content the applier resolved.
 
bool customDrcRulesSet = false
 
wxString fpLibTable
 fp-lib-table content the applier resolved.
 
bool fpLibTableSet = false
 
wxString symLibTable
 sym-lib-table content the applier resolved.
 
bool symLibTableSet = false
 
VALIDATION_REPORT validation
 Post-apply validator pipeline result (refdes uniqueness, connectivity-rebuild-ack, schema-version compatibility).
 
bool connectivityRebuildPerformed = false
 True iff the caller invoked connectivity recomputation after the applier produced the merged document.
 

Detailed Description

Report on the application after Apply() runs.

Definition at line 82 of file pcb_merge_applier.h.

Member Data Documentation

◆ connectivityRebuildPerformed

bool KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::connectivityRebuildPerformed = false

True iff the caller invoked connectivity recomputation after the applier produced the merged document.

The applier itself doesn't run rebuilds (it has no connectivity engine attached), so this stays false unless the caller flips it before reading validation. CheckConnectivityRebuildFlag uses this against the plan's requiresConnectivityRebuild signal.

Definition at line 142 of file pcb_merge_applier.h.

◆ customDrcRules

wxString KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::customDrcRules

Custom DRC rules (.kicad_dru) content the applier resolved.

Empty until customDrcRulesSet flips true. The rules content lives in a sibling file rather than the project file, so the handler writes it out separately from SaveProjectCopy.

Definition at line 116 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER::runPcbMerge().

◆ customDrcRulesSet

bool KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::customDrcRulesSet = false

Definition at line 117 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER::runPcbMerge().

◆ drawingSheetFile

wxString KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::drawingSheetFile

Drawing sheet path the applier resolved (from a doc-level resolution).

Empty until drawingSheetFileSet flips true. The applier can't reach the result BOARD's project directly (the result is a fresh project-less BOARD), so it stages the value here for the handler to apply onto ancestor's project before SaveProjectCopy.

Definition at line 109 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER::runPcbMerge().

◆ drawingSheetFileSet

bool KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::drawingSheetFileSet = false

Definition at line 110 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER::runPcbMerge().

◆ drcSeveritiesTouched

bool KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::drcSeveritiesTouched = false

Definition at line 100 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER::runPcbMerge().

◆ fpLibTable

wxString KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::fpLibTable

fp-lib-table content the applier resolved.

Empty until fpLibTableSet flips true. The handler writes it into the merged project directory.

Definition at line 122 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER::runPcbMerge().

◆ fpLibTableSet

bool KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::fpLibTableSet = false

Definition at line 123 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER::runPcbMerge().

◆ itemsDeleted

std::size_t KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::itemsDeleted = 0

Definition at line 87 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ itemsKept

std::size_t KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::itemsKept = 0

Definition at line 88 of file pcb_merge_applier.h.

◆ itemsMergedProps

std::size_t KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::itemsMergedProps = 0

Definition at line 86 of file pcb_merge_applier.h.

◆ itemsTakenOurs

std::size_t KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::itemsTakenOurs = 0

Definition at line 84 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ itemsTakenTheirs

std::size_t KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::itemsTakenTheirs = 0

Definition at line 85 of file pcb_merge_applier.h.

◆ netClassesTouched

bool KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::netClassesTouched = false

Definition at line 101 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER::runPcbMerge().

◆ projectFileTouched

bool KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::projectFileTouched = false

True iff the applier resolved state that lives in the .kicad_pro or a project sibling file.

The field-specific flags below identify which project subtrees should be patched so unrelated data remains untouched.

Definition at line 99 of file pcb_merge_applier.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(), and PCBNEW_JOBS_HANDLER::runPcbMerge().

◆ propertiesApplied

std::size_t KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::propertiesApplied = 0

Definition at line 89 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ propertiesFailed

std::size_t KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::propertiesFailed = 0

Definition at line 90 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ requiresConnectivityRebuild

bool KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::requiresConnectivityRebuild = false

Definition at line 93 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ requiresZoneRefill

bool KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::requiresZoneRefill = false

Definition at line 92 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ symLibTable

wxString KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::symLibTable

sym-lib-table content the applier resolved.

Same staging model as fpLibTable.

Definition at line 127 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER::runPcbMerge().

◆ symLibTableSet

bool KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::symLibTableSet = false

Definition at line 128 of file pcb_merge_applier.h.

Referenced by BOOST_AUTO_TEST_CASE(), and PCBNEW_JOBS_HANDLER::runPcbMerge().

◆ validation

VALIDATION_REPORT KICAD_DIFF::PCB_MERGE_APPLIER::REPORT::validation

Post-apply validator pipeline result (refdes uniqueness, connectivity-rebuild-ack, schema-version compatibility).

Populated unconditionally by Apply() so handlers can surface the failures through the job reporter.

Definition at line 134 of file pcb_merge_applier.h.

Referenced by PCBNEW_JOBS_HANDLER::runPcbMerge().


The documentation for this struct was generated from the following file: