project_file.h File Reference

#include <common.h>
#include <kiid.h>
#include <project/board_project_settings.h>
#include <settings/json_settings.h>
#include <settings/nested_settings.h>

Go to the source code of this file.

Classes
struct	TOP_LEVEL_SHEET_INFO
	Information about a top-level schematic sheet. More...
class	PROJECT_FILE
	The backing store for a PROJECT, in JSON format. More...

Typedefs
typedef std::pair< KIID, wxString >	FILE_INFO_PAIR
	For files like sheets and boards, a pair of that object KIID and display name Display name is typically blank for the project root sheet.

Enumerations
enum	LAST_PATH_TYPE : unsigned int {   LAST_PATH_FIRST = 0 , LAST_PATH_NETLIST = LAST_PATH_FIRST , LAST_PATH_IDF , LAST_PATH_VRML ,   LAST_PATH_SPECCTRADSN , LAST_PATH_PLOT , LAST_PATH_SIZE }
	For storing PcbNew MRU paths of various types. More...

Functions
void	to_json (nlohmann::json &aJson, const FILE_INFO_PAIR &aPair)
void	from_json (const nlohmann::json &aJson, FILE_INFO_PAIR &aPair)
void	to_json (nlohmann::json &aJson, const TOP_LEVEL_SHEET_INFO &aInfo)
void	from_json (const nlohmann::json &aJson, TOP_LEVEL_SHEET_INFO &aInfo)

Typedef Documentation

FILE_INFO_PAIR

typedef std::pair<KIID, wxString> FILE_INFO_PAIR

For files like sheets and boards, a pair of that object KIID and display name Display name is typically blank for the project root sheet.

Definition at line 44 of file project_file.h.

Enumeration Type Documentation

LAST_PATH_TYPE

enum LAST_PATH_TYPE : unsigned int

For storing PcbNew MRU paths of various types.

Enumerator
LAST_PATH_FIRST
LAST_PATH_NETLIST
LAST_PATH_IDF
LAST_PATH_VRML
LAST_PATH_SPECCTRADSN
LAST_PATH_PLOT
LAST_PATH_SIZE

Definition at line 75 of file project_file.h.

Function Documentation

from_json() [1/2]

void from_json	(	const nlohmann::json &	aJson,
		FILE_INFO_PAIR &	aPair )

Definition at line 789 of file project_file.cpp.

from_json() [2/2]

void from_json	(	const nlohmann::json &	aJson,
		TOP_LEVEL_SHEET_INFO &	aInfo )

Definition at line 806 of file project_file.cpp.

References TOP_LEVEL_SHEET_INFO::filename, TOP_LEVEL_SHEET_INFO::name, and TOP_LEVEL_SHEET_INFO::uuid.

to_json() [1/2]

void to_json	(	nlohmann::json &	aJson,
		const FILE_INFO_PAIR &	aPair )

Definition at line 783 of file project_file.cpp.

to_json() [2/2]

void to_json	(	nlohmann::json &	aJson,
		const TOP_LEVEL_SHEET_INFO &	aInfo )

Definition at line 797 of file project_file.cpp.

References KIID::AsString(), TOP_LEVEL_SHEET_INFO::filename, TOP_LEVEL_SHEET_INFO::name, and TOP_LEVEL_SHEET_INFO::uuid.