Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE. More...

#include <lib_table_base.h>

Inheritance diagram for LIB_TABLE_ROW:

Public Member Functions
	LIB_TABLE_ROW ()

virtual	~LIB_TABLE_ROW ()

	LIB_TABLE_ROW (const wxString &aNick, const wxString &aURI, const wxString &aOptions, const wxString &aDescr=wxEmptyString, LIB_TABLE *aParent=nullptr)

bool	operator== (const LIB_TABLE_ROW &r) const

bool	operator!= (const LIB_TABLE_ROW &r) const

const wxString &	GetNickName () const

void	SetNickName (const wxString &aNickName)
	Change the logical name of this library, useful for an editor.

bool	GetIsLoaded () const

void	SetLoaded (bool aLoaded)
	Mark the row as being a loaded library.

bool	GetIsEnabled () const

void	SetEnabled (bool aEnabled=true)
	Change the enabled status of this library.

bool	GetIsVisible () const

void	SetVisible (bool aVisible=true)

virtual bool	LibraryExists () const =0

virtual bool	Refresh ()

virtual const wxString	GetType () const =0
	Return the type of library represented by this row.

virtual void	SetType (const wxString &aType)=0
	Change the type of library represented by this row that must be implemented in the derived object to provide the library table row type.

virtual bool	SupportsSettingsDialog () const

virtual void	ShowSettingsDialog (wxWindow *aParent) const

const wxString	GetFullURI (bool aSubstituted=false) const
	Return the full location specifying URI for the LIB, either in original UI form or in environment variable expanded form.

void	SetFullURI (const wxString &aFullURI)
	Change the full URI for the library.

const wxString &	GetOptions () const
	Return the options string, which may hold a password or anything else needed to instantiate the underlying library plugin.

void	SetOptions (const wxString &aOptions)
	Change the library options strings.

const wxString &	GetDescr () const
	Return the description of the library referenced by this row.

void	SetDescr (const wxString &aDescr)
	Change the description of the library referenced by this row.

LIB_TABLE *	GetParent () const

void	SetParent (LIB_TABLE *aParent)

std::mutex &	GetMutex ()

const std::map< std::string, UTF8 > &	GetProperties () const
	Return the constant #PROPERTIES for this library (LIB_TABLE_ROW).

void	Format (OUTPUTFORMATTER *out, int nestLevel) const
	Serialize this object as utf8 text to an OUTPUTFORMATTER, and tries to make it look good using multiple lines and indentation.

LIB_TABLE_ROW *	clone () const

Protected Member Functions
	LIB_TABLE_ROW (const LIB_TABLE_ROW &aRow)

void	operator= (const LIB_TABLE_ROW &aRow)

Private Member Functions
virtual LIB_TABLE_ROW *	do_clone () const =0

void	setProperties (const std::map< std::string, UTF8 > &aProperties)

Private Attributes
wxString	nickName

wxString	uri_user
	what user entered from UI or loaded from disk

wxString	options

wxString	description

bool	enabled = true
	Whether the LIB_TABLE_ROW is enabled.

bool	visible = true
	Whether the LIB_TABLE_ROW is visible in choosers.

bool	m_loaded = false
	Whether the LIB_TABLE_ROW is loaded.

LIB_TABLE *	m_parent
	Pointer to the table this row lives in (maybe null)

std::map< std::string, UTF8 >	properties

std::mutex	m_loadMutex

Detailed Description

Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.

This is an abstract base class from which to derive library specific rows.

Definition at line 124 of file lib_table_base.h.

Constructor & Destructor Documentation

◆ LIB_TABLE_ROW() [1/3]

LIB_TABLE_ROW::LIB_TABLE_ROW ( )

inline

Definition at line 127 of file lib_table_base.h.

References enabled, m_loaded, m_parent, and visible.

Referenced by clone(), FP_LIB_TABLE_ROW::do_clone(), do_clone(), FP_LIB_TABLE_ROW::FP_LIB_TABLE_ROW(), FP_LIB_TABLE_ROW::FP_LIB_TABLE_ROW(), LIB_TABLE_ROW(), operator!=(), operator=(), and operator==().

◆ ~LIB_TABLE_ROW()

virtual LIB_TABLE_ROW::~LIB_TABLE_ROW ( )

inlinevirtual

Definition at line 135 of file lib_table_base.h.

◆ LIB_TABLE_ROW() [2/3]

LIB_TABLE_ROW::LIB_TABLE_ROW	(	const wxString &	aNick,
		const wxString &	aURI,
		const wxString &	aOptions,
		const wxString &	aDescr = wxEmptyString,
		LIB_TABLE *	aParent = nullptr )

inline

Definition at line 139 of file lib_table_base.h.

References description, enabled, m_loaded, m_parent, nickName, SetFullURI(), SetOptions(), and visible.

