KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
REF_SUFFIX_FIXTURE Class Reference
Inheritance diagram for REF_SUFFIX_FIXTURE:
KI_TEST::SCHEMATIC_TEST_FIXTURE

Public Member Functions

 ~REF_SUFFIX_FIXTURE () override
 
void Load (const wxString &aPath)
 
void LoadCopy ()
 
wxFileName RootFile () const
 
std::vector< SCH_SHEET_PATH > PathsOf (const wxString &aFile) const
 
std::vector< SCH_SHEET_PATH > SuffixChannels (const wxString &aFirst=wxS("_M1"), const wxString &aSecond=wxS("_M2"), const wxString &aFile=wxS("issue13212_subsheet_2.kicad_sch"))
 
std::vector< SCH_SHEET_PATH > LoadAmpliChannels ()
 
void Annotate (SCH_REFERENCE_LIST &aRefs, const SCH_MULTI_UNIT_REFERENCE_MAP &aLocked, ANNOTATE_SCOPE_T aScope, bool aResetAnnotation)
 
void AnnotateAll (bool aResetAnnotation=false)
 
void AnnotateSelection (const std::vector< SCH_SYMBOL * > &aSymbols, const SCH_SHEET_PATH &aPath)
 
void AnnotatePlaced (SCH_SYMBOL *aSymbol, const std::vector< SCH_SHEET_PATH > &aChannels)
 
int CountDuplicates ()
 
int CountErcMarkers (int aCode)
 

Static Public Member Functions

static std::vector< SCH_SHEET * > SubSheets (SCH_SCREEN *aScreen)
 
static SCH_SYMBOL * FirstSymbol (const SCH_SHEET_PATH &aPath)
 
static SCH_SYMBOL * FindSymbol (const SCH_SHEET_PATH &aPath, const wxString &aRef, int aUnit=1)
 
static void AddSuffixField (SCH_SHEET *aSheet, const wxString &aText)
 

Public Attributes

wxString m_dir
 

Protected Member Functions

virtual void LoadSchematic (const wxFileName &aFn)
 
virtual wxFileName SchematicQAPath (const wxString &aBaseName)
 
SETTINGS_MANAGER & SettingsManager ()
 

Protected Attributes

std::unique_ptr< SCHEMATIC > m_schematic
 
IO_RELEASER< SCH_IO > m_pi
 
SETTINGS_MANAGER m_manager
 

Detailed Description

Definition at line 64 of file test_ref_suffix.cpp.

Constructor & Destructor Documentation

◆ ~REF_SUFFIX_FIXTURE()

REF_SUFFIX_FIXTURE::~REF_SUFFIX_FIXTURE ( )
inlineoverride

Definition at line 67 of file test_ref_suffix.cpp.

References m_dir, KI_TEST::SCHEMATIC_TEST_FIXTURE::m_manager, and KI_TEST::SCHEMATIC_TEST_FIXTURE::m_schematic.

Member Function Documentation

◆ AddSuffixField()

static void REF_SUFFIX_FIXTURE::AddSuffixField ( SCH_SHEET * aSheet,
const wxString & aText )
inlinestatic

Definition at line 180 of file test_ref_suffix.cpp.

References SCH_SHEET::AddField(), SCH_FIELD::SetText(), and SHEET_USER.

Referenced by SuffixChannels().

◆ Annotate()

void REF_SUFFIX_FIXTURE::Annotate ( SCH_REFERENCE_LIST & aRefs,
const SCH_MULTI_UNIT_REFERENCE_MAP & aLocked,
ANNOTATE_SCOPE_T aScope,
bool aResetAnnotation )
inline

Definition at line 186 of file test_ref_suffix.cpp.

References AnnotateReferences(), BOOST_REQUIRE(), FindRefSuffixCollision(), INCREMENTAL_BY_REF, KI_TEST::SCHEMATIC_TEST_FIXTURE::m_schematic, and UNSORTED.

Referenced by AnnotateAll(), and AnnotateSelection().

◆ AnnotateAll()

void REF_SUFFIX_FIXTURE::AnnotateAll ( bool aResetAnnotation = false)
inline

Definition at line 194 of file test_ref_suffix.cpp.

References Annotate(), ANNOTATE_ALL, SCH_SHEET_LIST::GetMultiUnitSymbols(), SCH_SHEET_LIST::GetSymbols(), locked, KI_TEST::SCHEMATIC_TEST_FIXTURE::m_schematic, and SYMBOL_FILTER_NON_POWER.

◆ AnnotatePlaced()

void REF_SUFFIX_FIXTURE::AnnotatePlaced ( SCH_SYMBOL * aSymbol,
const std::vector< SCH_SHEET_PATH > & aChannels )
inline

Definition at line 219 of file test_ref_suffix.cpp.

