HEADLESS_PCB_CONTEXT Class Reference

#include <headless_pcb_context.h>

Inheritance diagram for HEADLESS_PCB_CONTEXT:

Public Member Functions
	HEADLESS_PCB_CONTEXT (std::unique_ptr< BOARD > aBoard, PROJECT *aProject, APP_SETTINGS_BASE *aSettings, KIWAY *aKiway=nullptr)
	~HEADLESS_PCB_CONTEXT () override
BOARD *	GetBoard () const override
PROJECT &	Prj () const override
TOOL_MANAGER *	GetToolManager () const override
KIWAY *	GetKiway () const override
wxString	GetCurrentFileName () const override
bool	CanAcceptApiCommands () const override
bool	IsContentModified () const override
void	SetContentModified (bool aModified=true) override
bool	SaveBoard () override
bool	SavePcbCopy (const wxString &aFileName, bool aCreateProject, bool aHeadless) override
bool	ReadNetlistFromFile (const wxString &aFilename, NETLIST &aNetlist, REPORTER &aReporter) override
	Read a netlist file and preload component footprints.
std::unique_ptr< BOARD_NETLIST_UPDATER >	MakeNetlistUpdater () override
	Create a netlist updater bound to this context's board.
void	OnNetlistChanged (BOARD_NETLIST_UPDATER &aUpdater) override
	Post-import board sync (nets, classes, DRC, ratsnest, new footprint placement).
bool	RevertToSaved () override

Private Attributes
std::unique_ptr< BOARD >	m_board
PROJECT *	m_project
KIWAY *	m_kiway
std::unique_ptr< TOOL_MANAGER >	m_toolManager
bool	m_contentModified = false

Detailed Description

Definition at line 37 of file headless_pcb_context.h.

Constructor & Destructor Documentation

HEADLESS_PCB_CONTEXT()

HEADLESS_PCB_CONTEXT::HEADLESS_PCB_CONTEXT	(	std::unique_ptr< BOARD >	aBoard,
		PROJECT *	aProject,
		APP_SETTINGS_BASE *	aSettings,
		KIWAY *	aKiway = nullptr )

Definition at line 41 of file headless_pcb_context.cpp.

References m_board, m_kiway, m_project, m_toolManager, and move.

~HEADLESS_PCB_CONTEXT()

HEADLESS_PCB_CONTEXT::~HEADLESS_PCB_CONTEXT ( )

override

Definition at line 57 of file headless_pcb_context.cpp.

References m_board.

Member Function Documentation

CanAcceptApiCommands()

bool HEADLESS_PCB_CONTEXT::CanAcceptApiCommands ( ) const

inlineoverridevirtual

Implements BOARD_CONTEXT.

Definition at line 55 of file headless_pcb_context.h.

Referenced by BOOST_FIXTURE_TEST_CASE().

GetBoard()

BOARD * HEADLESS_PCB_CONTEXT::GetBoard ( ) const

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 67 of file headless_pcb_context.cpp.

References m_board.

Referenced by BOOST_FIXTURE_TEST_CASE(), MakeNetlistUpdater(), OnNetlistChanged(), and ReadNetlistFromFile().

GetCurrentFileName()

wxString HEADLESS_PCB_CONTEXT::GetCurrentFileName ( ) const

overridevirtual

Implements PCB_CONTEXT.

Definition at line 87 of file headless_pcb_context.cpp.

References m_board.

Referenced by BOOST_FIXTURE_TEST_CASE().

GetKiway()

KIWAY * HEADLESS_PCB_CONTEXT::GetKiway ( ) const

inlineoverridevirtual

Implements BOARD_CONTEXT.

Definition at line 51 of file headless_pcb_context.h.

References m_kiway.

GetToolManager()

TOOL_MANAGER * HEADLESS_PCB_CONTEXT::GetToolManager ( ) const

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 81 of file headless_pcb_context.cpp.

References m_toolManager.

Referenced by BOOST_FIXTURE_TEST_CASE(), and MakeNetlistUpdater().

IsContentModified()

bool HEADLESS_PCB_CONTEXT::IsContentModified ( ) const

inlineoverridevirtual

Implements PCB_CONTEXT.

Definition at line 57 of file headless_pcb_context.h.

References m_contentModified.

MakeNetlistUpdater()

std::unique_ptr< BOARD_NETLIST_UPDATER > HEADLESS_PCB_CONTEXT::MakeNetlistUpdater ( )

overridevirtual

Create a netlist updater bound to this context's board.

Implements PCB_CONTEXT.

Definition at line 175 of file headless_pcb_context.cpp.

References GetBoard(), and GetToolManager().

OnNetlistChanged()

void HEADLESS_PCB_CONTEXT::OnNetlistChanged ( BOARD_NETLIST_UPDATER & aUpdater )

