KICAD_DIFF::DIFF_EMIT_OPTIONS Struct Reference

Describes how a computed DOCUMENT_DIFF should be emitted by a diff job. More...

#include <diff_job_output.h>

Public Attributes
JOB_DIFF_BASE::OUTPUT_FORMAT	format = JOB_DIFF_BASE::OUTPUT_FORMAT::JSON
wxString	outputPath
	empty -> stdout (JSON/text only)
wxString	labelA
wxString	labelB
DOC_KIND	docKind = DOC_KIND::PCB
	Source document type, propagated onto the scene so the PNG/SVG renderer sizes its viewport with the matching internal-unit scale.
std::function< DOCUMENT_GEOMETRY(const KIGFX::COLOR4D &)>	referenceGeometry
std::function< DOCUMENT_GEOMETRY(const KIGFX::COLOR4D &)>	comparisonGeometry

Detailed Description

Describes how a computed DOCUMENT_DIFF should be emitted by a diff job.

The geometry callbacks are invoked only for the PNG/SVG formats, with the per-side theme colour, so JSON/text runs pay nothing for geometry extraction.

Definition at line 51 of file diff_job_output.h.

Member Data Documentation

comparisonGeometry

std::function<DOCUMENT_GEOMETRY( const KIGFX::COLOR4D& )> KICAD_DIFF::DIFF_EMIT_OPTIONS::comparisonGeometry

Definition at line 64 of file diff_job_output.h.

Referenced by KICAD_DIFF::EmitDiffResult(), PCBNEW_JOBS_HANDLER::JobDiff(), PCBNEW_JOBS_HANDLER::JobFpDiff(), EESCHEMA_JOBS_HANDLER::JobSchDiff(), and EESCHEMA_JOBS_HANDLER::JobSymDiff().

docKind

DOC_KIND KICAD_DIFF::DIFF_EMIT_OPTIONS::docKind = DOC_KIND::PCB

Source document type, propagated onto the scene so the PNG/SVG renderer sizes its viewport with the matching internal-unit scale.

Defaults to PCB; schematic and symbol-library jobs must set SCH / SYM_LIB.

Definition at line 61 of file diff_job_output.h.

Referenced by KICAD_DIFF::EmitDiffResult(), PCBNEW_JOBS_HANDLER::JobDiff(), PCBNEW_JOBS_HANDLER::JobFpDiff(), EESCHEMA_JOBS_HANDLER::JobSchDiff(), and EESCHEMA_JOBS_HANDLER::JobSymDiff().

format

JOB_DIFF_BASE::OUTPUT_FORMAT KICAD_DIFF::DIFF_EMIT_OPTIONS::format = JOB_DIFF_BASE::OUTPUT_FORMAT::JSON

Definition at line 53 of file diff_job_output.h.

Referenced by KICAD_DIFF::EmitDiffResult(), and KICAD_DIFF::MakeEmitOptions().

labelA

wxString KICAD_DIFF::DIFF_EMIT_OPTIONS::labelA

Definition at line 55 of file diff_job_output.h.

Referenced by KICAD_DIFF::EmitDiffResult(), and KICAD_DIFF::MakeEmitOptions().

labelB

wxString KICAD_DIFF::DIFF_EMIT_OPTIONS::labelB

Definition at line 56 of file diff_job_output.h.

Referenced by KICAD_DIFF::EmitDiffResult(), and KICAD_DIFF::MakeEmitOptions().

outputPath

wxString KICAD_DIFF::DIFF_EMIT_OPTIONS::outputPath

empty -> stdout (JSON/text only)

Definition at line 54 of file diff_job_output.h.

Referenced by KICAD_DIFF::EmitDiffResult(), and KICAD_DIFF::MakeEmitOptions().

referenceGeometry

std::function<DOCUMENT_GEOMETRY( const KIGFX::COLOR4D& )> KICAD_DIFF::DIFF_EMIT_OPTIONS::referenceGeometry

Definition at line 63 of file diff_job_output.h.

Referenced by KICAD_DIFF::EmitDiffResult(), PCBNEW_JOBS_HANDLER::JobDiff(), PCBNEW_JOBS_HANDLER::JobFpDiff(), EESCHEMA_JOBS_HANDLER::JobSchDiff(), and EESCHEMA_JOBS_HANDLER::JobSymDiff().

---

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

• diff_job_output.h