KiCad PCB EDA Suite
FP_CACHE_ITEM Class Reference

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

Public Member Functions

 FP_CACHE_ITEM (FOOTPRINT *aFootprint, const WX_FILENAME &aFileName)
 
const WX_FILENAMEGetFileName () const
 
const FOOTPRINTGetFootprint () const
 

Private Attributes

WX_FILENAME m_filename
 
std::unique_ptr< FOOTPRINTm_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 69 of file pcb_plugin.cpp.

Constructor & Destructor Documentation

◆ FP_CACHE_ITEM()

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

Definition at line 82 of file pcb_plugin.cpp.

82  :
83  m_filename( aFileName ),
84  m_footprint( aFootprint )
85 { }
std::unique_ptr< FOOTPRINT > m_footprint
Definition: pcb_plugin.cpp:72
WX_FILENAME m_filename
Definition: pcb_plugin.cpp:71

Member Function Documentation

◆ GetFileName()

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

Definition at line 77 of file pcb_plugin.cpp.

77 { return m_filename; }
WX_FILENAME m_filename
Definition: pcb_plugin.cpp:71

◆ GetFootprint()

const FOOTPRINT* FP_CACHE_ITEM::GetFootprint ( ) const
inline

Definition at line 78 of file pcb_plugin.cpp.

78 { return m_footprint.get(); }
std::unique_ptr< FOOTPRINT > m_footprint
Definition: pcb_plugin.cpp:72

Member Data Documentation

◆ m_filename

WX_FILENAME FP_CACHE_ITEM::m_filename
private

Definition at line 71 of file pcb_plugin.cpp.

◆ m_footprint

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

Definition at line 72 of file pcb_plugin.cpp.


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