dmlc::JSONObjectReadHelper Class Reference

Helper class to read JSON into a class or struct object. More...

#include <json.h>

Public Member Functions
template<typename T >
void	DeclareField (const std::string &key, T *addr)
	Declare field of type T.
template<typename T >
void	DeclareOptionalField (const std::string &key, T *addr)
	Declare optional field of type T.
void	ReadAllFields (JSONReader *reader)
	Read in all the declared fields.

Detailed Description

Helper class to read JSON into a class or struct object.

struct Param {
  std::string name;
  int value;
  // define load function from JSON
  inline void Load(dmlc::JSONReader *reader) {
    dmlc::JSONStructReadHelper helper;
    helper.DeclareField("name", &name);
    helper.DeclareField("value", &value);
    helper.ReadAllFields(reader);
  }
};

Member Function Documentation

DeclareField()

template<typename T >

void dmlc::JSONObjectReadHelper::DeclareField ( const std::string &  key, T *  addr  )

inline

Declare field of type T.

Parameters

key	the key of the of field.
addr	address of the data type.

Template Parameters

T	the data type to be read, must be STL composition of JSON serializable.

DeclareOptionalField()

template<typename T >

void dmlc::JSONObjectReadHelper::DeclareOptionalField ( const std::string &  key, T *  addr  )

inline

Declare optional field of type T.

Parameters

key	the key of the of field.
addr	address of the data type.

Template Parameters

T	the data type to be read, must be STL composition of JSON serializable.

ReadAllFields()

void dmlc::JSONObjectReadHelper::ReadAllFields ( JSONReader *  reader )

inline

Read in all the declared fields.

Parameters

reader

the JSONReader to read the json.

---

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

• External/xgboost/dmlc-core/include/dmlc/json.h