overridevirtual

Post-import board sync (nets, classes, DRC, ratsnest, new footprint placement).

Implements PCB_CONTEXT.

Definition at line 181 of file headless_pcb_context.cpp.

References BOARD::CompileRatsnest(), BOARD_NETLIST_UPDATER::GetAddedFootprints(), GetBoard(), BOARD::GetComponentClassManager(), BOARD::GetDesignRulesPath(), COMPONENT_CLASS_MANAGER::InvalidateComponentClasses(), m_toolManager, COMPONENT_CLASS_MANAGER::RebuildRequiredCaches(), SpreadFootprints(), and BOARD::SynchronizeNetsAndNetClasses().

Prj()

PROJECT & HEADLESS_PCB_CONTEXT::Prj ( ) const

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 73 of file headless_pcb_context.cpp.

References m_project.

Referenced by BOOST_FIXTURE_TEST_CASE().

ReadNetlistFromFile()

bool HEADLESS_PCB_CONTEXT::ReadNetlistFromFile ( const wxString & aFilename, NETLIST & aNetlist, REPORTER & aReporter )

overridevirtual

Read a netlist file and preload component footprints.

Implements PCB_CONTEXT.

Definition at line 145 of file headless_pcb_context.cpp.

References _, GetBoard(), NETLIST_READER::GetNetlistReader(), LoadNetlistFootprints(), REPORTER::Report(), RPT_SEVERITY_ERROR, and IO_ERROR::What().

RevertToSaved()

bool HEADLESS_PCB_CONTEXT::RevertToSaved ( )

overridevirtual

Implements PCB_CONTEXT.

Definition at line 214 of file headless_pcb_context.cpp.

References PCB_IO_MGR::FILE_TYPE_NONE, PCB_IO_MGR::FindPluginTypeFromBoardPath(), GetAppSettings(), KICTL_KICAD_ONLY, BOARD_LOADER::Load(), m_board, m_contentModified, m_project, and m_toolManager.

SaveBoard()

bool HEADLESS_PCB_CONTEXT::SaveBoard ( )

overridevirtual

Implements PCB_CONTEXT.

Definition at line 96 of file headless_pcb_context.cpp.

References PGM_BASE::GetSettingsManager(), m_board, m_contentModified, Pgm(), FILEEXT::ProjectFileExtension, BOARD_LOADER::SaveBoard(), and SETTINGS_MANAGER::SaveProjectAs().

SavePcbCopy()

bool HEADLESS_PCB_CONTEXT::SavePcbCopy ( const wxString & aFileName, bool aCreateProject, bool aHeadless )

overridevirtual

Implements PCB_CONTEXT.

Definition at line 123 of file headless_pcb_context.cpp.

References PGM_BASE::GetSettingsManager(), m_board, Pgm(), FILEEXT::ProjectFileExtension, BOARD_LOADER::SaveBoard(), and SETTINGS_MANAGER::SaveProjectAs().

SetContentModified()

void HEADLESS_PCB_CONTEXT::SetContentModified ( bool aModified = true )

inlineoverridevirtual

Implements PCB_CONTEXT.

Definition at line 59 of file headless_pcb_context.h.

References m_contentModified.

Member Data Documentation

m_board

std::unique_ptr<BOARD> HEADLESS_PCB_CONTEXT::m_board

private

Definition at line 74 of file headless_pcb_context.h.

Referenced by GetBoard(), GetCurrentFileName(), HEADLESS_PCB_CONTEXT(), RevertToSaved(), SaveBoard(), SavePcbCopy(), and ~HEADLESS_PCB_CONTEXT().

m_contentModified

bool HEADLESS_PCB_CONTEXT::m_contentModified = false

private

Definition at line 81 of file headless_pcb_context.h.

Referenced by IsContentModified(), RevertToSaved(), SaveBoard(), and SetContentModified().

m_kiway

KIWAY* HEADLESS_PCB_CONTEXT::m_kiway

private

Definition at line 76 of file headless_pcb_context.h.

Referenced by GetKiway(), and HEADLESS_PCB_CONTEXT().

m_project

PROJECT* HEADLESS_PCB_CONTEXT::m_project

private

Definition at line 75 of file headless_pcb_context.h.

Referenced by HEADLESS_PCB_CONTEXT(), Prj(), and RevertToSaved().

m_toolManager

std::unique_ptr<TOOL_MANAGER> HEADLESS_PCB_CONTEXT::m_toolManager

private

Definition at line 77 of file headless_pcb_context.h.

Referenced by GetToolManager(), HEADLESS_PCB_CONTEXT(), OnNetlistChanged(), and RevertToSaved().

---

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

• headless_pcb_context.h
• headless_pcb_context.cpp