KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DATABASE_LIB_TABLE Struct Reference

A database library table will be mapped to a sub-library provided by the database library entry in the KiCad symbol/footprint library table. More...

#include <database_lib_settings.h>

Public Attributes

std::string name
 KiCad library nickname (will form part of the LIB_ID) More...
 
std::string table
 Database table to pull content from. More...
 
std::string key_col
 Unique key column name (will form part of the LIB_ID) More...
 
std::string symbols_col
 Column name containing KiCad symbol refs. More...
 
std::string footprints_col
 Column name containing KiCad footprint refs. More...
 
MAPPABLE_SYMBOL_PROPERTIES properties
 
std::vector< DATABASE_FIELD_MAPPINGfields
 

Detailed Description

A database library table will be mapped to a sub-library provided by the database library entry in the KiCad symbol/footprint library table.

A single database library config file (managed by this class) may contain more than one table mapping, and each will have its own nickname.

The LIB_ID for parts placed from this library will be constructed from the nickname of the database library itself, plus the nickname of the particular sub-library and the value of the key column for the placed part.

For example, if a database library is configured with the nickname "PartsDB" and it provides a table called "Capacitors", with key_col set to "Part Number", the LIB_ID for a capacitor placed from this table will look something like PartsDB-Capacitors:CAP-001

Definition at line 86 of file database_lib_settings.h.

Member Data Documentation

◆ fields

std::vector<DATABASE_FIELD_MAPPING> DATABASE_LIB_TABLE::fields

◆ footprints_col

std::string DATABASE_LIB_TABLE::footprints_col

Column name containing KiCad footprint refs.

Definition at line 92 of file database_lib_settings.h.

Referenced by SCH_IO_DATABASE::connect(), and SCH_IO_DATABASE::loadSymbolFromRow().

◆ key_col

std::string DATABASE_LIB_TABLE::key_col

Unique key column name (will form part of the LIB_ID)

Definition at line 90 of file database_lib_settings.h.

Referenced by SCH_IO_DATABASE::cacheLib(), and SCH_IO_DATABASE::connect().

◆ name

std::string DATABASE_LIB_TABLE::name

◆ properties

MAPPABLE_SYMBOL_PROPERTIES DATABASE_LIB_TABLE::properties

◆ symbols_col

std::string DATABASE_LIB_TABLE::symbols_col

Column name containing KiCad symbol refs.

Definition at line 91 of file database_lib_settings.h.

Referenced by SCH_IO_DATABASE::connect(), and SCH_IO_DATABASE::loadSymbolFromRow().

◆ table

std::string DATABASE_LIB_TABLE::table

Database table to pull content from.

Definition at line 89 of file database_lib_settings.h.

Referenced by SCH_IO_DATABASE::cacheLib(), and SCH_IO_DATABASE::connect().


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