KiCad PCB EDA Suite
GPCB_FPL_CACHE_ITEM Class Reference

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

Public Member Functions

 GPCB_FPL_CACHE_ITEM (FOOTPRINT *aFootprint, const WX_FILENAME &aFileName)
 
WX_FILENAME GetFileName () const
 
FOOTPRINTGetFootprint () const
 

Private Attributes

WX_FILENAME m_filename
 The full file name and path of the footprint to cache. More...
 
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_IO plugin. It is private to this implementation file so it is not placed into a header.

Definition at line 108 of file gpcb_plugin.cpp.

Constructor & Destructor Documentation

◆ GPCB_FPL_CACHE_ITEM()

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

Definition at line 122 of file gpcb_plugin.cpp.

122  :
123  m_filename( aFileName ),
124  m_footprint( aFootprint )
125 {
126 }
WX_FILENAME m_filename
The full file name and path of the footprint to cache.
std::unique_ptr< FOOTPRINT > m_footprint

Member Function Documentation

◆ GetFileName()

WX_FILENAME GPCB_FPL_CACHE_ITEM::GetFileName ( void  ) const
inline

Definition at line 113 of file gpcb_plugin.cpp.

113 { return m_filename; }
WX_FILENAME m_filename
The full file name and path of the footprint to cache.

References m_filename.

◆ GetFootprint()

FOOTPRINT* GPCB_FPL_CACHE_ITEM::GetFootprint ( ) const
inline

Definition at line 114 of file gpcb_plugin.cpp.

114 { return m_footprint.get(); }
std::unique_ptr< FOOTPRINT > m_footprint

References m_footprint.

Member Data Documentation

◆ m_filename

WX_FILENAME GPCB_FPL_CACHE_ITEM::m_filename
private

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

Definition at line 117 of file gpcb_plugin.cpp.

Referenced by GetFileName().

◆ m_footprint

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

Definition at line 118 of file gpcb_plugin.cpp.

Referenced by GetFootprint().


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