FP_LIB_TABLE_ROW Class Reference

Hold a record identifying a library accessed by the appropriate footprint library PLUGIN object in the FP_LIB_TABLE. More...

#include <fp_lib_table.h>

Inheritance diagram for FP_LIB_TABLE_ROW:

Public Types
typedef IO_MGR::PCB_FILE_T	LIB_T

Public Member Functions
	FP_LIB_TABLE_ROW (const wxString &aNick, const wxString &aURI, const wxString &aType, const wxString &aOptions, const wxString &aDescr=wxEmptyString)
	FP_LIB_TABLE_ROW ()
bool	operator== (const FP_LIB_TABLE_ROW &aRow) const
bool	operator!= (const FP_LIB_TABLE_ROW &aRow) const
const wxString	GetType () const override
	return the type of footprint library table represented by this row. More...
void	SetType (const wxString &aType) override
	Change the type represented by this row. More...
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. More...
bool	GetIsLoaded () const
void	SetLoaded (bool aLoaded)
	Mark the row as being a loaded library. More...
bool	GetIsEnabled () const
void	SetEnabled (bool aEnabled=true)
	Change the enabled status of this library. More...
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. More...
void	SetFullURI (const wxString &aFullURI)
	Change the full URI for the library. More...
const wxString &	GetOptions () const
	Return the options string, which may hold a password or anything else needed to instantiate the underlying library plugin. More...
void	SetOptions (const wxString &aOptions)
	Change the library options strings. More...
const wxString &	GetDescr () const
	Return the description of the library referenced by this row. More...
void	SetDescr (const wxString &aDescr)
	Change the description of the library referenced by this row. More...
const PROPERTIES *	GetProperties () const
	Return the constant PROPERTIES for this library (LIB_TABLE_ROW). More...
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. More...
LIB_TABLE_ROW *	clone () const

Protected Member Functions
	FP_LIB_TABLE_ROW (const FP_LIB_TABLE_ROW &aRow)

Private Member Functions
virtual LIB_TABLE_ROW *	do_clone () const override
void	setPlugin (PLUGIN *aPlugin)

Private Attributes
PLUGIN::RELEASER	plugin
LIB_T	type

Friends
class	FP_LIB_TABLE

Detailed Description

Hold a record identifying a library accessed by the appropriate footprint library PLUGIN object in the FP_LIB_TABLE.

Definition at line 40 of file fp_lib_table.h.

Member Typedef Documentation

LIB_T

typedef IO_MGR::PCB_FILE_T FP_LIB_TABLE_ROW::LIB_T

Definition at line 43 of file fp_lib_table.h.

Constructor & Destructor Documentation

FP_LIB_TABLE_ROW() [1/3]

FP_LIB_TABLE_ROW::FP_LIB_TABLE_ROW ( const wxString &  aNick, const wxString &  aURI, const wxString &  aType, const wxString &  aOptions, const wxString &  aDescr = wxEmptyString  )

inline

Definition at line 45 of file fp_lib_table.h.

                                                                                         :
        LIB_TABLE_ROW( aNick, aURI, aOptions, aDescr )
    {
        SetType( aType );
    }

References SetType().

FP_LIB_TABLE_ROW() [2/3]

FP_LIB_TABLE_ROW::FP_LIB_TABLE_ROW ( )

inline

Definition at line 52 of file fp_lib_table.h.

                       :
        type( IO_MGR::KICAD_SEXP )
    {
    }

Referenced by do_clone().

FP_LIB_TABLE_ROW() [3/3]

FP_LIB_TABLE_ROW::FP_LIB_TABLE_ROW ( const FP_LIB_TABLE_ROW &  aRow )

inlineprotected

Definition at line 72 of file fp_lib_table.h.

                                                     :
        LIB_TABLE_ROW( aRow ),
        type( aRow.type )
    {
    }

Member Function Documentation

clone()

LIB_TABLE_ROW* LIB_TABLE_ROW::clone ( ) const

inlineinherited

