Unigine::Json Class

Header:

#include <UnigineJson.h>

This class is used to parse and create JSON formatted strings.

Each Json node has type, name, and value. Also, it can have child Json nodes and a parent node.

Json node can have one of the following types:

null
bool
number
string
array
object

The Json node has a hierarchy structure. The following code creates a Json node and adds child nodes with different types of values:

Source code (C++)

#include <UnigineJson.h>

/* ... */

JsonPtr json =  Json::create();
json->addChild("child_0",0);    // int
json->addChild("child_1",1.1);   // float
json->addChild("child_2","two");   // string

The result is:

Output

{
  "child_0": 0,
  "child_1": 1.1,
  "child_2": "two" 
}

Child nodes have names "child_0", "child_1", "child_2" and values: integer 0, double 1.1 and string "two". The name has always string type.

Methods:

Name	Description View: Sort by:
*create*	Default constructor that creates an empty instance.
setArray	Sets array type to the current Json node.
isArray	Returns a value indicating if the Json node has an array type.
setBool	Sets a boolean value and type to the current Json node.
getBool	Reads a boolean value of the current Json node.
isBool	Returns a value indicating if the Json node has a bool type.
getChild	Returns the child node of the current Json node.
isChild	Checks if a child node with a given name exists.
getFormattedSubTree	Returns a subtree of a Json node as the formatted string.
setName	Sets the given name to the Json node.
getName	Returns the name of the current Json node.
setNull	Sets null type to the current Json node.
isNull	Returns a value indicating if the Json node has a null type.
setNumber	Sets a number value and type to the current Json node.
getNumber	Returns the number value of the current Json node.
isNumber	Returns a value indicating if the Json node has a number type.
getNumChildren	Returns the number of child nodes of the current Json node.
setObject	Sets object type to the current Json node.
isObject	Returns a value indicating if the Json node has an object type.
getParent	Returns the parent node of the current Json node.
setString	Sets a string value and type to the current Json node.
getString	Returns the value of the current Json node as string.
isString	Returns a value indicating if the Json node has a string type.
getSubTree	Returns a subtree of a Json node as the non-formatted string.
addChild	Adds a new name-value pair as a child node to the current Json node.
clear	Clears all data of the current Json node including type, value, name and all children.
clearChildren	Clears all children of the current Json node.
copy	Copies type, name and value from the source Json node to the current Json node and adds the source Json child nodes as child nodes to the current Json node.
find	Finds Json node by its name in current Json node tree.
load	Loads the data to the current Json node from the file with a given path.
parse	Parses a given string into the Json node.
removeChild	Removes the child Json node.
save	Saves the Json node into a file with a given path.
read	Reads a boolean value of a Json node with the specified name to the specified target variable.
write	Writes the specified boolean value to the target Json node with the specified name.
getVec2	Returns a two-component vector composed of the first two elements of the array-type Json node.
getVec3	Returns a three-component vector composed of the first three elements of the array-type Json node.
getVec4	Returns a four-component vector composed of the first four elements of the array-type Json node.
getTypeName	Returns the name of the type of the Json node.

Json Class

Members

static JsonPtr create ( ) #

Default constructor that creates an empty instance.

static JsonPtr create ( const char * name ) #

Constructor that creates a JSON node with a given name.

Arguments

const char * name - Name of the Json node.

void setArray ( ) #

Sets array type to the current Json node.

int isArray ( ) const#

Returns a value indicating if the Json node has an array type.

Return value

1 if the Json has an array type; otherwise, 0.

void setBool ( int arg1 ) #

Sets a boolean value and type to the current Json node.

Arguments

int arg1 - Integer value.

int getBool ( ) const#

Reads a boolean value of the current Json node.

Return value

1 if the Json node has a bool type; otherwise, 0.

int isBool ( ) const#

Returns a value indicating if the Json node has a bool type.

Return value

1 if the Json has a bool type; otherwise, 0.

Ptr<Json> getChild ( int num ) const#

Returns the child node of the current Json node.

Arguments

int num - Argument of one of the following types:
- string name - Name of the Json node.
- int number - Number of the child of the Json node.

Return value

Child Json node.

Ptr<Json> getChild ( const char * name ) const#

Returns the child node of the current Json node.

Arguments

const char * name - Argument of one of the following types:
- string name - Name of the Json node.
- int number - Number of the child of the Json node.

Return value

Child Json node.

int isChild ( const char * name ) const#

Checks if a child node with a given name exists.

Arguments

const char * name - Name of the child node.

Return value

1 if a child with the provided name exists; otherwise, 0.

String getFormattedSubTree ( const char * name = 0 ) #

Returns a subtree of a Json node as the formatted string.

Arguments

const char * name - The name of a child node. If there is a name, the function returns formatted subtree for this child Json node.

Return value

Formatted subtree.

void setName ( const char * name ) #

Sets the given name to the Json node.

Arguments

const char * name - Name of the Json node.

const char * getName ( ) const#

Returns the name of the current Json node.

Return value

The name of the Json node.

void setNull ( ) #

Sets null type to the current Json node.

int isNull ( ) const#

Returns a value indicating if the Json node has a null type.

Return value

1 if the Json has a null type; otherwise, 0.

void setNumber ( double arg1 ) #

Sets a number value and type to the current Json node.

Arguments

double arg1 - Double value.

void setNumber ( int arg1 ) #

Sets a number value and type to the current Json node.

Arguments

int arg1 - Integer value.

double getNumber ( ) const#

Returns the number value of the current Json node.

Return value

Number value of the current Json node.

int isNumber ( ) const#

Returns a value indicating if the Json node has a number type.

Return value

1 if the Json has a number type; otherwise, 0.

int getNumChildren ( ) const#

Returns the number of child nodes of the current Json node.

Return value

Number of child nodes.

void setObject ( ) #

Sets object type to the current Json node.

int isObject ( ) const#

Returns a value indicating if the Json node has an object type.

Return value

1 if the Json has an object type; otherwise, 0.

Ptr<Json> getParent ( ) #

Returns the parent node of the current Json node.

Return value

Parent Json node.

void setString ( const char * arg1 ) #

Sets a string value and type to the current Json node. The function automatically casts number values to string type.

Arguments

const char * arg1 - String value.

String getString ( ) #

Returns the value of the current Json node as string.

Return value

Value of the current Json node

int isString ( ) const#

Returns a value indicating if the Json node has a string type.

Return value

1 if the Json has a string type; otherwise, 0.

String getSubTree ( const char * name = 0 ) #

Returns a subtree of a Json node as the non-formatted string.

Arguments

const char * name - The name of a child node. If there is a name, the function returns formatted subtree for this child Json node.