KiCad PCB EDA Suite
GPCB_FPL_CACHE_ITEM Class Reference

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

Public Member Functions

 GPCB_FPL_CACHE_ITEM (MODULE *aModule, const WX_FILENAME &aFileName)
 
WX_FILENAME GetFileName () const
 
MODULEGetModule () const
 

Private Attributes

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

Detailed Description

Class GPCB_FPL_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 109 of file gpcb_plugin.cpp.

Constructor & Destructor Documentation

GPCB_FPL_CACHE_ITEM::GPCB_FPL_CACHE_ITEM ( MODULE aModule,
const WX_FILENAME aFileName 
)

Definition at line 122 of file gpcb_plugin.cpp.

Referenced by GPCB_FPL_CACHE::Load().

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

Member Function Documentation

WX_FILENAME GPCB_FPL_CACHE_ITEM::GetFileName ( ) const
inline

Definition at line 117 of file gpcb_plugin.cpp.

References m_filename.

117 { return m_filename; }
WX_FILENAME m_filename
The the full file name and path of the footprint to cache.
MODULE* GPCB_FPL_CACHE_ITEM::GetModule ( ) const
inline

Definition at line 118 of file gpcb_plugin.cpp.

118 { return m_module.get(); }
std::unique_ptr< MODULE > m_module

Member Data Documentation

WX_FILENAME GPCB_FPL_CACHE_ITEM::m_filename
private

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

Definition at line 111 of file gpcb_plugin.cpp.

Referenced by GetFileName().

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

Definition at line 112 of file gpcb_plugin.cpp.


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