Definition at line 186 of file lib_table_base.h.

    {
        return do_clone();
    }

References LIB_TABLE_ROW::do_clone().

Referenced by new_clone(), SYMBOL_GRID_TRICKS::paste_text(), and FP_GRID_TRICKS::paste_text().

do_clone()

virtual LIB_TABLE_ROW* FP_LIB_TABLE_ROW::do_clone ( ) const

inlineoverrideprivatevirtual

Implements LIB_TABLE_ROW.

Definition at line 79 of file fp_lib_table.h.

    {
        return new FP_LIB_TABLE_ROW( *this );
    }

References FP_LIB_TABLE_ROW().

Format()

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

inherited

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 80 of file lib_table_base.cpp.

{
    // In Kicad, we save path and file names using the Unix notation (separator = '/')
    // So ensure separator is always '/' is saved URI string
    wxString uri = GetFullURI();
    uri.Replace( '\\', '/' );

    wxString extraOptions;

    if( !GetIsEnabled() )
    {
        extraOptions += "(disabled)";
    }

    out->Print( nestLevel, "(lib (name %s)(type %s)(uri %s)(options %s)(descr %s)%s)\n",
                out->Quotew( GetNickName() ).c_str(),
                out->Quotew( GetType() ).c_str(),
                out->Quotew( uri ).c_str(),
                out->Quotew( GetOptions() ).c_str(),
                out->Quotew( GetDescr() ).c_str(),
                extraOptions.ToStdString().c_str()
                );
}

References OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

GetDescr()

const wxString& LIB_TABLE_ROW::GetDescr ( ) const

inlineinherited

Return the description of the library referenced by this row.

Definition at line 163 of file lib_table_base.h.

{ return description; }

References LIB_TABLE_ROW::description.

