Base class to derive netlist readers from. More...

#include <netlist_reader.h>

Inheritance diagram for 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
	NETLIST_READER (LINE_READER aLineReader, NETLIST aNetlist, CMP_READER *aFootprintLinkReader=nullptr)

virtual	~NETLIST_READER ()

virtual void	LoadNetlist ()=0
	Load the contents of the netlist file into aNetlist.

	NETLIST_READER (LINE_READER aLineReader, NETLIST aNetlist, CMP_READER *aFootprintLinkReader=nullptr)

virtual	~NETLIST_READER ()

virtual void	LoadNetlist ()=0
	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_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_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.

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

Base class to derive netlist readers from.

A pure virtual class to derive a specific type of netlist reader from.

This base class can be used without PCB-specific dependencies. For PCB-specific functionality (like handling FOOTPRINT objects), use the derived class in pcbnew.

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

Member Enumeration Documentation

◆ NETLIST_FILE_T [1/2]

enum NETLIST_READER::NETLIST_FILE_T

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

Enumerator
UNKNOWN
ORCAD
LEGACY
KICAD
UNKNOWN
ORCAD
LEGACY
KICAD

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

Constructor & Destructor Documentation

◆ NETLIST_READER() [1/2]

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

inline

Parameters

aLineReader	ownership is taken of this LINE_READER.
aNetlist	the NETLIST object to read into.
aFootprintLinkReader	ownership is taken of this CMP_READER.

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

References m_footprintReader, m_lineReader, m_loadFootprintFilters, m_loadNets, and m_netlist.

Referenced by GetNetlistReader(), KICAD_NETLIST_READER::KICAD_NETLIST_READER(), and LEGACY_NETLIST_READER::LEGACY_NETLIST_READER().

◆ ~NETLIST_READER() [1/2]

NETLIST_READER::~NETLIST_READER ( )

virtual

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

References m_footprintReader, and m_lineReader.

◆ NETLIST_READER() [2/2]

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

inline

Parameters

aLineReader	ownership is taken of this LINE_READER.
aNetlist	the NETLIST object to read into.
aFootprintLinkReader	ownership is taken of this CMP_READER.

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

References m_footprintReader, m_lineReader, m_loadFootprintFilters, m_loadNets, and m_netlist.

◆ ~NETLIST_READER() [2/2]

virtual NETLIST_READER::~NETLIST_READER ( )

virtual

Member Function Documentation

◆ GetNetlistReader() [1/2]

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

static

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

Parameters

aNetlist	is the netlist to load aNetlistFileName into.
aNetlistFileName	is the full path and file name of the net list to read.
aCompFootprintFileName	is 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 )

static

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

Parameters

aNetlist	is the netlist to load aNetlistFileName into.
aNetlistFileName	is the full path and file name of the net list to read.
aCompFootprintFileName	is 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.