KiCad PCB EDA Suite
Public Member Functions | Private Attributes | List of all members
FP_CACHE_ITEM Class Reference

Helper class for creating a footprint library cache. More...

#include <pcb_plugin.h>

Public Member Functions

 FP_CACHE_ITEM (FOOTPRINT *aFootprint, const WX_FILENAME &aFileName)
 
const WX_FILENAME & GetFileName () const
 
void SetFilePath (const wxString &aFilePath)
 
const FOOTPRINT * GetFootprint () const
 

Private Attributes

WX_FILENAME m_filename
 
std::unique_ptr< FOOTPRINT > m_footprint
 

Detailed Description

Helper class for creating a footprint library cache.

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

Definition at line 173 of file pcb_plugin.h.

Constructor & Destructor Documentation

◆ FP_CACHE_ITEM()

FP_CACHE_ITEM::FP_CACHE_ITEM ( FOOTPRINT *  aFootprint,
const WX_FILENAME &  aFileName 
)

Definition at line 69 of file pcb_plugin.cpp.

69 :
70 m_filename( aFileName ),
71 m_footprint( aFootprint )
72{ }
FP_CACHE_ITEM::m_footprint
std::unique_ptr< FOOTPRINT > m_footprint
Definition: pcb_plugin.h:176
FP_CACHE_ITEM::m_filename
WX_FILENAME m_filename
Definition: pcb_plugin.h:175

Member Function Documentation

◆ GetFileName()

const WX_FILENAME & FP_CACHE_ITEM::GetFileName ( void  ) const
inline

Definition at line 181 of file pcb_plugin.h.

181{ return m_filename; }

References m_filename.

◆ GetFootprint()

const FOOTPRINT * FP_CACHE_ITEM::GetFootprint ( ) const
inline

Definition at line 183 of file pcb_plugin.h.

183{ return m_footprint.get(); }

References m_footprint.

◆ SetFilePath()

void FP_CACHE_ITEM::SetFilePath ( const wxString &  aFilePath)
inline

Definition at line 182 of file pcb_plugin.h.

182{ m_filename.SetPath( aFilePath ); }
WX_FILENAME::SetPath
void SetPath(const wxString &aPath)
Definition: wx_filename.cpp:40

References m_filename, and WX_FILENAME::SetPath().

Member Data Documentation

◆ m_filename

WX_FILENAME FP_CACHE_ITEM::m_filename
private

Definition at line 175 of file pcb_plugin.h.

Referenced by GetFileName(), and SetFilePath().

◆ m_footprint

std::unique_ptr<FOOTPRINT> FP_CACHE_ITEM::m_footprint
private

Definition at line 176 of file pcb_plugin.h.

Referenced by GetFootprint().

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