CYCLUS
Classes | Public Types | Public Member Functions | List of all members
Json::Reader Class Reference

Detailed Description

Unserialize a JSON document into a Value.

Definition at line 4246 of file pyne.h.

#include <pyne.h>

Public Types

typedef char Char
 
typedef const CharLocation
 

Public Member Functions

std::string getFormatedErrorMessages () const
 
std::string getFormattedErrorMessages () const
 
bool parse (const std::string &document, Value &root, bool collectComments=true)
 
bool parse (const char *beginDoc, const char *endDoc, Value &root, bool collectComments=true)
 
bool parse (std::istream &is, Value &root, bool collectComments=true)
 
 Reader ()
 
 Reader (const Features &features)
 

Member Typedef Documentation

◆ Char

typedef char Json::Reader::Char

Definition at line 4249 of file pyne.h.

◆ Location

typedef const Char* Json::Reader::Location

Definition at line 4250 of file pyne.h.

Constructor & Destructor Documentation

◆ Reader() [1/2]

Json::Reader::Reader ( )

Constructs a Reader allowing all features for parsing.

Definition at line 13239 of file pyne.cc.

◆ Reader() [2/2]

Json::Reader::Reader ( const Features features)

Constructs a Reader allowing the specified feature set for parsing.

Definition at line 13244 of file pyne.cc.

Member Function Documentation

◆ getFormatedErrorMessages()

std::string Json::Reader::getFormatedErrorMessages ( ) const

Returns a user friendly string that list errors in the parsed document.

Returns
Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing.
Deprecated:
Use getFormattedErrorMessages() instead (typo fix).

Definition at line 13924 of file pyne.cc.

◆ getFormattedErrorMessages()

std::string Json::Reader::getFormattedErrorMessages ( ) const

Returns a user friendly string that list errors in the parsed document.

Returns
Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing.

Definition at line 13930 of file pyne.cc.

◆ parse() [1/3]

bool Json::Reader::parse ( const std::string &  document,
Value root,
bool  collectComments = true 
)

Read a Value from a JSON document.

Parameters
documentUTF-8 encoded string containing the document to read.
root[out] Contains the root value of the document if it was successfully parsed.
collectCommentstrue to collect comment and allow writing them back during serialization, false to discard comments. This parameter is ignored if Features::allowComments_ is false.
Returns
true if the document was successfully parsed, false if an error occurred.

Definition at line 13250 of file pyne.cc.

◆ parse() [2/3]

bool Json::Reader::parse ( const char *  beginDoc,
const char *  endDoc,
Value root,
bool  collectComments = true 
)

Read a Value from a JSON document.

Parameters
beginDocPointer on the beginning of the UTF-8 encoded string of the document to read.
endDocPointer on the end of the UTF-8 encoded string of the document to read. \ Must be >= beginDoc.
root[out] Contains the root value of the document if it was successfully parsed.
collectCommentstrue to collect comment and allow writing them back during serialization, false to discard comments. This parameter is ignored if Features::allowComments_ is false.
Returns
true if the document was successfully parsed, false if an error occurred.

Definition at line 13277 of file pyne.cc.

◆ parse() [3/3]

bool Json::Reader::parse ( std::istream &  is,
Value root,
bool  collectComments = true 
)

Parse from input stream.

See also
Json::operator>>(std::istream&, Json::Value&).

Definition at line 13261 of file pyne.cc.


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