HEADLESS_BOARD_CONTEXT Class Reference

#include <headless_board_context.h>

Inheritance diagram for HEADLESS_BOARD_CONTEXT:

Public Member Functions
	HEADLESS_BOARD_CONTEXT (std::unique_ptr< BOARD > aBoard, PROJECT *aProject, APP_SETTINGS_BASE *aSettings, KIWAY *aKiway=nullptr)
	~HEADLESS_BOARD_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	SaveBoard () override
bool	SavePcbCopy (const wxString &aFileName, bool aCreateProject, bool aHeadless) override

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

Detailed Description

Definition at line 37 of file headless_board_context.h.

Constructor & Destructor Documentation

HEADLESS_BOARD_CONTEXT()

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

Definition at line 30 of file headless_board_context.cpp.

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

~HEADLESS_BOARD_CONTEXT()

HEADLESS_BOARD_CONTEXT::~HEADLESS_BOARD_CONTEXT ( )

overridedefault

Member Function Documentation

CanAcceptApiCommands()

bool HEADLESS_BOARD_CONTEXT::CanAcceptApiCommands ( ) const

inlineoverridevirtual

Implements BOARD_CONTEXT.

Definition at line 55 of file headless_board_context.h.

Referenced by BOOST_FIXTURE_TEST_CASE().

GetBoard()

BOARD * HEADLESS_BOARD_CONTEXT::GetBoard ( ) const

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 49 of file headless_board_context.cpp.

References m_board.

Referenced by BOOST_FIXTURE_TEST_CASE().

GetCurrentFileName()

wxString HEADLESS_BOARD_CONTEXT::GetCurrentFileName ( ) const

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 69 of file headless_board_context.cpp.

References m_board.

Referenced by BOOST_FIXTURE_TEST_CASE().

GetKiway()

KIWAY * HEADLESS_BOARD_CONTEXT::GetKiway ( ) const

inlineoverridevirtual

Implements BOARD_CONTEXT.

Definition at line 51 of file headless_board_context.h.

References m_kiway.

GetToolManager()

TOOL_MANAGER * HEADLESS_BOARD_CONTEXT::GetToolManager ( ) const

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 63 of file headless_board_context.cpp.

References m_toolManager.

Referenced by BOOST_FIXTURE_TEST_CASE().

Prj()

PROJECT & HEADLESS_BOARD_CONTEXT::Prj ( ) const

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 55 of file headless_board_context.cpp.

References m_project.

Referenced by BOOST_FIXTURE_TEST_CASE().

SaveBoard()

bool HEADLESS_BOARD_CONTEXT::SaveBoard ( )

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 78 of file headless_board_context.cpp.

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

SavePcbCopy()

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

overridevirtual

Implements BOARD_CONTEXT.

Definition at line 103 of file headless_board_context.cpp.

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

Member Data Documentation

m_board

std::unique_ptr<BOARD> HEADLESS_BOARD_CONTEXT::m_board

private

Definition at line 62 of file headless_board_context.h.

Referenced by GetBoard(), GetCurrentFileName(), HEADLESS_BOARD_CONTEXT(), SaveBoard(), and SavePcbCopy().

m_kiway

KIWAY* HEADLESS_BOARD_CONTEXT::m_kiway

private

Definition at line 64 of file headless_board_context.h.

Referenced by GetKiway(), and HEADLESS_BOARD_CONTEXT().

m_project

PROJECT* HEADLESS_BOARD_CONTEXT::m_project

private

Definition at line 63 of file headless_board_context.h.

Referenced by HEADLESS_BOARD_CONTEXT(), and Prj().

m_toolManager

std::unique_ptr<TOOL_MANAGER> HEADLESS_BOARD_CONTEXT::m_toolManager

private

Definition at line 65 of file headless_board_context.h.

Referenced by GetToolManager(), and HEADLESS_BOARD_CONTEXT().

---

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

• headless_board_context.h
• headless_board_context.cpp