KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
COMPATIBILITY_REPORT Class Reference

What an export to a given target will keep, approximate, drop, or block. More...

#include <compatibility_report.h>

Public Member Functions

void Add (DOWNGRADE_BUCKET aBucket, const wxString &aFeature, const wxString &aDetail=wxEmptyString, int aCount=1)
 
void Merge (const COMPATIBILITY_REPORT &aOther)
 
const std::vector< COMPAT_ENTRY > & Entries () const
 
bool IsLossy () const
 True if anything is approximated or dropped. This is what triggers the lossy warning.
 
bool IsBlocked () const
 True if some feature makes the target impossible. The user cannot export anyway.
 
int Count (DOWNGRADE_BUCKET aBucket) const
 
wxString ToText (const wxString &aTargetName) const
 A readable preview of the classified export, including counts and feature details.
 
void Print (REPORTER *aReporter) const
 

Private Member Functions

bool Has (DOWNGRADE_BUCKET aBucket) const
 

Private Attributes

std::vector< COMPAT_ENTRY > m_entries
 

Detailed Description

What an export to a given target will keep, approximate, drop, or block.

The classifier fills this in a dry run before anything is written, so the user sees the cost up front.

Definition at line 52 of file compatibility_report.h.

Member Function Documentation

◆ Add()

void COMPATIBILITY_REPORT::Add ( DOWNGRADE_BUCKET aBucket,
const wxString & aFeature,
const wxString & aDetail = wxEmptyString,
int aCount = 1 )
inline

Definition at line 55 of file compatibility_report.h.

References m_entries.

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(), ClassifyBoardForDowngrade(), ClassifyLibSymbolForDowngrade(), ClassifyProjectForDowngrade(), ClassifySchematicStructureForDowngrade(), ClassifyScreenForDowngrade(), DowngradeProjectFileJson(), KICAD_MANAGER_CONTROL::ExportForOlderVersion(), EESCHEMA_JOBS_HANDLER::JobDowngrade(), Merge(), reportIncompatibleBuses(), reportPaddedBuses(), and reportTextPlan().

◆ Count()

int COMPATIBILITY_REPORT::Count ( DOWNGRADE_BUCKET aBucket) const
inline

Definition at line 89 of file compatibility_report.h.

References m_entries.

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(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), checkCustomPadArcSurvives(), checkNativeBoardGolden(), checkNativeSchematicGolden(), and ToText().

◆ Entries()

const std::vector< COMPAT_ENTRY > & COMPATIBILITY_REPORT::Entries ( ) const
inline

Definition at line 81 of file compatibility_report.h.

References m_entries.

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(), checkFeature(), KI_TEST::CheckTransformCoverage(), DIALOG_DOWNGRADE_REPORT::DIALOG_DOWNGRADE_REPORT(), and CLI::PROJECT_DOWNGRADE_COMMAND::doPerform().

◆ Has()

bool COMPATIBILITY_REPORT::Has ( DOWNGRADE_BUCKET aBucket) const
inlineprivate

Definition at line 163 of file compatibility_report.h.

References m_entries.

Referenced by IsBlocked(), and IsLossy().

◆ IsBlocked()

bool COMPATIBILITY_REPORT::IsBlocked ( ) const
inline

True if some feature makes the target impossible. The user cannot export anyway.

Definition at line 87 of file compatibility_report.h.

References BLOCK, and Has().

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(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), checkNativeBoardGolden(), KI_TEST::CheckTransformCoverage(), ClassifyProjectForDowngrade(), DIALOG_DOWNGRADE_REPORT::DIALOG_DOWNGRADE_REPORT(), CLI::PROJECT_DOWNGRADE_COMMAND::doPerform(), downgradeProjectFileOnDisk(), ExportBoardToOlderVersion(), KICAD_MANAGER_CONTROL::ExportForOlderVersion(), EESCHEMA_JOBS_HANDLER::JobDowngrade(), PCBNEW_JOBS_HANDLER::JobDowngrade(), and ToText().

◆ IsLossy()

bool COMPATIBILITY_REPORT::IsLossy ( ) const
inline

True if anything is approximated or dropped. This is what triggers the lossy warning.

Definition at line 84 of file compatibility_report.h.

References DROP, Has(), and LOWER.

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(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), checkNativeSchematicGolden(), KI_TEST::CheckTransformCoverage(), checkTransformedSchematicUsesOnlyKnownTokens(), CLI::PROJECT_DOWNGRADE_COMMAND::doPerform(), KICAD_MANAGER_CONTROL::ExportForOlderVersion(), EESCHEMA_JOBS_HANDLER::JobDowngrade(), PCBNEW_JOBS_HANDLER::JobDowngrade(), and ToText().

◆ Merge()

void COMPATIBILITY_REPORT::Merge ( const COMPATIBILITY_REPORT & aOther)
inline

Definition at line 75 of file compatibility_report.h.

References Add(), COMPAT_ENTRY::m_bucket, COMPAT_ENTRY::m_count, COMPAT_ENTRY::m_detail, m_entries, and COMPAT_ENTRY::m_feature.

Referenced by classifyFootprintLibraries(), ClassifyProjectForDowngrade(), classifySymbolLibraries(), and EESCHEMA_JOBS_HANDLER::JobDowngrade().

◆ Print()

void COMPATIBILITY_REPORT::Print ( REPORTER * aReporter) const
inline

Definition at line 142 of file compatibility_report.h.

References _, BLOCK, DROP, KEEP, LOWER, m_entries, REPORTER::Report(), and RPT_SEVERITY_INFO.

Referenced by CLI::PROJECT_DOWNGRADE_COMMAND::doPerform(), EESCHEMA_JOBS_HANDLER::JobDowngrade(), and PCBNEW_JOBS_HANDLER::JobDowngrade().

◆ ToText()

wxString COMPATIBILITY_REPORT::ToText ( const wxString & aTargetName) const
inline

A readable preview of the classified export, including counts and feature details.

Definition at line 103 of file compatibility_report.h.

References _, BLOCK, Count(), DROP, IsBlocked(), IsLossy(), KEEP, LOWER, m_entries, and text.

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

Member Data Documentation

◆ m_entries

std::vector<COMPAT_ENTRY> COMPATIBILITY_REPORT::m_entries
private

Definition at line 174 of file compatibility_report.h.

Referenced by Add(), Count(), Entries(), Has(), Merge(), Print(), and ToText().

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