PARAM_VIEWPORT Class Reference

#include <board_project_settings.h>

Inheritance diagram for PARAM_VIEWPORT:

Public Member Functions
	PARAM_VIEWPORT (const std::string &aPath, std::vector< VIEWPORT > *aViewportList)
void	Load (JSON_SETTINGS *aSettings, bool aResetIfMissing=true) const override
	Loads the value of this parameter from JSON to the underlying storage. More...
void	Store (JSON_SETTINGS *aSettings) const override
	Stores the value of this parameter to the given JSON_SETTINGS object. More...
nlohmann::json	GetDefault () const
void	SetDefault () override
bool	MatchesFile (JSON_SETTINGS *aSettings) const override
	Checks whether the parameter in memory matches the one in a given JSON file. More...
const std::string &	GetJsonPath () const

Protected Attributes
std::string	m_path
	the string used to store the param in json files More...
bool	m_readOnly
	! True if the parameter pointer should never be overwritten More...

Private Member Functions
nlohmann::json	viewportsToJson ()
void	jsonToViewports (const nlohmann::json &aJson)

Private Attributes
std::vector< VIEWPORT > *	m_viewports
nlohmann::json	m_default
std::function< nlohmann::json()>	m_getter
std::function< void(nlohmann::json)>	m_setter

Detailed Description

Definition at line 203 of file board_project_settings.h.

Constructor & Destructor Documentation

PARAM_VIEWPORT()

PARAM_VIEWPORT::PARAM_VIEWPORT	(	const std::string &	aPath,
		std::vector< VIEWPORT > *	aViewportList
	)

Definition at line 133 of file board_project_settings.cpp.

Member Function Documentation

GetDefault()

nlohmann::json PARAM_LAMBDA< nlohmann::json >::GetDefault ( ) const

inlineinherited

Definition at line 306 of file parameters.h.

GetJsonPath()

const std::string & PARAM_BASE::GetJsonPath ( ) const

inlineinherited

Returns

the path name of the parameter used to store it in the json file mainly useful in error messages

Definition at line 69 of file parameters.h.

References PARAM_BASE::m_path.

jsonToViewports()

void PARAM_VIEWPORT::jsonToViewports ( const nlohmann::json &  aJson )

private

Definition at line 165 of file board_project_settings.cpp.

References m_viewports, VIEWPORT::rect, BOX2< Vec >::SetHeight(), BOX2< Vec >::SetWidth(), BOX2< Vec >::SetX(), and BOX2< Vec >::SetY().

Load()

void PARAM_LAMBDA< nlohmann::json >::Load ( JSON_SETTINGS *  aSettings, bool  aResetIfMissing = true  ) const

overridevirtualinherited

Loads the value of this parameter from JSON to the underlying storage.

Parameters

aSettings	is the JSON_SETTINGS object to load from.
aResetIfMissing	if true will set the parameter to its default value if load fails

Implements PARAM_BASE.

Definition at line 293 of file parameters.cpp.

MatchesFile()

bool PARAM_LAMBDA< nlohmann::json >::MatchesFile ( JSON_SETTINGS *  aSettings ) const

overridevirtualinherited

Checks whether the parameter in memory matches the one in a given JSON file.

Parameters

aSettings

is a JSON_SETTINGS to check the JSON file contents of

Returns

true if the parameter in memory matches its value in the file

Implements PARAM_BASE.

Definition at line 316 of file parameters.cpp.

SetDefault()

void PARAM_LAMBDA< nlohmann::json >::SetDefault ( )

inlineoverridevirtualinherited

Implements PARAM_BASE.

Definition at line 311 of file parameters.h.

Store()

void PARAM_LAMBDA< nlohmann::json >::Store ( JSON_SETTINGS *  aSettings ) const

inlineoverridevirtualinherited

Stores the value of this parameter to the given JSON_SETTINGS object.

Parameters

aSettings

is the JSON_SETTINGS object to store into.

Implements PARAM_BASE.

Definition at line 295 of file parameters.h.

viewportsToJson()

nlohmann::json PARAM_VIEWPORT::viewportsToJson ( )

private

Definition at line 144 of file board_project_settings.cpp.

References m_viewports.

Member Data Documentation

m_default

nlohmann::json PARAM_LAMBDA< nlohmann::json >::m_default

privateinherited

Definition at line 319 of file parameters.h.

m_getter

std::function<nlohmann::json ()> PARAM_LAMBDA< nlohmann::json >::m_getter

privateinherited

Definition at line 321 of file parameters.h.

m_path

std::string PARAM_BASE::m_path

protectedinherited

the string used to store the param in json files

Definition at line 75 of file parameters.h.

Referenced by PARAM_BASE::GetJsonPath(), COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_SCALED< ValueType >::Load(), COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), and PARAM_PATH_LIST::Store().

m_readOnly

bool PARAM_BASE::m_readOnly

protectedinherited

! True if the parameter pointer should never be overwritten

Definition at line 78 of file parameters.h.

Referenced by COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_PATH::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_SCALED< ValueType >::Load(), and PARAM_PATH_LIST::Load().

m_setter

std::function<void( nlohmann::json )> PARAM_LAMBDA< nlohmann::json >::m_setter

privateinherited

Definition at line 323 of file parameters.h.

m_viewports

std::vector<VIEWPORT>* PARAM_VIEWPORT::m_viewports

private

Definition at line 213 of file board_project_settings.h.

Referenced by jsonToViewports(), and viewportsToJson().

---

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

• board_project_settings.h
• board_project_settings.cpp