KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
KICAD_NETLIST_READER Class Reference

Read the new s-expression based KiCad netlist format. More...

#include <netlist_reader.h>

Inheritance diagram for KICAD_NETLIST_READER:
NETLIST_READER NETLIST_READER

Public Types

enum  NETLIST_FILE_T {
  UNKNOWN = -1 , ORCAD , LEGACY , KICAD ,
  UNKNOWN = -1 , ORCAD , LEGACY , KICAD
}
 
enum  NETLIST_FILE_T {
  UNKNOWN = -1 , ORCAD , LEGACY , KICAD ,
  UNKNOWN = -1 , ORCAD , LEGACY , KICAD
}
 

Public Member Functions

 KICAD_NETLIST_READER (LINE_READER *aLineReader, NETLIST *aNetlist, CMP_READER *aFootprintLinkReader=nullptr)
 
virtual ~KICAD_NETLIST_READER ()
 
virtual void LoadNetlist () override
 Load the contents of the netlist file into aNetlist.
 
 KICAD_NETLIST_READER (LINE_READER *aLineReader, NETLIST *aNetlist, CMP_READER *aFootprintLinkReader=nullptr)
 
virtual ~KICAD_NETLIST_READER ()
 
virtual void LoadNetlist () override
 Load the contents of the netlist file into aNetlist.
 

Static Public Member Functions

static NETLIST_FILE_T GuessNetlistFileType (LINE_READER *aLineReader)
 Look at aFileHeaderLine to see if it matches any of the netlist file types it knows about.
 
static NETLIST_FILE_T GuessNetlistFileType (LINE_READER *aLineReader)
 Look at aFileHeaderLine to see if it matches any of the netlist file types it knows about.
 
static NETLIST_READER * GetNetlistReader (NETLIST *aNetlist, const wxString &aNetlistFileName, const wxString &aCompFootprintFileName=wxEmptyString)
 Attempt to determine the net list file type of aNetlistFileName and return the appropriate NETLIST_READER type.
 
static NETLIST_READER * GetNetlistReader (NETLIST *aNetlist, const wxString &aNetlistFileName, const wxString &aCompFootprintFileName=wxEmptyString)
 Attempt to determine the net list file type of aNetlistFileName and return the appropriate NETLIST_READER type.
 

Protected Attributes

NETLIST * m_netlist
 The net list to read the file(s) into.
 
bool m_loadFootprintFilters
 Load the component footprint filters section if true.
 
bool m_loadNets
 Load the nets section of the netlist file if true.
 
LINE_READER * m_lineReader
 The line reader of the netlist.
 
CMP_READER * m_footprintReader
 The reader used to load the footprint links. If NULL, footprint links are not read.
 

Detailed Description

Read the new s-expression based KiCad netlist format.

Definition at line 259 of file common/netlist_reader/netlist_reader.h.

Member Enumeration Documentation

◆ NETLIST_FILE_T [1/2]

enum NETLIST_READER::NETLIST_FILE_T
inherited
Enumerator
UNKNOWN 
ORCAD 
LEGACY 
KICAD 
UNKNOWN 
ORCAD 
LEGACY 
KICAD 

Definition at line 96 of file common/netlist_reader/netlist_reader.h.

◆ NETLIST_FILE_T [2/2]

enum NETLIST_READER::NETLIST_FILE_T
inherited
Enumerator
UNKNOWN 
ORCAD 
LEGACY 
KICAD 
UNKNOWN 
ORCAD 
LEGACY 
KICAD 

Definition at line 97 of file pcbnew/netlist_reader/netlist_reader.h.

Constructor & Destructor Documentation

◆ KICAD_NETLIST_READER() [1/2]

KICAD_NETLIST_READER::KICAD_NETLIST_READER ( LINE_READER * aLineReader,
NETLIST * aNetlist,
CMP_READER * aFootprintLinkReader = nullptr )
inline

Definition at line 262 of file common/netlist_reader/netlist_reader.h.

References NETLIST_READER::NETLIST_READER().

◆ ~KICAD_NETLIST_READER() [1/2]

virtual KICAD_NETLIST_READER::~KICAD_NETLIST_READER ( )
inlinevirtual

Definition at line 268 of file common/netlist_reader/netlist_reader.h.

◆ KICAD_NETLIST_READER() [2/2]

KICAD_NETLIST_READER::KICAD_NETLIST_READER ( LINE_READER * aLineReader,
NETLIST * aNetlist,
CMP_READER * aFootprintLinkReader = nullptr )
inline

Definition at line 263 of file pcbnew/netlist_reader/netlist_reader.h.

References NETLIST_READER::NETLIST_READER().

◆ ~KICAD_NETLIST_READER() [2/2]

virtual KICAD_NETLIST_READER::~KICAD_NETLIST_READER ( )
inlinevirtual

Definition at line 269 of file pcbnew/netlist_reader/netlist_reader.h.

Member Function Documentation

◆ GetNetlistReader() [1/2]

NETLIST_READER * NETLIST_READER::GetNetlistReader ( NETLIST * aNetlist,
const wxString & aNetlistFileName,
const wxString & aCompFootprintFileName = wxEmptyString )
staticinherited

Attempt to determine the net list file type of aNetlistFileName and return the appropriate NETLIST_READER type.

Parameters
aNetlistis the netlist to load aNetlistFileName into.
aNetlistFileNameis the full path and file name of the net list to read.
aCompFootprintFileNameis the full path and file name of the component footprint associations to read. Set to wxEmptyString if loading the footprint association file is not required.
Returns
the appropriate NETLIST_READER if aNetlistFileName is a valid netlist or NULL if aNetlistFileName is not a valid netlist files.