Referenced by LIB_TABLE::GetDescription(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TABLE_GRID::GetValue(), and SCH_EDIT_FRAME::LoadSheetFromFile().

GetFullURI()

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

inherited

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 64 of file lib_table_base.cpp.

{
    if( aSubstituted )
    {
#if !FP_LATE_ENVVAR         // early expansion
        return uri_expanded;

#else   // late expansion
        return ExpandEnvVarSubstitutions( uri_user, nullptr );
#endif
    }

    return uri_user;
}

References ExpandEnvVarSubstitutions().

Referenced by SYMBOL_LIB_TABLE::CreateSymbolLib(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), SYMBOL_LIB_TABLE::DeleteSymbol(), SYMBOL_LIB_TABLE::DeleteSymbolLib(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), SYMBOL_LIB_TABLE::EnumerateSymbolLib(), 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(), FP_LIB_TABLE::GenerateTimestamp(), FP_LIB_TABLE::GetEnumeratedFootprint(), LIB_TABLE::GetFullURI(), LIB_TABLE_GRID::GetValue(), FP_LIB_TABLE::IsFootprintLibWritable(), SYMBOL_LIB_TABLE::IsSymbolLibWritable(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_LIB_TABLE::PrefetchLib(), SCH::IFACE::SaveFileAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_LIB_TABLE::SaveSymbol(), and FOOTPRINT_VIEWER_FRAME::UpdateTitle().

GetIsEnabled()

bool LIB_TABLE_ROW::GetIsEnabled ( ) const

inlineinherited

Returns

the enabled status of this library row

Definition at line 118 of file lib_table_base.h.

{ return enabled; }

References LIB_TABLE_ROW::enabled.

Referenced by LIB_TABLE::findRow(), LIB_TABLE_GRID::GetValue(), LIB_TABLE_GRID::GetValueAsBool(), SYMBOL_LIB_TABLE_ROW::SYMBOL_LIB_TABLE_ROW(), and PANEL_SYM_LIB_TABLE::verifyTables().

GetIsLoaded()

bool LIB_TABLE_ROW::GetIsLoaded ( ) const

inlineinherited

Returns

true if the library was loaded without error

Definition at line 108 of file lib_table_base.h.

{ return m_loaded; }

References LIB_TABLE_ROW::m_loaded.

Referenced by SYMBOL_LIB_TABLE::IsSymbolLibLoaded().

GetNickName()

const wxString& LIB_TABLE_ROW::GetNickName ( ) const

inlineinherited

Returns

the logical name of this library table row.

Definition at line 98 of file lib_table_base.h.

{ return nickName; }

References LIB_TABLE_ROW::nickName.

Referenced by LIB_TABLE_GRID::ContainsNickname(), FP_LIB_TABLE::FootprintLoad(), LIB_TABLE_GRID::GetValue(), LIB_TABLE::InsertRow(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_GRID_TRICKS::optionsEditor(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), and PANEL_SYM_LIB_TABLE::verifyTables().

GetOptions()

const wxString& LIB_TABLE_ROW::GetOptions ( ) const

inlineinherited

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

Definition at line 153 of file lib_table_base.h.

{ return options; }

References LIB_TABLE_ROW::options.

Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), LIB_TABLE_GRID::GetValue(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE::LoadSymbolLib(), and FP_GRID_TRICKS::optionsEditor().

GetProperties()

const PROPERTIES* LIB_TABLE_ROW::GetProperties ( ) const

inlineinherited

Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

These are the "options" in a table.

Definition at line 174 of file lib_table_base.h.

{ return properties.get(); }

References LIB_TABLE_ROW::properties.

Referenced by SYMBOL_LIB_TABLE::CreateSymbolLib(), SYMBOL_LIB_TABLE::DeleteSymbol(), SYMBOL_LIB_TABLE::DeleteSymbolLib(), SYMBOL_LIB_TABLE::EnumerateSymbolLib(), 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(), FP_LIB_TABLE::GetEnumeratedFootprint(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_LIB_TABLE::PrefetchLib(), and SYMBOL_LIB_TABLE::SaveSymbol().

GetType()

const wxString FP_LIB_TABLE_ROW::GetType ( ) const

inlineoverridevirtual

return the type of footprint library table represented by this row.

Implements LIB_TABLE_ROW.

Definition at line 64 of file fp_lib_table.h.

{ return IO_MGR::ShowType( type ); }

References IO_MGR::ShowType(), and type.

operator!=() [1/2]

bool FP_LIB_TABLE_ROW::operator!= ( const FP_LIB_TABLE_ROW &  aRow ) const

inline

Definition at line 59 of file fp_lib_table.h.

{ return !( *this == aRow ); }

operator!=() [2/2]

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

inlineinherited

Definition at line 93 of file lib_table_base.h.

{ return !( *this == r ); }

operator==() [1/2]

bool FP_LIB_TABLE_ROW::operator==

(

const FP_LIB_TABLE_ROW &

aRow

)

const

Definition at line 48 of file fp_lib_table.cpp.

{
    return LIB_TABLE_ROW::operator == ( aRow ) && type == aRow.type;
}

References LIB_TABLE_ROW::operator==(), and type.

operator==() [2/2]

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

inherited

Definition at line 105 of file lib_table_base.cpp.

{
    return nickName == r.nickName
        && uri_user == r.uri_user
        && options == r.options
        && description == r.description
        && enabled == r.enabled;
}

References LIB_TABLE_ROW::description, LIB_TABLE_ROW::enabled, LIB_TABLE_ROW::nickName, LIB_TABLE_ROW::options, and LIB_TABLE_ROW::uri_user.

Referenced by operator==(), and SYMBOL_LIB_TABLE_ROW::operator==().

SetDescr()

void LIB_TABLE_ROW::SetDescr ( const wxString &  aDescr )

inlineinherited

Change the description of the library referenced by this row.

Definition at line 168 of file lib_table_base.h.

{ description = aDescr; }

References LIB_TABLE_ROW::description.

Referenced by LIB_TABLE_GRID::SetValue().

SetEnabled()

void LIB_TABLE_ROW::SetEnabled ( bool  aEnabled = true )

inlineinherited

Change the enabled status of this library.

Definition at line 123 of file lib_table_base.h.

{ enabled = aEnabled; }

References LIB_TABLE_ROW::enabled.

Referenced by LIB_TABLE_GRID::SetValue(), LIB_TABLE_GRID::SetValueAsBool(), and SYMBOL_LIB_TABLE_ROW::SYMBOL_LIB_TABLE_ROW().

SetFullURI()

void LIB_TABLE_ROW::SetFullURI ( const wxString &  aFullURI )

inherited

Change the full URI for the library.

Definition at line 54 of file lib_table_base.cpp.

{
    uri_user = aFullURI;

#if !FP_LATE_ENVVAR
    uri_expanded = FP_LIB_TABLE::ExpandSubstitutions( aFullURI );
#endif
}

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), LIB_TABLE_ROW::LIB_TABLE_ROW(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH::IFACE::SaveFileAs(), and LIB_TABLE_GRID::SetValue().

SetLoaded()

void LIB_TABLE_ROW::SetLoaded ( bool  aLoaded )

inlineinherited

Mark the row as being a loaded library.

Definition at line 113 of file lib_table_base.h.

{ m_loaded = aLoaded; };

References LIB_TABLE_ROW::m_loaded.

Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), and SYMBOL_LIB_TABLE::LoadSymbolLib().

SetNickName()

void LIB_TABLE_ROW::SetNickName ( const wxString &  aNickName )

inlineinherited

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

Definition at line 103 of file lib_table_base.h.

{ nickName = aNickName; }

References LIB_TABLE_ROW::nickName.

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), and LIB_TABLE_GRID::SetValue().

SetOptions()

void LIB_TABLE_ROW::SetOptions ( const wxString &  aOptions )

inherited

Change the library options strings.

Definition at line 115 of file lib_table_base.cpp.

{
    options = aOptions;

    // set PROPERTIES* from options
    setProperties( LIB_TABLE::ParseOptions( TO_UTF8( aOptions ) ) );
}

References LIB_TABLE::ParseOptions(), and TO_UTF8.

Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), LIB_TABLE_ROW::LIB_TABLE_ROW(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_GRID_TRICKS::optionsEditor(), and LIB_TABLE_GRID::SetValue().

setPlugin()

void FP_LIB_TABLE_ROW::setPlugin ( PLUGIN *  aPlugin )

inlineprivate

Definition at line 84 of file fp_lib_table.h.

    {
        plugin.set( aPlugin );
    }

References plugin, and PLUGIN::RELEASER::set().

Referenced by FP_LIB_TABLE::FindRow().

SetType()

void FP_LIB_TABLE_ROW::SetType ( const wxString &  aType )

overridevirtual

Change the type represented by this row.

Implements LIB_TABLE_ROW.

Definition at line 54 of file fp_lib_table.cpp.

{
    type = IO_MGR::EnumFromStr( aType );

    if( IO_MGR::PCB_FILE_T( -1 ) == type )
        type = IO_MGR::KICAD_SEXP;

    plugin.release();
}

References IO_MGR::EnumFromStr(), and IO_MGR::KICAD_SEXP.

Referenced by FP_LIB_TABLE_ROW().

Friends And Related Function Documentation

FP_LIB_TABLE

friend class FP_LIB_TABLE

friend

Definition at line 89 of file fp_lib_table.h.

Member Data Documentation

plugin

PLUGIN::RELEASER FP_LIB_TABLE_ROW::plugin

private

Definition at line 91 of file fp_lib_table.h.

Referenced by FP_LIB_TABLE::FindRow(), 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(), FP_LIB_TABLE::GenerateTimestamp(), FP_LIB_TABLE::GetEnumeratedFootprint(), FP_LIB_TABLE::IsFootprintLibWritable(), FP_LIB_TABLE::PrefetchLib(), and setPlugin().

type

LIB_T FP_LIB_TABLE_ROW::type

private

Definition at line 92 of file fp_lib_table.h.

Referenced by FP_LIB_TABLE::FindRow(), GetType(), and operator==().

---

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

• fp_lib_table.h
• fp_lib_table.cpp