◆ LIB_TABLE_ROW() [3/3]

LIB_TABLE_ROW::LIB_TABLE_ROW ( const LIB_TABLE_ROW & aRow )

inlineprotected

Definition at line 271 of file lib_table_base.h.

References description, enabled, LIB_TABLE_ROW(), m_loaded, m_parent, nickName, options, properties, uri_user, and visible.

Member Function Documentation

◆ clone()

LIB_TABLE_ROW * LIB_TABLE_ROW::clone ( ) const

inline

Definition at line 265 of file lib_table_base.h.

References do_clone(), and LIB_TABLE_ROW().

Referenced by new_clone().

◆ do_clone()

virtual LIB_TABLE_ROW * LIB_TABLE_ROW::do_clone ( ) const

privatepure virtual

Implemented in FP_LIB_TABLE_ROW.

References LIB_TABLE_ROW(), and setProperties().

Referenced by clone().

◆ Format()

void LIB_TABLE_ROW::Format	(	OUTPUTFORMATTER *	out,
		int	nestLevel ) const

Serialize this object as utf8 text to an OUTPUTFORMATTER, and tries to make it look good using multiple lines and indentation.

Parameters

out	is an OUTPUTFORMATTER
nestLevel	is the indentation level to base all lines of the output. Actual indentation will be 2 spaces for each nestLevel.

Definition at line 125 of file lib_table_base.cpp.

References GetDescr(), GetFullURI(), GetIsEnabled(), GetIsVisible(), GetNickName(), GetOptions(), GetType(), OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

◆ GetDescr()

const wxString & LIB_TABLE_ROW::GetDescr ( ) const

inline

Return the description of the library referenced by this row.

Definition at line 236 of file lib_table_base.h.

References description.

Referenced by Format(), LIB_TABLE::GetDescription(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), and DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow().

◆ GetFullURI()

const wxString LIB_TABLE_ROW::GetFullURI ( bool aSubstituted = false ) const

Return the full location specifying URI for the LIB, either in original UI form or in environment variable expanded form.

Parameters

aSubstituted Tells if caller wanted the substituted form, else not.

Definition at line 114 of file lib_table_base.cpp.

References ExpandEnvVarSubstitutions(), and uri_user.