References AnnotateNewSymbol(), SCH_SHEET_LIST::GetSymbols(), KI_TEST::SCHEMATIC_TEST_FIXTURE::m_schematic, SCH_REFERENCE_LIST::SortByReferenceOnly(), and SYMBOL_FILTER_ALL.

◆ AnnotateSelection()

void REF_SUFFIX_FIXTURE::AnnotateSelection ( const std::vector< SCH_SYMBOL * > & aSymbols,
const SCH_SHEET_PATH & aPath )
inline

Definition at line 205 of file test_ref_suffix.cpp.

References Annotate(), ANNOTATE_SELECTION, SCH_SHEET_PATH::AppendMultiUnitSymbol(), SCH_SHEET_PATH::AppendSymbol(), locked, and SYMBOL_FILTER_NON_POWER.

◆ CountDuplicates()

int REF_SUFFIX_FIXTURE::CountDuplicates ( )
inline

Definition at line 229 of file test_ref_suffix.cpp.

References SCH_REFERENCE_LIST::CheckAnnotation(), ERCE_DUPLICATE_REFERENCE, KI_TEST::SCHEMATIC_TEST_FIXTURE::m_schematic, and SYMBOL_FILTER_NON_POWER.

◆ CountErcMarkers()

int REF_SUFFIX_FIXTURE::CountErcMarkers ( int aCode)
inline

Definition at line 244 of file test_ref_suffix.cpp.

References SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), KI_TEST::SCHEMATIC_TEST_FIXTURE::m_schematic, ERC_TESTER::RunTests(), and SCH_MARKER_T.

◆ FindSymbol()

static SCH_SYMBOL * REF_SUFFIX_FIXTURE::FindSymbol ( const SCH_SHEET_PATH & aPath,
const wxString & aRef,
int aUnit = 1 )
inlinestatic

Definition at line 167 of file test_ref_suffix.cpp.

References SCH_SYMBOL::GetRef(), SCH_SYMBOL::GetUnitSelection(), SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), EE_RTREE::OfType(), and SCH_SYMBOL_T.

◆ FirstSymbol()

static SCH_SYMBOL * REF_SUFFIX_FIXTURE::FirstSymbol ( const SCH_SHEET_PATH & aPath)
inlinestatic

Definition at line 159 of file test_ref_suffix.cpp.

References SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), EE_RTREE::OfType(), and SCH_SYMBOL_T.

◆ Load()

void REF_SUFFIX_FIXTURE::Load ( const wxString & aPath)
inline

Definition at line 78 of file test_ref_suffix.cpp.

References KI_TEST::GetEeschemaTestDataDir(), FILEEXT::KiCadSchematicFileExtension, and KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic().

Referenced by LoadAmpliChannels().

◆ LoadAmpliChannels()

std::vector< SCH_SHEET_PATH > REF_SUFFIX_FIXTURE::LoadAmpliChannels ( )
inline

Definition at line 137 of file test_ref_suffix.cpp.

References Load(), and SuffixChannels().

◆ LoadCopy()

void REF_SUFFIX_FIXTURE::LoadCopy ( )
inline

Definition at line 85 of file test_ref_suffix.cpp.

References BOOST_REQUIRE(), KI_TEST::GetEeschemaTestDataDir(), FILEEXT::KiCadSchematicFileExtension, KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), m_dir, name, and RootFile().

◆ LoadSchematic()

void KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic ( const wxFileName & aFn)
protectedvirtualinherited

Definition at line 49 of file eeschema_test_utils.cpp.

References m_manager, m_pi, m_schematic, and FILEEXT::ProjectFileExtension.

Referenced by ISSUE21821_FIXTURE::ISSUE21821_FIXTURE(), REF_SUFFIX_FIXTURE::Load(), REF_SUFFIX_FIXTURE::LoadCopy(), TEST_SCH_REFERENCE_LIST_FIXTURE::loadTestCase(), and TEST_VARIANT_FIELD_RESOLUTION_FIXTURE::LoadTestSchematic().

◆ PathsOf()

std::vector< SCH_SHEET_PATH > REF_SUFFIX_FIXTURE::PathsOf ( const wxString & aFile) const
inline

Definition at line 108 of file test_ref_suffix.cpp.

References KI_TEST::SCHEMATIC_TEST_FIXTURE::m_schematic, and path.

Referenced by SuffixChannels().

◆ RootFile()

wxFileName REF_SUFFIX_FIXTURE::RootFile ( ) const
inline

Definition at line 103 of file test_ref_suffix.cpp.

References FILEEXT::KiCadSchematicFileExtension, and m_dir.

Referenced by LoadCopy().

◆ SchematicQAPath()

wxFileName KI_TEST::SCHEMATIC_TEST_FIXTURE::SchematicQAPath ( const wxString & aBaseName)
protectedvirtualinherited

