JSON_SETTINGS_INTERNALS Class Reference

#include <json_settings_internals.h>

Inheritance diagram for JSON_SETTINGS_INTERNALS:

Public Member Functions
	JSON_SETTINGS_INTERNALS ()
template<typename ValueType >
void	SetFromString (const std::string &aPath, ValueType aVal)
template<typename ValueType >
ValueType	Get (const std::string &aPath) const
nlohmann::json &	At (const std::string &aPath)
nlohmann::json &	operator[] (const nlohmann::json::json_pointer &aPointer)
nlohmann::json &	operator[] (const std::string &aPath)
void	CloneFrom (const JSON_SETTINGS_INTERNALS &aOther)

Static Public Member Functions
static nlohmann::json::json_pointer	PointerFromString (std::string aPath)
	Builds a JSON pointer based on a given string. More...

Friends
class	JSON_SETTINGS

Detailed Description

Definition at line 27 of file json_settings_internals.h.

Constructor & Destructor Documentation

JSON_SETTINGS_INTERNALS()

JSON_SETTINGS_INTERNALS::JSON_SETTINGS_INTERNALS ( )

inline

Definition at line 32 of file json_settings_internals.h.

 :
 nlohmann::json()
 {}

Member Function Documentation

At()

nlohmann::json& JSON_SETTINGS_INTERNALS::At ( const std::string &  aPath )

inline

Definition at line 56 of file json_settings_internals.h.

 {
 return at( PointerFromString( aPath ) );
 }

References PointerFromString().

CloneFrom()

void JSON_SETTINGS_INTERNALS::CloneFrom ( const JSON_SETTINGS_INTERNALS &  aOther )

inline

Definition at line 71 of file json_settings_internals.h.

 {
 nlohmann::json::json_pointer root( "" );
 this->nlohmann::json::operator[]( root ) = aOther.nlohmann::json::operator[]( root );
 }

Get()

template<typename ValueType >

ValueType JSON_SETTINGS_INTERNALS::Get ( const std::string &  aPath ) const

inline

Definition at line 51 of file json_settings_internals.h.

 {
 return at( PointerFromString( aPath ) ).get<ValueType>();
 }

References PointerFromString().

operator[]() [1/2]

nlohmann::json& JSON_SETTINGS_INTERNALS::operator[] ( const nlohmann::json::json_pointer &  aPointer )

inline

Definition at line 61 of file json_settings_internals.h.

 {
 return nlohmann::json::operator[]( aPointer );
 }

operator[]() [2/2]

nlohmann::json& JSON_SETTINGS_INTERNALS::operator[] ( const std::string &  aPath )

inline

Definition at line 66 of file json_settings_internals.h.

 {
 return nlohmann::json::operator[]( PointerFromString( aPath ) );
 }

References PointerFromString().

PointerFromString()

nlohmann::json::json_pointer JSON_SETTINGS_INTERNALS::PointerFromString ( std::string  aPath )

static

Builds a JSON pointer based on a given string.

Parameters

aPath

is the path in the form "key1.key2.key3"

Returns

a JSON pointer that can be used to index into a JSON object

Definition at line 44 of file json_settings.cpp.

{
 std::replace( aPath.begin(), aPath.end(), '.', '/' );
 aPath.insert( 0, "/" );

 nlohmann::json::json_pointer p;

 try
 {
 p = nlohmann::json::json_pointer( aPath );
 }
 catch( ... )
 {
 wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
 }

 return p;
}

Referenced by At(), JSON_SETTINGS::Contains(), JSON_SETTINGS::Count(), Get(), BOARD_DESIGN_SETTINGS::LoadFromFile(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), operator[](), and JSON_SETTINGS::SetIfPresent().

SetFromString()

template<typename ValueType >

void JSON_SETTINGS_INTERNALS::SetFromString ( const std::string &  aPath, ValueType  aVal  )

inline

Definition at line 44 of file json_settings_internals.h.

 {
 // Calls the overload below, which will convert from dotted string to JSON pointer
 ( *this )[aPath] = aVal;
 }

Friends And Related Function Documentation

JSON_SETTINGS

friend class JSON_SETTINGS

friend

Definition at line 29 of file json_settings_internals.h.

---

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

• json_settings_internals.h
• json_settings.cpp