Referenced by EXPORTER_STEP::buildFootprint3DShapes(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), LIB_TABLE::FindRowByURI(), FP_LIB_TABLE::FootprintDelete(), FP_LIB_TABLE::FootprintEnumerate(), FP_LIB_TABLE::FootprintExists(), FP_LIB_TABLE::FootprintLibCreate(), FP_LIB_TABLE::FootprintLibDelete(), FP_LIB_TABLE::FootprintLoad(), FP_LIB_TABLE::FootprintSave(), Format(), FP_LIB_TABLE::GenerateTimestamp(), FP_LIB_TABLE::GetEnumeratedFootprint(), LIB_TABLE::GetFullURI(), idf_export_footprint(), FP_LIB_TABLE::IsFootprintLibWritable(), FP_LIB_TABLE_ROW::LibraryExists(), RENDER_3D_RAYTRACE_BASE::load3DModels(), RENDER_3D_OPENGL::load3dModels(), FP_LIB_TABLE::LoadGlobalTable(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), PCB::IFACE::SaveFileAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), PCB_BASE_FRAME::setFPWatcher(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists().

◆ GetIsEnabled()

bool LIB_TABLE_ROW::GetIsEnabled ( ) const

inline

Returns: the enabled status of this library row

Definition at line 179 of file lib_table_base.h.

References enabled.

Referenced by LIB_TABLE::findRow(), Format(), and LIB_TABLE::GetLogicalLibs().

◆ GetIsLoaded()

bool LIB_TABLE_ROW::GetIsLoaded ( ) const

inline

Returns: true if the library was loaded without error

Definition at line 169 of file lib_table_base.h.

References m_loaded.

◆ GetIsVisible()

bool LIB_TABLE_ROW::GetIsVisible ( ) const

inline

Definition at line 186 of file lib_table_base.h.

References visible.

Referenced by Format().

◆ GetMutex()

std::mutex & LIB_TABLE_ROW::GetMutex ( )

inline

Definition at line 247 of file lib_table_base.h.

References m_loadMutex.

◆ GetNickName()

const wxString & LIB_TABLE_ROW::GetNickName ( ) const

inline

Returns: the logical name of this library table row.

Definition at line 159 of file lib_table_base.h.

References nickName.

Referenced by BOOST_AUTO_TEST_CASE(), LIB_TABLE::doInsertRow(), FP_LIB_TABLE::FootprintLoad(), Format(), LIB_TABLE::GetLogicalLibs(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), FP_LIB_TABLE::LoadGlobalTable(), and LIB_TABLE::RemoveRow().

◆ GetOptions()

const wxString & LIB_TABLE_ROW::GetOptions ( ) const

inline

Return the options string, which may hold a password or anything else needed to instantiate the underlying library plugin.

Definition at line 226 of file lib_table_base.h.

References options.

Referenced by Format().

◆ GetParent()

LIB_TABLE * LIB_TABLE_ROW::GetParent ( ) const

inline

Definition at line 243 of file lib_table_base.h.

References m_parent.

◆ GetProperties()

const std::map< std::string, UTF8 > & LIB_TABLE_ROW::GetProperties ( ) const

inline

Return the constant #PROPERTIES for this library (LIB_TABLE_ROW).

These are the "options" in a table.

Definition at line 253 of file lib_table_base.h.

References properties.

Referenced by FP_LIB_TABLE::FootprintDelete(), FP_LIB_TABLE::FootprintEnumerate(), FP_LIB_TABLE::FootprintExists(), FP_LIB_TABLE::FootprintLibCreate(), FP_LIB_TABLE::FootprintLibDelete(), FP_LIB_TABLE::FootprintLoad(), FP_LIB_TABLE::FootprintSave(), and FP_LIB_TABLE::GetEnumeratedFootprint().

◆ GetType()

virtual const wxString LIB_TABLE_ROW::GetType ( ) const

pure virtual

Return the type of library represented by this row.

Implemented in FP_LIB_TABLE_ROW.

Referenced by Format().

◆ LibraryExists()

virtual bool LIB_TABLE_ROW::LibraryExists ( ) const

pure virtual

Implemented in FP_LIB_TABLE_ROW.

Referenced by DRC_TEST_PROVIDER_LIBRARY_PARITY::Run().

◆ operator!=()

bool LIB_TABLE_ROW::operator!= ( const LIB_TABLE_ROW & r ) const

inline

Definition at line 154 of file lib_table_base.h.

References LIB_TABLE_ROW().

◆ operator=()

void LIB_TABLE_ROW::operator= ( const LIB_TABLE_ROW & aRow )

protected

References LIB_TABLE_ROW().

◆ operator==()

bool LIB_TABLE_ROW::operator== ( const LIB_TABLE_ROW & r ) const

Definition at line 150 of file lib_table_base.cpp.

References description, enabled, LIB_TABLE_ROW(), nickName, options, uri_user, and visible.

Referenced by FP_LIB_TABLE_ROW::operator==().

◆ Refresh()

virtual bool LIB_TABLE_ROW::Refresh ( )

inlinevirtual

Definition at line 192 of file lib_table_base.h.

Referenced by LIB_TABLE_GRID_TRICKS::doPopupSelection().

◆ SetDescr()

void LIB_TABLE_ROW::SetDescr ( const wxString & aDescr )

inline

Change the description of the library referenced by this row.

Definition at line 241 of file lib_table_base.h.

References description.

◆ SetEnabled()

void LIB_TABLE_ROW::SetEnabled ( bool aEnabled = true )

inline

Change the enabled status of this library.

Definition at line 184 of file lib_table_base.h.

References enabled.

◆ SetFullURI()

void LIB_TABLE_ROW::SetFullURI ( const wxString & aFullURI )

Change the full URI for the library.

Definition at line 108 of file lib_table_base.cpp.

References uri_user.

Referenced by LIB_TABLE_ROW(), and PCB::IFACE::SaveFileAs().

◆ SetLoaded()

void LIB_TABLE_ROW::SetLoaded ( bool aLoaded )

inline

Mark the row as being a loaded library.

Definition at line 174 of file lib_table_base.h.

References m_loaded.

◆ SetNickName()

void LIB_TABLE_ROW::SetNickName ( const wxString & aNickName )

inline

Change the logical name of this library, useful for an editor.

Definition at line 164 of file lib_table_base.h.

References nickName.

◆ SetOptions()

void LIB_TABLE_ROW::SetOptions ( const wxString & aOptions )

Change the library options strings.

Definition at line 161 of file lib_table_base.cpp.

References options, LIB_TABLE::ParseOptions(), setProperties(), and TO_UTF8.

Referenced by LIB_TABLE_ROW().

◆ SetParent()

void LIB_TABLE_ROW::SetParent ( LIB_TABLE * aParent )

inline

Definition at line 245 of file lib_table_base.h.

References m_parent.

Referenced by LIB_TABLE::doInsertRow().

◆ setProperties()

void LIB_TABLE_ROW::setProperties ( const std::map< std::string, UTF8 > & aProperties )

private

Definition at line 102 of file lib_table_base.cpp.

References properties.

Referenced by do_clone(), and SetOptions().

◆ SetType()

virtual void LIB_TABLE_ROW::SetType ( const wxString & aType )

pure virtual

Change the type of library represented by this row that must be implemented in the derived object to provide the library table row type.

Implemented in FP_LIB_TABLE_ROW.

◆ SetVisible()

void LIB_TABLE_ROW::SetVisible ( bool aVisible = true )

inline

Definition at line 188 of file lib_table_base.h.

References visible.

◆ ShowSettingsDialog()

virtual void LIB_TABLE_ROW::ShowSettingsDialog ( wxWindow * aParent ) const

inlinevirtual

Definition at line 207 of file lib_table_base.h.

Referenced by LIB_TABLE_GRID_TRICKS::doPopupSelection().

◆ SupportsSettingsDialog()

virtual bool LIB_TABLE_ROW::SupportsSettingsDialog ( ) const

inlinevirtual

Definition at line 205 of file lib_table_base.h.

Member Data Documentation

◆ description

wxString LIB_TABLE_ROW::description

private

Definition at line 295 of file lib_table_base.h.

Referenced by GetDescr(), LIB_TABLE_ROW(), LIB_TABLE_ROW(), operator==(), and SetDescr().

◆ enabled

bool LIB_TABLE_ROW::enabled = true

private

Whether the LIB_TABLE_ROW is enabled.

Definition at line 297 of file lib_table_base.h.

Referenced by GetIsEnabled(), LIB_TABLE_ROW(), LIB_TABLE_ROW(), LIB_TABLE_ROW(), operator==(), and SetEnabled().

◆ m_loaded

bool LIB_TABLE_ROW::m_loaded = false

private

Whether the LIB_TABLE_ROW is loaded.

Definition at line 299 of file lib_table_base.h.

Referenced by GetIsLoaded(), LIB_TABLE_ROW(), LIB_TABLE_ROW(), LIB_TABLE_ROW(), and SetLoaded().

◆ m_loadMutex

std::mutex LIB_TABLE_ROW::m_loadMutex

private

Definition at line 304 of file lib_table_base.h.

Referenced by GetMutex().

◆ m_parent

LIB_TABLE* LIB_TABLE_ROW::m_parent

private

Pointer to the table this row lives in (maybe null)

Definition at line 300 of file lib_table_base.h.

Referenced by GetParent(), LIB_TABLE_ROW(), LIB_TABLE_ROW(), LIB_TABLE_ROW(), and SetParent().

◆ nickName

wxString LIB_TABLE_ROW::nickName

private

Definition at line 292 of file lib_table_base.h.

Referenced by GetNickName(), LIB_TABLE_ROW(), LIB_TABLE_ROW(), operator==(), and SetNickName().

◆ options

wxString LIB_TABLE_ROW::options

private

Definition at line 294 of file lib_table_base.h.

Referenced by GetOptions(), LIB_TABLE_ROW(), operator==(), and SetOptions().

◆ properties

std::map<std::string, UTF8> LIB_TABLE_ROW::properties

private

Definition at line 302 of file lib_table_base.h.

Referenced by GetProperties(), LIB_TABLE_ROW(), and setProperties().

◆ uri_user

wxString LIB_TABLE_ROW::uri_user

private

what user entered from UI or loaded from disk

Definition at line 293 of file lib_table_base.h.

Referenced by GetFullURI(), LIB_TABLE_ROW(), operator==(), and SetFullURI().

◆ visible

bool LIB_TABLE_ROW::visible = true

private

Whether the LIB_TABLE_ROW is visible in choosers.

Definition at line 298 of file lib_table_base.h.

Referenced by GetIsVisible(), LIB_TABLE_ROW(), LIB_TABLE_ROW(), LIB_TABLE_ROW(), operator==(), and SetVisible().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LIB_TABLE_ROW() [1/3]

◆ ~LIB_TABLE_ROW()

◆ LIB_TABLE_ROW() [2/3]

◆ LIB_TABLE_ROW() [3/3]

Member Function Documentation

◆ clone()

◆ do_clone()

◆ Format()

◆ GetDescr()

◆ GetFullURI()

◆ GetIsEnabled()

◆ GetIsLoaded()

◆ GetIsVisible()

◆ GetMutex()

◆ GetNickName()

◆ GetOptions()

◆ GetParent()

◆ GetProperties()

◆ GetType()

◆ LibraryExists()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ Refresh()

◆ SetDescr()

◆ SetEnabled()

◆ SetFullURI()

◆ SetLoaded()

◆ SetNickName()

◆ SetOptions()

◆ SetParent()

◆ setProperties()

◆ SetType()

◆ SetVisible()

◆ ShowSettingsDialog()

◆ SupportsSettingsDialog()

Member Data Documentation

◆ description

◆ enabled

◆ m_loaded

◆ m_loadMutex

◆ m_parent

◆ nickName

◆ options

◆ properties

◆ uri_user

◆ visible