Medical Imaging Interaction Toolkit
2016.11.0
Medical Imaging Interaction Toolkit
|
Represents a JSON value. More...
#include <jsoncpp.h>
Public Types | |
typedef std::vector< std::string > | Members |
typedef ValueIterator | iterator |
typedef ValueConstIterator | const_iterator |
typedef Json::UInt | UInt |
typedef Json::Int | Int |
typedef Json::UInt64 | UInt64 |
typedef Json::Int64 | Int64 |
typedef Json::LargestInt | LargestInt |
typedef Json::LargestUInt | LargestUInt |
typedef Json::ArrayIndex | ArrayIndex |
typedef std::map< CZString, Value > | ObjectValues |
Public Member Functions | |
Value (ValueType type=nullValue) | |
Create a default Value of the given type. More... | |
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) | |
Constructs a value from a static string. More... | |
Value (const std::string &value) | |
Value (bool value) | |
Value (const Value &other) | |
~Value () | |
Value & | operator= (const Value &other) |
void | swap (Value &other) |
ValueType | type () const |
bool | operator< (const Value &other) const |
bool | operator<= (const Value &other) const |
bool | operator>= (const Value &other) const |
bool | operator> (const Value &other) const |
bool | operator== (const Value &other) const |
bool | operator!= (const Value &other) const |
int | compare (const Value &other) const |
const char * | asCString () const |
std::string | asString () const |
Int | asInt () const |
UInt | asUInt () const |
Int64 | asInt64 () const |
UInt64 | asUInt64 () const |
LargestInt | asLargestInt () const |
LargestUInt | asLargestUInt () const |
float | asFloat () const |
double | asDouble () const |
bool | asBool () const |
bool | isNull () const |
bool | isBool () const |
bool | isInt () const |
bool | isUInt () const |
bool | isIntegral () const |
bool | isDouble () const |
bool | isNumeric () const |
bool | isString () const |
bool | isArray () const |
bool | isObject () const |
bool | isConvertibleTo (ValueType other) const |
ArrayIndex | size () const |
Number of values in array or object. More... | |
bool | empty () const |
Return true if empty array, empty object, or null; otherwise, false. More... | |
bool | operator! () const |
Return isNull() More... | |
void | clear () |
void | resize (ArrayIndex size) |
Value & | operator[] (ArrayIndex index) |
Value & | operator[] (int index) |
const Value & | operator[] (ArrayIndex index) const |
const Value & | operator[] (int index) const |
Value | get (ArrayIndex index, const Value &defaultValue) const |
bool | isValidIndex (ArrayIndex index) const |
Return true if index < size(). More... | |
Value & | append (const Value &value) |
Append value to array at the end. More... | |
Value & | operator[] (const char *key) |
Access an object value by name, create a null member if it does not exist. More... | |
const Value & | operator[] (const char *key) const |
Access an object value by name, returns null if there is no member with that name. More... | |
Value & | operator[] (const std::string &key) |
Access an object value by name, create a null member if it does not exist. More... | |
const Value & | operator[] (const std::string &key) const |
Access an object value by name, returns null if there is no member with that name. More... | |
Value & | operator[] (const StaticString &key) |
Access an object value by name, create a null member if it does not exist. More... | |
Value | get (const char *key, const Value &defaultValue) const |
Return the member named key if it exist, defaultValue otherwise. More... | |
Value | get (const std::string &key, const Value &defaultValue) const |
Return the member named key if it exist, defaultValue otherwise. More... | |
Value | removeMember (const char *key) |
Remove and return the named member. More... | |
Value | removeMember (const std::string &key) |
Same as removeMember(const char*) More... | |
bool | isMember (const char *key) const |
Return true if the object has a member named key. More... | |
bool | isMember (const std::string &key) const |
Return true if the object has a member named key. More... | |
Members | getMemberNames () const |
Return a list of the member names. More... | |
void | setComment (const char *comment, CommentPlacement placement) |
Comments must be //... or /* ... */. More... | |
void | setComment (const std::string &comment, CommentPlacement placement) |
Comments must be //... or /* ... */. More... | |
bool | hasComment (CommentPlacement placement) const |
std::string | getComment (CommentPlacement placement) const |
Include delimiters and embedded newlines. More... | |
std::string | toStyledString () const |
const_iterator | begin () const |
const_iterator | end () const |
iterator | begin () |
iterator | end () |
Static Public Attributes | |
static const Value | null |
static const LargestInt | minLargestInt |
Minimum signed integer value that can be stored in a Json::Value. More... | |
static const LargestInt | maxLargestInt |
Maximum signed integer value that can be stored in a Json::Value. More... | |
static const LargestUInt | maxLargestUInt |
Maximum unsigned integer value that can be stored in a Json::Value. More... | |
static const Int | minInt |
Minimum signed int value that can be stored in a Json::Value. More... | |
static const Int | maxInt |
Maximum signed int value that can be stored in a Json::Value. More... | |
static const UInt | maxUInt |
Maximum unsigned int value that can be stored in a Json::Value. More... | |
static const Int64 | minInt64 |
Minimum signed 64 bits int value that can be stored in a Json::Value. More... | |
static const Int64 | maxInt64 |
Maximum signed 64 bits int value that can be stored in a Json::Value. More... | |
static const UInt64 | maxUInt64 |
Maximum unsigned 64 bits int value that can be stored in a Json::Value. More... | |
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.
typedef Json::Int Json::Value::Int |
typedef Json::Int64 Json::Value::Int64 |
typedef ValueIterator Json::Value::iterator |
typedef std::vector<std::string> Json::Value::Members |
typedef std::map<CZString, Value> Json::Value::ObjectValues |
typedef Json::UInt Json::Value::UInt |
typedef Json::UInt64 Json::Value::UInt64 |
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:
Definition at line 1776 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
Referenced by operator[](), and resize().
Json::Value::Value | ( | Int | value | ) |
Json::Value::Value | ( | UInt | value | ) |
Json::Value::Value | ( | Int64 | value | ) |
Definition at line 1844 of file jsoncpp.cpp.
Json::Value::Value | ( | UInt64 | value | ) |
Definition at line 1855 of file jsoncpp.cpp.
Json::Value::Value | ( | double | value | ) |
Definition at line 1865 of file jsoncpp.cpp.
Json::Value::Value | ( | const char * | value | ) |
Definition at line 1875 of file jsoncpp.cpp.
References Json::duplicateStringValue().
Json::Value::Value | ( | const char * | beginValue, |
const char * | endValue | ||
) |
Definition at line 1887 of file jsoncpp.cpp.
References Json::duplicateStringValue().
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:
Definition at line 1914 of file jsoncpp.cpp.
References Json::StaticString::c_str().
Json::Value::Value | ( | const std::string & | value | ) |
Definition at line 1901 of file jsoncpp.cpp.
References Json::duplicateStringValue().
Json::Value::Value | ( | bool | value | ) |
Definition at line 1939 of file jsoncpp.cpp.
Json::Value::Value | ( | const Value & | other | ) |
Definition at line 1950 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::duplicateStringValue(), Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::numberOfCommentPlacement, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
Json::Value::~Value | ( | ) |
Definition at line 2004 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::objectValue, Json::realValue, Json::releaseStringValue(), Json::stringValue, and Json::uintValue.
Append value to array at the end.
Equivalent to jsonvalue[jsonvalue.size()] = value;
Definition at line 2769 of file jsoncpp.cpp.
References size().
bool Json::Value::asBool | ( | ) | const |
Definition at line 2428 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
const char * Json::Value::asCString | ( | ) | const |
Definition at line 2190 of file jsoncpp.cpp.
References JSON_ASSERT, and Json::stringValue.
double Json::Value::asDouble | ( | ) | const |
Definition at line 2370 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
float Json::Value::asFloat | ( | ) | const |
Definition at line 2399 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
Value::Int Json::Value::asInt | ( | ) | const |
Definition at line 2230 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_MESSAGE, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, maxInt, minInt, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
Referenced by asLargestInt().
Int64 Json::Value::asInt64 | ( | ) | const |
Referenced by asLargestInt().
LargestInt Json::Value::asLargestInt | ( | ) | const |
Definition at line 2348 of file jsoncpp.cpp.
LargestUInt Json::Value::asLargestUInt | ( | ) | const |
Definition at line 2359 of file jsoncpp.cpp.
References asUInt(), and asUInt64().
std::string Json::Value::asString | ( | ) | const |
Definition at line 2198 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
Value::UInt Json::Value::asUInt | ( | ) | const |
Definition at line 2259 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_MESSAGE, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, maxUInt, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
Referenced by asLargestUInt().
UInt64 Json::Value::asUInt64 | ( | ) | const |
Referenced by asLargestUInt().
Value::const_iterator Json::Value::begin | ( | ) | const |
Definition at line 3019 of file jsoncpp.cpp.
References Json::arrayValue, and Json::objectValue.
Value::iterator Json::Value::begin | ( | ) |
Definition at line 3090 of file jsoncpp.cpp.
References Json::arrayValue, and Json::objectValue.
void Json::Value::clear | ( | ) |
Remove all object members and array elements.
Definition at line 2559 of file jsoncpp.cpp.
References Json::arrayValue, JSON_ASSERT, Json::nullValue, and Json::objectValue.
Referenced by resize().
int Json::Value::compare | ( | const Value & | other | ) | const |
Definition at line 2067 of file jsoncpp.cpp.
bool Json::Value::empty | ( | ) | const |
Return true if empty array, empty object, or null; otherwise, false.
Definition at line 2542 of file jsoncpp.cpp.
References isArray(), isNull(), isObject(), and size().
Value::const_iterator Json::Value::end | ( | ) | const |
Definition at line 3054 of file jsoncpp.cpp.
References Json::arrayValue, and Json::objectValue.
Value::iterator Json::Value::end | ( | ) |
Definition at line 3125 of file jsoncpp.cpp.
References Json::arrayValue, and Json::objectValue.
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 2697 of file jsoncpp.cpp.
References null.
Return the member named key if it exist, defaultValue otherwise.
Definition at line 2776 of file jsoncpp.cpp.
References null.
Return the member named key if it exist, defaultValue otherwise.
Definition at line 2785 of file jsoncpp.cpp.
std::string Json::Value::getComment | ( | CommentPlacement | placement | ) | const |
Include delimiters and embedded newlines.
Definition at line 3002 of file jsoncpp.cpp.
References hasComment().
Value::Members Json::Value::getMemberNames | ( | ) | const |
Return a list of the member names.
If null, return an empty list.
Definition at line 2856 of file jsoncpp.cpp.
References equals(), JSON_ASSERT, Json::nullValue, and Json::objectValue.
bool Json::Value::hasComment | ( | CommentPlacement | placement | ) | const |
Definition at line 2996 of file jsoncpp.cpp.
Referenced by getComment().
bool Json::Value::isArray | ( | ) | const |
Definition at line 2964 of file jsoncpp.cpp.
References Json::arrayValue, and Json::nullValue.
Referenced by empty(), Json::Path::make(), Json::Reader::parse(), and Json::Path::resolve().
bool Json::Value::isBool | ( | ) | const |
Definition at line 2913 of file jsoncpp.cpp.
References Json::booleanValue.
bool Json::Value::isConvertibleTo | ( | ValueType | other | ) | const |
Definition at line 2454 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, maxInt, maxUInt, minInt, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
bool Json::Value::isDouble | ( | ) | const |
bool Json::Value::isInt | ( | ) | const |
Definition at line 2920 of file jsoncpp.cpp.
References Json::intValue.
bool Json::Value::isIntegral | ( | ) | const |
Definition at line 2934 of file jsoncpp.cpp.
References Json::booleanValue, Json::intValue, and Json::uintValue.
Referenced by isNumeric().
bool Json::Value::isMember | ( | const char * | key | ) | const |
Return true if the object has a member named key.
Definition at line 2833 of file jsoncpp.cpp.
References null.
Referenced by isMember().
bool Json::Value::isMember | ( | const std::string & | key | ) | const |
Return true if the object has a member named key.
Definition at line 2841 of file jsoncpp.cpp.
References isMember().
bool Json::Value::isNull | ( | ) | const |
Definition at line 2906 of file jsoncpp.cpp.
References Json::nullValue.
Referenced by empty(), and operator!().
bool Json::Value::isNumeric | ( | ) | const |
Definition at line 2950 of file jsoncpp.cpp.
References isDouble(), and isIntegral().
bool Json::Value::isObject | ( | ) | const |
Definition at line 2971 of file jsoncpp.cpp.
References Json::nullValue, and Json::objectValue.
Referenced by empty(), Json::Path::make(), Json::Reader::parse(), and Json::Path::resolve().
bool Json::Value::isString | ( | ) | const |
Definition at line 2957 of file jsoncpp.cpp.
References Json::stringValue.
bool Json::Value::isUInt | ( | ) | const |
Definition at line 2927 of file jsoncpp.cpp.
References Json::uintValue.
bool Json::Value::isValidIndex | ( | ArrayIndex | index | ) | const |
Return true if index < size().
Definition at line 2706 of file jsoncpp.cpp.
References size().
Referenced by Json::Path::resolve().
bool Json::Value::operator! | ( | ) | const |
bool Json::Value::operator!= | ( | const Value & | other | ) | const |
Definition at line 2184 of file jsoncpp.cpp.
bool Json::Value::operator< | ( | const Value & | other | ) | const |
Definition at line 2078 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
bool Json::Value::operator<= | ( | const Value & | other | ) | const |
Definition at line 2122 of file jsoncpp.cpp.
Definition at line 2040 of file jsoncpp.cpp.
References swap().
bool Json::Value::operator== | ( | const Value & | other | ) | const |
Definition at line 2140 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
bool Json::Value::operator> | ( | const Value & | other | ) | const |
Definition at line 2134 of file jsoncpp.cpp.
bool Json::Value::operator>= | ( | const Value & | other | ) | const |
Definition at line 2128 of file jsoncpp.cpp.
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 2610 of file jsoncpp.cpp.
References Json::arrayValue, JSON_ASSERT, null, Json::nullValue, and Value().
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 2631 of file jsoncpp.cpp.
References JSON_ASSERT.
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 2639 of file jsoncpp.cpp.
References Json::arrayValue, JSON_ASSERT, null, and Json::nullValue.
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 2658 of file jsoncpp.cpp.
References JSON_ASSERT.
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 2666 of file jsoncpp.cpp.
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 2714 of file jsoncpp.cpp.
References JSON_ASSERT, null, Json::nullValue, and Json::objectValue.
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 2733 of file jsoncpp.cpp.
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 2740 of file jsoncpp.cpp.
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:
Definition at line 2746 of file jsoncpp.cpp.
Value Json::Value::removeMember | ( | const char * | key | ) |
Remove and return the named member.
Do nothing if it did not exist.
Definition at line 2792 of file jsoncpp.cpp.
References JSON_ASSERT, null, Json::nullValue, and Json::objectValue.
Referenced by removeMember().
Value Json::Value::removeMember | ( | const std::string & | key | ) |
Same as removeMember(const char*)
Definition at line 2818 of file jsoncpp.cpp.
References removeMember().
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.
Definition at line 2584 of file jsoncpp.cpp.
References Json::arrayValue, clear(), JSON_ASSERT, Json::nullValue, size(), and Value().
void Json::Value::setComment | ( | const char * | comment, |
CommentPlacement | placement | ||
) |
Comments must be //... or /* ... */.
Definition at line 2978 of file jsoncpp.cpp.
References Json::numberOfCommentPlacement.
Referenced by Json::Reader::parse(), and setComment().
void Json::Value::setComment | ( | const std::string & | comment, |
CommentPlacement | placement | ||
) |
Comments must be //... or /* ... */.
Definition at line 2988 of file jsoncpp.cpp.
References setComment().
ArrayIndex Json::Value::size | ( | ) | const |
Number of values in array or object.
Definition at line 2506 of file jsoncpp.cpp.
References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.
Referenced by append(), empty(), isValidIndex(), and resize().
void Json::Value::swap | ( | Value & | other | ) |
Swap values.
Definition at line 2048 of file jsoncpp.cpp.
References swap().
Referenced by operator=().
std::string Json::Value::toStyledString | ( | ) | const |
Definition at line 3011 of file jsoncpp.cpp.
References Json::StyledWriter::write().
ValueType Json::Value::type | ( | ) | const |
Definition at line 2060 of file jsoncpp.cpp.
|
static |
Maximum signed int value that can be stored in a Json::Value.
Definition at line 465 of file jsoncpp.h.
Referenced by asInt(), and isConvertibleTo().
|
static |
Maximum signed 64 bits int value that can be stored in a Json::Value.
|
static |
Maximum signed integer value that can be stored in a Json::Value.
|
static |
Maximum unsigned integer value that can be stored in a Json::Value.
|
static |
Maximum unsigned int value that can be stored in a Json::Value.
Definition at line 467 of file jsoncpp.h.
Referenced by asUInt(), and isConvertibleTo().
|
static |
Maximum unsigned 64 bits int value that can be stored in a Json::Value.
|
static |
Minimum signed int value that can be stored in a Json::Value.
Definition at line 463 of file jsoncpp.h.
Referenced by asInt(), and isConvertibleTo().
|
static |
Minimum signed 64 bits int value that can be stored in a Json::Value.
|
static |
Minimum signed integer value that can be stored in a Json::Value.
|
static |
Definition at line 454 of file jsoncpp.h.
Referenced by get(), isMember(), operator[](), removeMember(), and Json::Path::resolve().