CYCLUS
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
Json::Value Class Reference

Detailed Description

Represents a JSON value.

This class is a discriminated union wrapper that can represents a:

The type of the held value is represented by a ValueType and can be obtained using type().

values of an objectValue or arrayValue can be accessed using operator[]() methods. Non const methods will automatically create the a nullValue element if it does not exist. The sequence of an arrayValue will be automatically resize and initialized with nullValue. resize() can be used to enlarge or truncate an arrayValue.

The get() methods can be used to obtanis default value in the case the required element does not exist.

It is possible to iterate over the list of a objectValue values using the getMemberNames() method.

Definition at line 3224 of file pyne.h.

#include <pyne.h>

Public Types

typedef Json::ArrayIndex ArrayIndex
 
typedef ValueConstIterator const_iterator
 
typedef Json::Int Int
 
typedef Json::Int64 Int64
 
typedef ValueIterator iterator
 
typedef Json::LargestInt LargestInt
 
typedef Json::LargestUInt LargestUInt
 
typedef std::vector< std::string > Members
 
typedef std::map< CZString, ValueObjectValues
 
typedef Json::UInt UInt
 
typedef Json::UInt64 UInt64
 

Public Member Functions

Valueappend (const Value &value)
 
bool asBool () const
 
const char * asCString () const
 
double asDouble () const
 
float asFloat () const
 
Int asInt () const
 
Int64 asInt64 () const
 
LargestInt asLargestInt () const
 
LargestUInt asLargestUInt () const
 
std::string asString () const
 
UInt asUInt () const
 
UInt64 asUInt64 () const
 
const_iterator begin () const
 
iterator begin ()
 
void clear ()
 
int compare (const Value &other) const
 
bool empty () const
 
const_iterator end () const
 
iterator end ()
 
Value get (ArrayIndex index, const Value &defaultValue) const
 
Value get (const char *key, const Value &defaultValue) const
 
Value get (const std::string &key, const Value &defaultValue) const
 
std::string getComment (CommentPlacement placement) const
 
Members getMemberNames () const
 
bool hasComment (CommentPlacement placement) const
 
bool isArray () const
 
bool isBool () const
 
bool isConvertibleTo (ValueType other) const
 
bool isDouble () const
 
bool isInt () const
 
bool isIntegral () const
 
bool isMember (const char *key) const
 
bool isMember (const std::string &key) const
 
bool isNull () const
 
bool isNumeric () const
 
bool isObject () const
 
bool isString () const
 
bool isUInt () const
 
bool isValidIndex (ArrayIndex index) const
 
bool operator! () const
 
bool operator!= (const Value &other) const
 
bool operator< (const Value &other) const
 
bool operator<= (const Value &other) const
 
Valueoperator= (const Value &other)
 
bool operator== (const Value &other) const
 
bool operator> (const Value &other) const
 
bool operator>= (const Value &other) const
 
Valueoperator[] (ArrayIndex index)
 
Valueoperator[] (int index)
 
const Valueoperator[] (ArrayIndex index) const
 
const Valueoperator[] (int index) const
 
Valueoperator[] (const char *key)
 
const Valueoperator[] (const char *key) const
 
Valueoperator[] (const std::string &key)
 
const Valueoperator[] (const std::string &key) const
 
Valueoperator[] (const StaticString &key)
 
Value removeMember (const char *key)
 
Value removeMember (const std::string &key)
 
void resize (ArrayIndex size)
 
void setComment (const char *comment, CommentPlacement placement)
 
void setComment (const std::string &comment, CommentPlacement placement)
 
ArrayIndex size () const
 
void swap (Value &other)
 
std::string toStyledString () const
 
ValueType type () const
 
 Value (ValueType type=nullValue)
 
 Value (Int value)
 
 Value (UInt value)
 
 Value (Int64 value)
 
 Value (UInt64 value)
 
 Value (double value)
 
 Value (const char *value)
 
 Value (const char *beginValue, const char *endValue)
 
 Value (const StaticString &value)
 
 Value (const std::string &value)
 
 Value (bool value)
 
 Value (const Value &other)
 
 ~Value ()
 

Static Public Attributes

static const Int maxInt = Int( UInt(-1)/2 )
 
static const Int64 maxInt64 = Int64( UInt64(-1)/2 )
 
static const LargestInt maxLargestInt = LargestInt( LargestUInt(-1)/2 )
 
static const LargestUInt maxLargestUInt = LargestUInt(-1)
 
static const UInt maxUInt = UInt(-1)
 
