sch_base_frame.h File Reference

#include <eda_draw_frame.h>
#include <frame_type.h>
#include <sch_draw_panel.h>
#include <sch_screen.h>
#include <schematic_settings.h>
#include <stddef.h>
#include <utility>
#include <vector>
#include <wx/event.h>
#include <wx/gdicmn.h>
#include <wx/string.h>
#include <template_fieldnames.h>

Go to the source code of this file.

Classes
class	SCH_BASE_FRAME
	A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, and SCH_EDIT_FRAME, and it brings in a common way of handling the provided virtual functions for the derived classes. More...

Namespaces
namespace	KIGFX
	The Cairo implementation of the graphics abstraction layer.

Functions
LIB_SYMBOL *	SchGetLibSymbol (const LIB_ID &aLibId, SYMBOL_LIB_TABLE *aLibTable, SYMBOL_LIB *aCacheLib=nullptr, wxWindow *aParent=nullptr, bool aShowErrorMsg=false)
	Load symbol from symbol library table. More...

Function Documentation

SchGetLibSymbol()

LIB_SYMBOL * SchGetLibSymbol	(	const LIB_ID &	aLibId,
		SYMBOL_LIB_TABLE *	aLibTable,
		SYMBOL_LIB *	aCacheLib = nullptr,
		wxWindow *	aParent = nullptr,
		bool	aShowErrorMsg = false
	)

Load symbol from symbol library table.

Check the symbol library table for the part defined by aLibId and optionally check the optional cache library.

Parameters

aLibId	is the symbol library identifier to load.
aLibTable	is the #SYMBOL_LIBRARY_TABLE to load the alias from.
aCacheLib	is an optional cache library.
aParent	is an optional parent window when displaying an error message.
aShowErrorMessage	set to true to show any error messages.

Returns

The symbol found in the library or NULL if the symbol was not found.

Definition at line 53 of file sch_base_frame.cpp.

{
 wxCHECK_MSG( aLibTable, nullptr, wxS( "Invalid symbol library table." ) );
 
 LIB_SYMBOL* symbol = nullptr;
 
 try
 {
 symbol = aLibTable->LoadSymbol( aLibId );
 
 if( !symbol && aCacheLib )
 {
 wxCHECK_MSG( aCacheLib->IsCache(), nullptr, wxS( "Invalid cache library." ) );
 
 wxString cacheName = aLibId.GetLibNickname().wx_str();
 cacheName += "_" + aLibId.GetLibItemName();
 symbol = aCacheLib->FindSymbol( cacheName );
 }
 }
 catch( const IO_ERROR& ioe )
 {
 if( aShowErrorMsg )
 {
 wxString msg = wxString::Format( _( "Error loading symbol %s from library '%s'." ),
 aLibId.GetLibItemName().wx_str(),
 aLibId.GetLibNickname().wx_str() );
 DisplayErrorMessage( aParent, msg, ioe.What() );
 }
 }
 
 return symbol;
}

References _, DisplayErrorMessage(), SYMBOL_LIB::FindSymbol(), Format(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_LIB::IsCache(), SYMBOL_LIB_TABLE::LoadSymbol(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), SCH_BASE_FRAME::GetLibSymbol(), and ERC_TESTER::TestLibSymbolIssues().