A helper that contains logic to assist in dumping boards to disk depending on some environment variables. More...

#include <board_test_utils.h>

Public Member Functions
	BOARD_DUMPER ()

void	DumpBoardToFile (BOARD &aBoard, const std::string &aName) const

Public Attributes
const bool	m_dump_boards

Detailed Description

A helper that contains logic to assist in dumping boards to disk depending on some environment variables.

This is useful when setting up or verifying unit tests that work on BOARD objects.

To dump files set the KICAD_TEST_DUMP_BOARD_FILES environment variable. Files will be written to the system temp directory (/tmp on Linux, or as set by $TMP and friends).

Definition at line 76 of file board_test_utils.h.

Constructor & Destructor Documentation

◆ BOARD_DUMPER()

KI_TEST::BOARD_DUMPER::BOARD_DUMPER ( )

Definition at line 52 of file board_test_utils.cpp.

Member Function Documentation

◆ DumpBoardToFile()

void KI_TEST::BOARD_DUMPER::DumpBoardToFile	(	BOARD &	aBoard,
		const std::string &	aName
	)		const

Definition at line 58 of file board_test_utils.cpp.

References KI_TEST::DumpBoardToFile(), m_dump_boards, and path.

Referenced by DoCourtyardInvalidTest(), and DoCourtyardOverlapTest().

Member Data Documentation

◆ m_dump_boards

const bool KI_TEST::BOARD_DUMPER::m_dump_boards

Definition at line 83 of file board_test_utils.h.

Referenced by DumpBoardToFile().

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

Public Member Functions