static const UInt64 maxUInt64 = UInt64(-1)
 
static const Int minInt = Int( ~(UInt(-1)/2) )
 
static const Int64 minInt64 = Int64( ~(UInt64(-1)/2) )
 
static const LargestInt minLargestInt = LargestInt( ~(LargestUInt(-1)/2) )
 
static const Value null
 

Member Typedef Documentation

Definition at line 3243 of file pyne.h.

Definition at line 3234 of file pyne.h.

Definition at line 3236 of file pyne.h.

Definition at line 3239 of file pyne.h.

Definition at line 3233 of file pyne.h.

Definition at line 3241 of file pyne.h.

Definition at line 3242 of file pyne.h.

typedef std::vector<std::string> Json::Value::Members

Definition at line 3232 of file pyne.h.

typedef std::map<CZString, Value> Json::Value::ObjectValues

Definition at line 3297 of file pyne.h.

Definition at line 3235 of file pyne.h.

Definition at line 3238 of file pyne.h.

Constructor & Destructor Documentation

Json::Value::Value ( ValueType  type = nullValue)

Create a default Value of the given type.

This is a very useful constructor. To create an empty array, pass arrayValue. To create an empty object, pass objectValue. Another Value can then be set to this one by assignment. This is useful since clear() and resize() will not alter types.

Examples:
Json::Value null_value; // null
Json::Value arr_value(Json::arrayValue); // []
Json::Value obj_value(Json::objectValue); // {}

Default constructor initialization must be equivalent to: memset( this, 0, sizeof(Value) ) This optimization is used in ValueInternalMap fast allocator.

Definition at line 14604 of file pyne.cc.

Json::Value::Value ( Int  value)

Definition at line 14658 of file pyne.cc.

Json::Value::Value ( UInt  value)

Definition at line 14648 of file pyne.cc.

Json::Value::Value ( Int64  value)

Definition at line 14671 of file pyne.cc.

Json::Value::Value ( UInt64  value)

Definition at line 14682 of file pyne.cc.

Json::Value::Value ( double  value)

Definition at line 14692 of file pyne.cc.

Json::Value::Value ( const char *  value)

Definition at line 14702 of file pyne.cc.

Json::Value::Value ( const char *  beginValue,
const char *  endValue 
)

Definition at line 14714 of file pyne.cc.

Json::Value::Value ( const StaticString value)

Constructs a value from a static string.

Like other value string constructor but do not duplicate the string for internal storage. The given string must remain alive after the call to this constructor. Example of usage:

Json::Value aValue( StaticString("some text") );

Definition at line 14741 of file pyne.cc.

Json::Value::Value ( const std::string &  value)

Definition at line 14728 of file pyne.cc.

Json::Value::Value ( bool  value)

Definition at line 14766 of file pyne.cc.

Json::Value::Value ( const Value other)

Definition at line 14777 of file pyne.cc.

Json::Value::~Value ( )

Definition at line 14827 of file pyne.cc.

Member Function Documentation

Value & Json::Value::append ( const Value value)

Append value to array at the end.

Equivalent to jsonvalue[jsonvalue.size()] = value;

Definition at line 15536 of file pyne.cc.

bool Json::Value::asBool ( ) const

Definition at line 15221 of file pyne.cc.

const char * Json::Value::asCString ( ) const

Definition at line 14999 of file pyne.cc.

double Json::Value::asDouble ( ) const

Definition at line 15167 of file pyne.cc.

float Json::Value::asFloat ( ) const

Definition at line 15194 of file pyne.cc.

Value::Int Json::Value::asInt ( ) const

Definition at line 15036 of file pyne.cc.

Value::Int64 Json::Value::asInt64 ( ) const

Definition at line 15094 of file pyne.cc.

LargestInt Json::Value::asLargestInt ( ) const

Definition at line 15147 of file pyne.cc.

LargestUInt Json::Value::asLargestUInt ( ) const

Definition at line 15157 of file pyne.cc.

std::string Json::Value::asString ( ) const

Definition at line 15006 of file pyne.cc.

Value::UInt Json::Value::asUInt ( ) const

Definition at line 15064 of file pyne.cc.

Value::UInt64 Json::Value::asUInt64 ( ) const

Definition at line 15120 of file pyne.cc.

Value::const_iterator Json::Value::begin ( ) const

Definition at line 15761 of file pyne.cc.

Value::iterator Json::Value::begin ( )

Definition at line 15824 of file pyne.cc.

void Json::Value::clear ( )

