KiCad PCB EDA Suite
FP_CACHE_ITEM Class Reference

Class FP_CACHE_ITEM is helper class for creating a footprint library cache. More...

Public Member Functions

 FP_CACHE_ITEM (MODULE *aModule, const wxFileName &aFileName)
 
wxString GetName () const
 
wxFileName GetFileName () const
 
MODULEGetModule () const
 

Private Attributes

wxFileName m_file_name
 The the full file name and path of the footprint to cache. More...
 
std::unique_ptr< MODULEm_module
 

Detailed Description

Class FP_CACHE_ITEM is helper class for creating a footprint library cache.

The new footprint library design is a file path of individual module files that contain a single module per file. This class is a helper only for the footprint portion of the PLUGIN API, and only for the PCB_IO plugin. It is private to this implementation file so it is not placed into a header.

Definition at line 86 of file kicad_plugin.cpp.

Constructor & Destructor Documentation

FP_CACHE_ITEM::FP_CACHE_ITEM ( MODULE aModule,
const wxFileName &  aFileName 
)

Definition at line 101 of file kicad_plugin.cpp.

References m_file_name.

Referenced by FP_CACHE::Load().

101  :
102  m_module( aModule )
103 {
104  m_file_name = aFileName;
105 }
std::unique_ptr< MODULE > m_module
wxFileName m_file_name
The the full file name and path of the footprint to cache.

Member Function Documentation

wxFileName FP_CACHE_ITEM::GetFileName ( ) const
inline

Definition at line 95 of file kicad_plugin.cpp.

95 { return m_file_name; }
wxFileName m_file_name
The the full file name and path of the footprint to cache.
MODULE* FP_CACHE_ITEM::GetModule ( ) const
inline

Definition at line 97 of file kicad_plugin.cpp.

97 { return m_module.get(); }
std::unique_ptr< MODULE > m_module
wxString FP_CACHE_ITEM::GetName ( ) const
inline

Definition at line 94 of file kicad_plugin.cpp.

94 { return m_file_name.GetDirs().Last(); }
wxFileName m_file_name
The the full file name and path of the footprint to cache.

Member Data Documentation

wxFileName FP_CACHE_ITEM::m_file_name
private

The the full file name and path of the footprint to cache.

Definition at line 88 of file kicad_plugin.cpp.

Referenced by FP_CACHE_ITEM().

std::unique_ptr<MODULE> FP_CACHE_ITEM::m_module
private

Definition at line 89 of file kicad_plugin.cpp.


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