Definition at line 76 of file common/netlist_reader/netlist_reader.cpp.

References GuessNetlistFileType(), KICAD, LEGACY, NETLIST_READER(), and ORCAD.

Referenced by TEST_NETLIST_EXPORTER_KICAD_FIXTURE::CompareNetlists(), and PCB_EDIT_FRAME::ReadNetlistFromFile().

◆ GetNetlistReader() [2/2]

static NETLIST_READER * NETLIST_READER::GetNetlistReader ( NETLIST * aNetlist,
const wxString & aNetlistFileName,
const wxString & aCompFootprintFileName = wxEmptyString )
staticinherited

Attempt to determine the net list file type of aNetlistFileName and return the appropriate NETLIST_READER type.

Parameters
aNetlistis the netlist to load aNetlistFileName into.
aNetlistFileNameis the full path and file name of the net list to read.
aCompFootprintFileNameis the full path and file name of the component footprint associations to read. Set to wxEmptyString if loading the footprint association file is not required.
Returns
the appropriate NETLIST_READER if aNetlistFileName is a valid netlist or NULL if aNetlistFileName is not a valid netlist files.

References NETLIST_READER().

◆ GuessNetlistFileType() [1/2]

NETLIST_READER::NETLIST_FILE_T NETLIST_READER::GuessNetlistFileType ( LINE_READER * aLineReader)
staticinherited

Look at aFileHeaderLine to see if it matches any of the netlist file types it knows about.

Parameters
aLineReaderis the LINE_READER object containing lines from the netlist to test.
Returns
the NETLIST_FILE_T of aLineReader.

Definition at line 43 of file common/netlist_reader/netlist_reader.cpp.

References From_UTF8(), KICAD, LEGACY, LINE_READER::Line(), ORCAD, LINE_READER::ReadLine(), and UNKNOWN.

Referenced by GetNetlistReader().

◆ GuessNetlistFileType() [2/2]

static NETLIST_FILE_T NETLIST_READER::GuessNetlistFileType ( LINE_READER * aLineReader)
staticinherited

Look at aFileHeaderLine to see if it matches any of the netlist file types it knows about.

Parameters
aLineReaderis the LINE_READER object containing lines from the netlist to test.
Returns
the NETLIST_FILE_T of aLineReader.

◆ LoadNetlist() [1/2]

void KICAD_NETLIST_READER::LoadNetlist ( )
overridevirtual

Load the contents of the netlist file into aNetlist.

Exceptions
IO_ERRORif a file IO error occurs.
PARSE_ERRORif an error occurs while parsing the file.

Implements NETLIST_READER.

Definition at line 37 of file common/netlist_reader/kicad_netlist_reader.cpp.

References NETLIST_READER::m_footprintReader, NETLIST_READER::m_lineReader, NETLIST_READER::m_netlist, and KICAD_NETLIST_PARSER::Parse().

Referenced by PCB_EDIT_FRAME::FetchNetlistFromSchematic(), PCBNEW_JOBS_HANDLER::JobExportDrc(), and CVPCB_MAINFRAME::readSchematicNetlist().

◆ LoadNetlist() [2/2]

virtual void KICAD_NETLIST_READER::LoadNetlist ( )
overridevirtual

Load the contents of the netlist file into aNetlist.

Exceptions
IO_ERRORif a file IO error occurs.
PARSE_ERRORif an error occurs while parsing the file.

Implements NETLIST_READER.

Member Data Documentation

◆ m_footprintReader

CMP_READER * NETLIST_READER::m_footprintReader
protectedinherited

The reader used to load the footprint links. If NULL, footprint links are not read.

Definition at line 168 of file common/netlist_reader/netlist_reader.h.

Referenced by KICAD_NETLIST_READER::LoadNetlist(), LEGACY_NETLIST_READER::LoadNetlist(), LoadNetlist(), NETLIST_READER(), and ~NETLIST_READER().

◆ m_lineReader

LINE_READER * NETLIST_READER::m_lineReader
protectedinherited

The line reader of the netlist.

Definition at line 165 of file common/netlist_reader/netlist_reader.h.

Referenced by LEGACY_NETLIST_READER::loadComponent(), LEGACY_NETLIST_READER::loadFootprintFilters(), LEGACY_NETLIST_READER::loadNet(), KICAD_NETLIST_READER::LoadNetlist(), LEGACY_NETLIST_READER::LoadNetlist(), LoadNetlist(), NETLIST_READER(), and ~NETLIST_READER().

◆ m_loadFootprintFilters

bool NETLIST_READER::m_loadFootprintFilters
protectedinherited

Load the component footprint filters section if true.

Definition at line 163 of file common/netlist_reader/netlist_reader.h.

Referenced by LEGACY_NETLIST_READER::LoadNetlist(), LoadNetlist(), and NETLIST_READER().

◆ m_loadNets

bool NETLIST_READER::m_loadNets
protectedinherited

Load the nets section of the netlist file if true.

Definition at line 164 of file common/netlist_reader/netlist_reader.h.

Referenced by LoadNetlist(), and NETLIST_READER().

◆ m_netlist

NETLIST * NETLIST_READER::m_netlist
protectedinherited

The net list to read the file(s) into.

Definition at line 162 of file common/netlist_reader/netlist_reader.h.

Referenced by LEGACY_NETLIST_READER::loadComponent(), LEGACY_NETLIST_READER::loadFootprintFilters(), KICAD_NETLIST_READER::LoadNetlist(), LEGACY_NETLIST_READER::LoadNetlist(), LoadNetlist(), and NETLIST_READER().

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