Remove all object members and array elements.

Precondition
type() is arrayValue, objectValue, or nullValue
Postcondition
type() is unchanged

Definition at line 15343 of file pyne.cc.

int Json::Value::compare ( const Value other) const

Definition at line 14885 of file pyne.cc.

bool Json::Value::empty ( ) const

Return true if empty array, empty object, or null; otherwise, false.

Definition at line 15328 of file pyne.cc.

Value::const_iterator Json::Value::end ( ) const

Definition at line 15792 of file pyne.cc.

Value::iterator Json::Value::end ( )

Definition at line 15855 of file pyne.cc.

Value Json::Value::get ( ArrayIndex  index,
const Value defaultValue 
) const

If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue.

Definition at line 15472 of file pyne.cc.

Value Json::Value::get ( const char *  key,
const Value defaultValue 
) const

Return the member named key if it exist, defaultValue otherwise.

Definition at line 15542 of file pyne.cc.

Value Json::Value::get ( const std::string &  key,
const Value defaultValue 
) const

Return the member named key if it exist, defaultValue otherwise.

Definition at line 15550 of file pyne.cc.

std::string Json::Value::getComment ( CommentPlacement  placement) const

Include delimiters and embedded newlines.

Definition at line 15746 of file pyne.cc.

Value::Members Json::Value::getMemberNames ( ) const

Return a list of the member names.

If null, return an empty list.

Precondition
type() is objectValue or nullValue
Postcondition
if type() was nullValue, it remains nullValue

Definition at line 15614 of file pyne.cc.

bool Json::Value::hasComment ( CommentPlacement  placement) const

Definition at line 15741 of file pyne.cc.

bool Json::Value::isArray ( ) const

Definition at line 15713 of file pyne.cc.

bool Json::Value::isBool ( ) const

Definition at line 15669 of file pyne.cc.

bool Json::Value::isConvertibleTo ( ValueType  other) const

Definition at line 15245 of file pyne.cc.

bool Json::Value::isDouble ( ) const

Definition at line 15695 of file pyne.cc.

bool Json::Value::isInt ( ) const

Definition at line 15675 of file pyne.cc.

bool Json::Value::isIntegral ( ) const

Definition at line 15687 of file pyne.cc.

bool Json::Value::isMember ( const char *  key) const

Return true if the object has a member named key.

Definition at line 15594 of file pyne.cc.

bool Json::Value::isMember ( const std::string &  key) const

Return true if the object has a member named key.

Definition at line 15601 of file pyne.cc.

bool Json::Value::isNull ( ) const

Definition at line 15663 of file pyne.cc.

bool Json::Value::isNumeric ( ) const

Definition at line 15701 of file pyne.cc.

bool Json::Value::isObject ( ) const

Definition at line 15719 of file pyne.cc.

bool Json::Value::isString ( ) const

Definition at line 15707 of file pyne.cc.

bool Json::Value::isUInt ( ) const

Definition at line 15681 of file pyne.cc.

bool Json::Value::isValidIndex ( ArrayIndex  index) const

Return true if index < size().

Definition at line 15480 of file pyne.cc.

bool Json::Value::operator! ( ) const

Return isNull()

Definition at line 15337 of file pyne.cc.

bool Json::Value::operator!= ( const Value other) const

Definition at line 14993 of file pyne.cc.

bool Json::Value::operator< ( const Value other) const

Definition at line 14895 of file pyne.cc.

bool Json::Value::operator<= ( const Value other) const

Definition at line 14936 of file pyne.cc.

Value & Json::Value::operator= ( const Value other)

Definition at line 14861 of file pyne.cc.

bool Json::Value::operator== ( const Value other) const

Definition at line 14951 of file pyne.cc.

bool Json::Value::operator> ( const Value other) const

Definition at line 14946 of file pyne.cc.

bool Json::Value::operator>= ( const Value other) const

Definition at line 14941 of file pyne.cc.

Value & Json::Value::operator[] ( ArrayIndex  index)

Access an array element (zero based index ).