Reimplemented in TEST_NETLIST_EXPORTER_SPICE_FIXTURE, TEST_SCH_GROUP_FIXTURE, TEST_SCH_SCREEN_FIXTURE, TEST_SCH_SHEET_LIST_FIXTURE, TEST_SCHEMATIC_FIXTURE, and TEST_SIM_REGRESSIONS_FIXTURE.

Definition at line 122 of file eeschema_test_utils.cpp.

References KI_TEST::GetEeschemaTestDataDir(), and FILEEXT::KiCadSchematicFileExtension.

Referenced by TEST_SCH_REFERENCE_LIST_FIXTURE::loadTestCase(), and TEST_NETLIST_EXPORTER_FIXTURE< Exporter >::TestNetlist().

◆ SettingsManager()

SETTINGS_MANAGER & KI_TEST::SCHEMATIC_TEST_FIXTURE::SettingsManager ( )
inlineprotectedinherited

Definition at line 51 of file eeschema_test_utils.h.

References m_manager.

◆ SubSheets()

static std::vector< SCH_SHEET * > REF_SUFFIX_FIXTURE::SubSheets ( SCH_SCREEN * aScreen)
inlinestatic

Definition at line 143 of file test_ref_suffix.cpp.

References SCH_SCREEN::Items(), EE_RTREE::OfType(), and SCH_SHEET_T.

◆ SuffixChannels()

std::vector< SCH_SHEET_PATH > REF_SUFFIX_FIXTURE::SuffixChannels ( const wxString & aFirst = wxS( "_M1" ),
const wxString & aSecond = wxS( "_M2" ),
const wxString & aFile = wxS( "issue13212_subsheet_2.kicad_sch" ) )
inline

Definition at line 122 of file test_ref_suffix.cpp.

References AddSuffixField(), BOOST_REQUIRE_EQUAL(), KI_TEST::SCHEMATIC_TEST_FIXTURE::m_schematic, and PathsOf().

Referenced by LoadAmpliChannels().

Member Data Documentation

◆ m_dir

wxString REF_SUFFIX_FIXTURE::m_dir

Definition at line 260 of file test_ref_suffix.cpp.

Referenced by LoadCopy(), RootFile(), and ~REF_SUFFIX_FIXTURE().

◆ m_manager

SETTINGS_MANAGER KI_TEST::SCHEMATIC_TEST_FIXTURE::m_manager
protectedinherited

Definition at line 55 of file eeschema_test_utils.h.

Referenced by TEST_SCH_GROUP_FIXTURE::CreateTestSchematic(), LoadSchematic(), SettingsManager(), and REF_SUFFIX_FIXTURE::~REF_SUFFIX_FIXTURE().

◆ m_pi

IO_RELEASER<SCH_IO> KI_TEST::SCHEMATIC_TEST_FIXTURE::m_pi
protectedinherited

Definition at line 54 of file eeschema_test_utils.h.

Referenced by LoadSchematic(), and SCHEMATIC_TEST_FIXTURE().

◆ m_schematic

std::unique_ptr<SCHEMATIC> KI_TEST::SCHEMATIC_TEST_FIXTURE::m_schematic
protectedinherited

Definition at line 53 of file eeschema_test_utils.h.

Referenced by REF_SUFFIX_FIXTURE::Annotate(), REF_SUFFIX_FIXTURE::AnnotateAll(), REF_SUFFIX_FIXTURE::AnnotatePlaced(), TEST_NETLIST_EXPORTER_FIXTURE< Exporter >::Cleanup(), REF_SUFFIX_FIXTURE::CountDuplicates(), REF_SUFFIX_FIXTURE::CountErcMarkers(), TEST_SCH_GROUP_FIXTURE::CreateTestSchematic(), TEST_ISSUE22286_FIXTURE::FindPinByNumber(), TEST_ISSUE22286_FIXTURE::FindSymbolByRef(), TEST_SCH_REFERENCE_LIST_FIXTURE::getAdditionalRefs(), TEST_SCH_SYMBOL_FIXTURE::GetFirstSymbol(), TEST_VARIANT_FIELD_RESOLUTION_FIXTURE::GetMutableInstance(), TEST_NETLIST_EXPORTER_FIXTURE< Exporter >::GetNetlistPath(), TEST_VARIANT_FIELD_RESOLUTION_FIXTURE::GetR1(), TEST_SCH_REFERENCE_LIST_FIXTURE::getSymbolByKIID(), TEST_AUTOPLACE_FIELDS_FIXTURE::GetSymbolByRef(), ISSUE21821_FIXTURE::ISSUE21821_FIXTURE(), LoadSchematic(), REF_SUFFIX_FIXTURE::PathsOf(), SCHEMATIC_TEST_FIXTURE(), REF_SUFFIX_FIXTURE::SuffixChannels(), TEST_NETLIST_EXPORTER_FIXTURE< Exporter >::WriteNetlist(), and REF_SUFFIX_FIXTURE::~REF_SUFFIX_FIXTURE().

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