FP_CACHE_ENTRY Class Reference

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

#include <pcb_io_kicad_sexpr.h>

Public Member Functions
	FP_CACHE_ENTRY (FOOTPRINT *aFootprint, const WX_FILENAME &aFileName)
const WX_FILENAME &	GetFileName () const
void	SetFilePath (const wxString &aFilePath)
std::unique_ptr< FOOTPRINT > &	GetFootprint ()

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 206 of file pcb_io_kicad_sexpr.h.

Constructor & Destructor Documentation

FP_CACHE_ENTRY()

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

Definition at line 75 of file pcb_io_kicad_sexpr.cpp.

Member Function Documentation

GetFileName()

const WX_FILENAME & FP_CACHE_ENTRY::GetFileName ( ) const

inline

Definition at line 214 of file pcb_io_kicad_sexpr.h.

References m_filename.

Referenced by FP_CACHE::Save().

GetFootprint()

std::unique_ptr< FOOTPRINT > & FP_CACHE_ENTRY::GetFootprint ( )

inline

Definition at line 216 of file pcb_io_kicad_sexpr.h.

References m_footprint.

Referenced by FP_CACHE::Save().

SetFilePath()

void FP_CACHE_ENTRY::SetFilePath ( const wxString &  aFilePath )

inline

Definition at line 215 of file pcb_io_kicad_sexpr.h.

References m_filename, and WX_FILENAME::SetPath().

Member Data Documentation

m_filename

WX_FILENAME FP_CACHE_ENTRY::m_filename

private

Definition at line 208 of file pcb_io_kicad_sexpr.h.

Referenced by GetFileName(), and SetFilePath().

m_footprint

std::unique_ptr<FOOTPRINT> FP_CACHE_ENTRY::m_footprint

private

Definition at line 209 of file pcb_io_kicad_sexpr.h.

Referenced by GetFootprint().

---

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

• pcb_io_kicad_sexpr.h
• pcb_io_kicad_sexpr.cpp