If the array contains less than index element, then null value are inserted in the array so that its size is index+1. (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

Definition at line 15391 of file pyne.cc.

Value & Json::Value::operator[] ( int  index)

Access an array element (zero based index ).

If the array contains less than index element, then null value are inserted in the array so that its size is index+1. (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

Definition at line 15411 of file pyne.cc.

const Value & Json::Value::operator[] ( ArrayIndex  index) const

Access an array element (zero based index ) (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

Definition at line 15418 of file pyne.cc.

const Value & Json::Value::operator[] ( int  index) const

Access an array element (zero based index ) (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

Definition at line 15436 of file pyne.cc.

Value & Json::Value::operator[] ( const char *  key)

Access an object value by name, create a null member if it does not exist.

Definition at line 15443 of file pyne.cc.

const Value & Json::Value::operator[] ( const char *  key) const

Access an object value by name, returns null if there is no member with that name.

Definition at line 15487 of file pyne.cc.

Value & Json::Value::operator[] ( const std::string &  key)

Access an object value by name, create a null member if it does not exist.

Definition at line 15505 of file pyne.cc.

const Value & Json::Value::operator[] ( const std::string &  key) const

Access an object value by name, returns null if there is no member with that name.

Definition at line 15511 of file pyne.cc.

Value & Json::Value::operator[] ( const StaticString key)

Access an object value by name, create a null member if it does not exist.

If the object as no entry for that name, then the member name used to store the new entry is not duplicated. Example of use:

Json::Value object;
static const StaticString code("code");
object[code] = 1234;

Definition at line 15516 of file pyne.cc.

Value Json::Value::removeMember ( const char *  key)

Remove and return the named member.

Do nothing if it did not exist.

Returns
the removed Value, or null.
Precondition
type() is objectValue or nullValue
Postcondition
type() is unchanged

Definition at line 15556 of file pyne.cc.

Value Json::Value::removeMember ( const std::string &  key)

Same as removeMember(const char*)

Definition at line 15581 of file pyne.cc.

void Json::Value::resize ( ArrayIndex  size)

Resize the array to size elements.

New elements are initialized to null. May only be called on nullValue or arrayValue.

Precondition
type() is arrayValue or nullValue
Postcondition
type() is arrayValue

Definition at line 15367 of file pyne.cc.

void Json::Value::setComment ( const char *  comment,
CommentPlacement  placement 
)

Comments must be //... or /* ... */.

Definition at line 15725 of file pyne.cc.

void Json::Value::setComment ( const std::string &  comment,
CommentPlacement  placement 
)

Comments must be //... or /* ... */.

Definition at line 15734 of file pyne.cc.

ArrayIndex Json::Value::size ( ) const

Number of values in array or object.

Definition at line 15295 of file pyne.cc.

void Json::Value::swap ( Value other)

Swap values.

Note
Currently, comments are intentionally not swapped, for both logic and efficiency.

Definition at line 14868 of file pyne.cc.

std::string Json::Value::toStyledString ( ) const

Definition at line 15754 of file pyne.cc.

ValueType Json::Value::type ( ) const

Definition at line 14879 of file pyne.cc.

Member Data Documentation

const Int Json::Value::maxInt = Int( UInt(-1)/2 )
static

Maximum signed int value that can be stored in a Json::Value.

Definition at line 3256 of file pyne.h.

const Int64 Json::Value::maxInt64 = Int64( UInt64(-1)/2 )
static

Maximum signed 64 bits int value that can be stored in a Json::Value.

Definition at line 3263 of file pyne.h.

const LargestInt Json::Value::maxLargestInt = LargestInt( LargestUInt(-1)/2 )
static

Maximum signed integer value that can be stored in a Json::Value.

Definition at line 3249 of file pyne.h.

const LargestUInt Json::Value::maxLargestUInt = LargestUInt(-1)
static

Maximum unsigned integer value that can be stored in a Json::Value.

Definition at line 3251 of file pyne.h.

const UInt Json::Value::maxUInt = UInt(-1)
static

Maximum unsigned int value that can be stored in a Json::Value.

Definition at line 3258 of file pyne.h.

const UInt64 Json::Value::maxUInt64 = UInt64(-1)
static

Maximum unsigned 64 bits int value that can be stored in a Json::Value.

Definition at line 3265 of file pyne.h.

const Int Json::Value::minInt = Int( ~(UInt(-1)/2) )
static

Minimum signed int value that can be stored in a Json::Value.

Definition at line 3254 of file pyne.h.

const Int64 Json::Value::minInt64 = Int64( ~(UInt64(-1)/2) )
static

Minimum signed 64 bits int value that can be stored in a Json::Value.

Definition at line 3261 of file pyne.h.

const LargestInt Json::Value::minLargestInt = LargestInt( ~(LargestUInt(-1)/2) )
static

Minimum signed integer value that can be stored in a Json::Value.

Definition at line 3247 of file pyne.h.

const Value Json::Value::null
static

Definition at line 3245 of file pyne.h.


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