CoolProp
4.2.5
An open-source fluid property and humid air property database
|
Represents a JSON value. Use Value for UTF8 encoding and default allocator. More...
#include <document.h>
Classes | |
struct | Member |
Name-value pair in an object. More... | |
Public Types | |
typedef Encoding | EncodingType |
Encoding type from template parameter. More... | |
typedef Allocator | AllocatorType |
Allocator type from template parameter. More... | |
typedef Encoding::Ch | Ch |
Character type derived from Encoding. More... | |
typedef Member * | MemberIterator |
Member iterator for iterating in object. More... | |
typedef const Member * | ConstMemberIterator |
Constant member iterator for iterating in object. More... | |
typedef GenericValue * | ValueIterator |
Value iterator for iterating in array. More... | |
typedef const GenericValue * | ConstValueIterator |
Constant value iterator for iterating in array. More... | |
Public Member Functions | |
template<typename Handler > | |
const GenericValue & | Accept (Handler &handler) const |
Generate events of this value to a Handler. More... | |
Assignment operators | |
GenericValue & | operator= (GenericValue &rhs) |
Assignment with move semantics. More... | |
template<typename T > | |
GenericValue & | operator= (T value) |
Assignment with primitive types. More... | |
Type | |
Type | GetType () const |
bool | IsNull () const |
bool | IsFalse () const |
bool | IsTrue () const |
bool | IsBool () const |
bool | IsObject () const |
bool | IsArray () const |
bool | IsNumber () const |
bool | IsInt () const |
bool | IsUint () const |
bool | IsInt64 () const |
bool | IsUint64 () const |
bool | IsDouble () const |
bool | IsString () const |
Null | |
GenericValue & | SetNull () |
Bool | |
bool | GetBool () const |
GenericValue & | SetBool (bool b) |
Object | |
GenericValue & | SetObject () |
Set this value as an empty object. More... | |
GenericValue & | operator[] (const Ch *name) |
Get the value associated with the object's name. More... | |
const GenericValue & | operator[] (const Ch *name) const |
ConstMemberIterator | MemberBegin () const |
Member iterators. More... | |
ConstMemberIterator | MemberEnd () const |
MemberIterator | MemberBegin () |
MemberIterator | MemberEnd () |
bool | HasMember (const Ch *name) const |
Check whether a member exists in the object. More... | |
GenericValue & | AddMember (GenericValue &name, GenericValue &value, Allocator &allocator) |
Add a member (name-value pair) to the object. More... | |
GenericValue & | AddMember (const Ch *name, Allocator &nameAllocator, GenericValue &value, Allocator &allocator) |
GenericValue & | AddMember (const Ch *name, GenericValue &value, Allocator &allocator) |
template<typename T > | |
GenericValue & | AddMember (const Ch *name, T value, Allocator &allocator) |
bool | RemoveMember (const Ch *name) |
Remove a member in object by its name. More... | |
Array | |
GenericValue & | SetArray () |
Set this value as an empty array. More... | |
SizeType | Size () const |
Get the number of elements in array. More... | |
SizeType | Capacity () const |
Get the capacity of array. More... | |
bool | Empty () const |
Check whether the array is empty. More... | |
void | Clear () |
Remove all elements in the array. More... | |
GenericValue & | operator[] (SizeType index) |
Get an element from array by index. More... | |
const GenericValue & | operator[] (SizeType index) const |
ValueIterator | Begin () |
Element iterator. More... | |
ValueIterator | End () |
ConstValueIterator | Begin () const |
ConstValueIterator | End () const |
GenericValue & | Reserve (SizeType newCapacity, Allocator &allocator) |
Request the array to have enough capacity to store elements. More... | |
GenericValue & | PushBack (GenericValue &value, Allocator &allocator) |
Append a value at the end of the array. More... | |
template<typename T > | |
GenericValue & | PushBack (T value, Allocator &allocator) |
GenericValue & | PopBack () |
Remove the last element in the array. More... | |
Number | |
int | GetInt () const |
unsigned | GetUint () const |
int64_t | GetInt64 () const |
uint64_t | GetUint64 () const |
double | GetDouble () const |
GenericValue & | SetInt (int i) |
GenericValue & | SetUint (unsigned u) |
GenericValue & | SetInt64 (int64_t i64) |
GenericValue & | SetUint64 (uint64_t u64) |
GenericValue & | SetDouble (double d) |
String | |
const Ch * | GetString () const |
SizeType | GetStringLength () const |
Get the length of string. More... | |
GenericValue & | SetString (const Ch *s, SizeType length) |
Set this value as a string without copying source string. More... | |
GenericValue & | SetString (const Ch *s) |
Set this value as a string without copying source string. More... | |
GenericValue & | SetString (const Ch *s, SizeType length, Allocator &allocator) |
Set this value as a string by copying from source string. More... | |
GenericValue & | SetString (const Ch *s, Allocator &allocator) |
Set this value as a string by copying from source string. More... | |
Friends | |
template<typename , typename > | |
class | GenericDocument |
Constructors and destructor. | |
GenericValue () | |
Default constructor creates a null value. More... | |
GenericValue (Type type) | |
Constructor with JSON value type. More... | |
GenericValue (bool b) | |
Constructor for boolean value. More... | |
GenericValue (int i) | |
Constructor for int value. More... | |
GenericValue (unsigned u) | |
Constructor for unsigned value. More... | |
GenericValue (int64_t i64) | |
Constructor for int64_t value. More... | |
GenericValue (uint64_t u64) | |
Constructor for uint64_t value. More... | |
GenericValue (double d) | |
Constructor for double value. More... | |
GenericValue (const Ch *s, SizeType length) | |
Constructor for constant string (i.e. do not make a copy of string) More... | |
GenericValue (const Ch *s) | |
Constructor for constant string (i.e. do not make a copy of string) More... | |
GenericValue (const Ch *s, SizeType length, Allocator &allocator) | |
Constructor for copy-string (i.e. do make a copy of string) More... | |
GenericValue (const Ch *s, Allocator &allocator) | |
Constructor for copy-string (i.e. do make a copy of string) More... | |
~GenericValue () | |
Destructor. More... | |
Represents a JSON value. Use Value for UTF8 encoding and default allocator.
A JSON value can be one of 7 types. This class is a variant type supporting these types.
Use the Value if UTF8 and default allocator
Encoding | Encoding of the value. (Even non-string values need to have the same encoding in a document) |
Allocator | Allocator type for allocating memory of object, array and string. |
Definition at line 30 of file document.h.
typedef Allocator rapidjson::GenericValue< Encoding, Allocator >::AllocatorType |
Allocator type from template parameter.
Definition at line 39 of file document.h.
typedef Encoding::Ch rapidjson::GenericValue< Encoding, Allocator >::Ch |
Character type derived from Encoding.
Definition at line 40 of file document.h.
typedef const Member* rapidjson::GenericValue< Encoding, Allocator >::ConstMemberIterator |
Constant member iterator for iterating in object.
Definition at line 42 of file document.h.
typedef const GenericValue* rapidjson::GenericValue< Encoding, Allocator >::ConstValueIterator |
Constant value iterator for iterating in array.
Definition at line 44 of file document.h.
typedef Encoding rapidjson::GenericValue< Encoding, Allocator >::EncodingType |
Encoding type from template parameter.
Definition at line 38 of file document.h.
typedef Member* rapidjson::GenericValue< Encoding, Allocator >::MemberIterator |
Member iterator for iterating in object.
Definition at line 41 of file document.h.
typedef GenericValue* rapidjson::GenericValue< Encoding, Allocator >::ValueIterator |
Value iterator for iterating in array.
Definition at line 43 of file document.h.
|
inline |
Default constructor creates a null value.
Definition at line 50 of file document.h.
|
inline |
Constructor with JSON value type.
This creates a Value of specified type with default content.
type | Type of the value. |
Definition at line 63 of file document.h.
|
inline |
Constructor for boolean value.
Definition at line 74 of file document.h.
|
inline |
Constructor for int value.
Definition at line 77 of file document.h.
|
inline |
Constructor for unsigned value.
Definition at line 84 of file document.h.
|
inline |
Constructor for int64_t value.
Definition at line 91 of file document.h.
|
inline |
Constructor for uint64_t value.
Definition at line 105 of file document.h.
|
inline |
Constructor for double value.
Definition at line 116 of file document.h.
|
inline |
Constructor for constant string (i.e. do not make a copy of string)
Definition at line 119 of file document.h.
|
inline |
Constructor for constant string (i.e. do not make a copy of string)
Definition at line 127 of file document.h.
|
inline |
Constructor for copy-string (i.e. do make a copy of string)
Definition at line 130 of file document.h.
|
inline |
Constructor for copy-string (i.e. do make a copy of string)
Definition at line 133 of file document.h.
|
inline |
Destructor.
Need to destruct elements of array, members of object, or copy-string.
Definition at line 138 of file document.h.
|
inline |
Generate events of this value to a Handler.
This function adopts the GoF visitor pattern. Typical usage is to output this JSON value as JSON text via Writer, which is a Handler. It can also be used to deep clone this value via GenericDocument, which is also a Handler.
Handler | type of handler. |
handler | An object implementing concept Handler. |
Definition at line 494 of file document.h.
|
inline |
Add a member (name-value pair) to the object.
name | A string value as name of member. |
value | Value of any type. |
allocator | Allocator for reallocating memory. |
Definition at line 258 of file document.h.
|
inline |
Definition at line 279 of file document.h.
|
inline |
Definition at line 284 of file document.h.
|
inline |
Definition at line 290 of file document.h.
|
inline |
Element iterator.
Definition at line 370 of file document.h.
|
inline |
Definition at line 372 of file document.h.
|
inline |
Get the capacity of array.
Definition at line 336 of file document.h.
|
inline |
Remove all elements in the array.
This function do not deallocate memory in the array, i.e. the capacity is unchanged.
Definition at line 344 of file document.h.
|
inline |
Check whether the array is empty.
Definition at line 339 of file document.h.
|
inline |
Definition at line 371 of file document.h.
|
inline |
Definition at line 373 of file document.h.
|
inline |
Definition at line 220 of file document.h.
|
inline |
Definition at line 427 of file document.h.
|
inline |
Definition at line 422 of file document.h.
|
inline |
Definition at line 424 of file document.h.
|
inline |
Definition at line 447 of file document.h.
|
inline |
Get the length of string.
Since rapidjson permits "\u0000" in the json string, strlen(v.GetString()) may not equal to v.GetStringLength().
Definition at line 452 of file document.h.
|
inline |
Definition at line 193 of file document.h.
|
inline |
Definition at line 423 of file document.h.
|
inline |
Definition at line 425 of file document.h.
|
inline |
Check whether a member exists in the object.
Definition at line 249 of file document.h.
|
inline |
Definition at line 199 of file document.h.
|
inline |
Definition at line 197 of file document.h.
|
inline |
Definition at line 205 of file document.h.
|
inline |
Definition at line 195 of file document.h.
|
inline |
Definition at line 201 of file document.h.
|
inline |
Definition at line 203 of file document.h.
|
inline |
Definition at line 194 of file document.h.
|
inline |
Definition at line 200 of file document.h.
|
inline |
Definition at line 198 of file document.h.
|
inline |
Definition at line 206 of file document.h.
|
inline |
Definition at line 196 of file document.h.
|
inline |
Definition at line 202 of file document.h.
|
inline |
Definition at line 204 of file document.h.
|
inline |
Member iterators.
Definition at line 243 of file document.h.
|
inline |
Definition at line 245 of file document.h.
|
inline |
Definition at line 244 of file document.h.
|
inline |
Definition at line 246 of file document.h.
|
inline |
Assignment with move semantics.
rhs | Source of the assignment. It will become a null value after assignment. |
Definition at line 170 of file document.h.
|
inline |
Assignment with primitive types.
T | Either Type, int, unsigned, int64_t, uint64_t, const Ch* |
value | The value to be assigned. |
Definition at line 183 of file document.h.
|
inline |
Get the value associated with the object's name.
Definition at line 232 of file document.h.
|
inline |
Definition at line 240 of file document.h.
|
inline |
Get an element from array by index.
index | Zero-based index of element. |
Definition at line 362 of file document.h.
|
inline |
Definition at line 367 of file document.h.
|
inline |
Remove the last element in the array.
Definition at line 411 of file document.h.
|
inline |
Append a value at the end of the array.
value | The value to be appended. |
allocator | The allocator for allocating memory. It must be the same one use previously. |
Definition at line 396 of file document.h.
|
inline |
Definition at line 405 of file document.h.
|
inline |
Remove a member in object by its name.
name | Name of member to be removed. |
Definition at line 301 of file document.h.
|
inline |
Request the array to have enough capacity to store elements.
newCapacity | The capacity that the array at least need to have. |
allocator | The allocator for allocating memory. It must be the same one use previously. |
Definition at line 380 of file document.h.
|
inline |
Set this value as an empty array.
Definition at line 330 of file document.h.
|
inline |
Definition at line 221 of file document.h.
|
inline |
Definition at line 440 of file document.h.
|
inline |
Definition at line 436 of file document.h.
|
inline |
Definition at line 438 of file document.h.
|
inline |
Definition at line 213 of file document.h.
|
inline |
Set this value as an empty object.
Definition at line 229 of file document.h.
|
inline |
Set this value as a string without copying source string.
This version has better performance with supplied length, and also support string containing null character.
s | source string pointer. |
length | The length of source string, excluding the trailing null terminator. |
Definition at line 460 of file document.h.
|
inline |
Set this value as a string without copying source string.
s | source string pointer. |
Definition at line 466 of file document.h.
|
inline |
Set this value as a string by copying from source string.
This version has better performance with supplied length, and also support string containing null character.
s | source string. |
length | The length of source string, excluding the trailing null terminator. |
allocator | Allocator for allocating copied buffer. Commonly use document.GetAllocator(). |
Definition at line 475 of file document.h.
|
inline |
Set this value as a string by copying from source string.
s | source string. |
allocator | Allocator for allocating copied buffer. Commonly use document.GetAllocator(). |
Definition at line 482 of file document.h.
|
inline |
Definition at line 437 of file document.h.
|
inline |
Definition at line 439 of file document.h.
|
inline |
Get the number of elements in array.
Definition at line 333 of file document.h.
|
friend |
Definition at line 533 of file document.h.