TrueReality  v0.1.1912
trUtil::JSON::ArrayBase Class Referenceabstract

An array base. More...

#include <ArrayBase.h>

Inheritance diagram for trUtil::JSON::ArrayBase:
Collaboration diagram for trUtil::JSON::ArrayBase:

Public Member Functions

virtual void Clear ()=0
 Clears the internal JSON Root node. More...
 
virtual ValueGetJSONRoot ()=0
 Returns a reference to the internal JSON Root node. More...
 
virtual void PrintJSONRoot ()=0
 Prints out to the screen the whole JSON Root content. More...
 
virtual bool IsNull (int &index) const =0
 Checks if the value stored at the specific index is a NULL. More...
 
virtual void AddNull ()=0
 Add a NULL Value to the Array. More...
 
virtual bool IsBool (int &index) const =0
 Checks if the value stored at the specific index is a Boolean. More...
 
virtual bool GetBool (int &index) const =0
 Returns the Boolean value stored at the given index. More...
 
virtual void AddBool (const bool &value)=0
 Adds a Boolean to the Array. More...
 
virtual bool IsTrue (int &index) const =0
 Checks if the value stored at the specific index is True. More...
 
virtual bool IsFalse (int &index) const =0
 Checks if the value stored at the specific index is False. More...
 
virtual bool IsNumber (int &index) const =0
 Checks if the value stored at the specific index is a Number. More...
 
virtual bool IsInt (int &index) const =0
 Checks if the value stored at the specific index is an Integer. More...
 
virtual int GetInt (int &index) const =0
 Returns the Integer value stored at the given index. More...
 
virtual void AddInt (const int &value)=0
 Adds the Integer value to the Array. More...
 
virtual bool IsDouble (int &index) const =0
 Checks if the value stored at the specific index is a Double. More...
 
virtual double GetDouble (int &index) const =0
 Returns the Double value stored at the given index. More...
 
virtual void AddDouble (const double &value)=0
 Adds the Double value to the Array. More...
 
virtual bool IsUInt (int &index) const =0
 Checks if the value stored at the specific index is an Unsigned Integer. More...
 
virtual unsigned int GetUInt (int &index) const =0
 Returns the Unsigned Integer value stored at the given index. More...
 
virtual void AddUInt (const unsigned int &value)=0
 Adds the Unsigned Integer value the Array. More...
 
virtual bool IsInt64 (int &index) const =0
 Checks if the value stored at the specific index is a 64bit Integer. More...
 
virtual Int64 GetInt64 (int &index) const =0
 Returns the 64bit Integer value stored at the given index. More...
 
virtual void AddInt64 (const Int64 &value)=0
 Adds the 64bit Integer value to the Array. More...
 
virtual bool IsUInt64 (int &index) const =0
 Checks if the value stored at the specific index is a 64bit Integer. More...
 
virtual UInt64 GetUInt64 (int &index) const =0
 Returns the 64bit Integer value stored at the given index. More...
 
virtual void AddUInt64 (const UInt64 &value)=0
 Adds the 64bit Integer value to the Array. More...
 
virtual bool IsFloat (int &index) const =0
 Checks if the value stored at the specific index is a float. More...
 
virtual float GetFloat (int &index) const =0
 Returns the float value stored at the given index. More...
 
virtual void AddFloat (const float &value)=0
 Adds the float value to the Array. More...
 
virtual bool IsString (int &index) const =0
 Checks if the value stored at the specific index is a String. More...
 
virtual const std::string GetString (int &index) const =0
 Returns the String value stored at the given index. More...
 
virtual void AddString (const std::string &value)=0
 Adds the String to the Array. More...
 
virtual bool IsArray (int &index) const =0
 Checks if the value stored at the specific index is an Array. More...
 
virtual Array GetArray (int &index) const =0
 Returns the Array value stored at the given index. More...
 
virtual void AddArray (Array &Array)=0
 Adds the Array to the Array. More...
 
virtual bool IsObject (int &index) const =0
 Checks if the value stored at the specific index is an Object. More...
 
virtual Object GetObject (int &index) const =0
 Returns the Object value stored at the given index. More...
 
virtual void AddObject (Object &Object)=0
 Adds the Object to the Array. More...
 

Detailed Description

An array base.

Author
Maxim Serebrennik

Definition at line 61 of file ArrayBase.h.

Member Function Documentation

◆ AddArray()

void trUtil::JSON::ArrayBase::AddArray ( Array Array)
pure virtual

Adds the Array to the Array.

Parameters
[in,out]ArrayThe array.

Implemented in trUtil::JSON::Array.

◆ AddBool()

void trUtil::JSON::ArrayBase::AddBool ( const bool &  value)
pure virtual

Adds a Boolean to the Array.

Parameters
valueThe value.

Implemented in trUtil::JSON::Array.

◆ AddDouble()

void trUtil::JSON::ArrayBase::AddDouble ( const double &  value)
pure virtual

Adds the Double value to the Array.

Parameters
valueThe value.

Implemented in trUtil::JSON::Array.

◆ AddFloat()

void trUtil::JSON::ArrayBase::AddFloat ( const float &  value)
pure virtual

Adds the float value to the Array.

Parameters
valueThe value.

Implemented in trUtil::JSON::Array.

◆ AddInt()

void trUtil::JSON::ArrayBase::AddInt ( const int &  value)
pure virtual

Adds the Integer value to the Array.

Parameters
valueThe value.

Implemented in trUtil::JSON::Array.

◆ AddInt64()

void trUtil::JSON::ArrayBase::AddInt64 ( const Int64 value)
pure virtual

Adds the 64bit Integer value to the Array.

Parameters
valueThe value.

Implemented in trUtil::JSON::Array.

◆ AddNull()

void trUtil::JSON::ArrayBase::AddNull ( )
pure virtual

Add a NULL Value to the Array.

Implemented in trUtil::JSON::Array.

◆ AddObject()

void trUtil::JSON::ArrayBase::AddObject ( Object Object)
pure virtual

Adds the Object to the Array.

Parameters
[in,out]ObjectThe object.

Implemented in trUtil::JSON::Array.

◆ AddString()

void trUtil::JSON::ArrayBase::AddString ( const std::string &  value)
pure virtual

Adds the String to the Array.

Parameters
valueThe value.

Implemented in trUtil::JSON::Array.

◆ AddUInt()

void trUtil::JSON::ArrayBase::AddUInt ( const unsigned int &  value)
pure virtual

Adds the Unsigned Integer value the Array.

Parameters
valueThe value.

Implemented in trUtil::JSON::Array.

◆ AddUInt64()

void trUtil::JSON::ArrayBase::AddUInt64 ( const UInt64 value)
pure virtual

Adds the 64bit Integer value to the Array.

Parameters
valueThe value.

Implemented in trUtil::JSON::Array.

◆ Clear()

void trUtil::JSON::ArrayBase::Clear ( )
pure virtual

Clears the internal JSON Root node.

Implemented in trUtil::JSON::Array.

◆ GetArray()

Array trUtil::JSON::ArrayBase::GetArray ( int &  index) const
pure virtual

Returns the Array value stored at the given index.

Parameters
[in,out]indexZero-based index of the.
Returns
The array.

Implemented in trUtil::JSON::Array.

◆ GetBool()

bool trUtil::JSON::ArrayBase::GetBool ( int &  index) const
pure virtual

Returns the Boolean value stored at the given index.

Parameters
[in,out]indexZero-based index of the.
Returns
True if it succeeds, false if it fails.

Implemented in trUtil::JSON::Array.

◆ GetDouble()

double trUtil::JSON::ArrayBase::GetDouble ( int &  index) const
pure virtual

Returns the Double value stored at the given index.

Parameters
[in,out]indexZero-based index of the.
Returns
The double.

Implemented in trUtil::JSON::Array.

◆ GetFloat()

float trUtil::JSON::ArrayBase::GetFloat ( int &  index) const
pure virtual

Returns the float value stored at the given index.

Parameters
[in,out]indexZero-based index of the.
Returns
The float.

Implemented in trUtil::JSON::Array.

◆ GetInt()

int trUtil::JSON::ArrayBase::GetInt ( int &  index) const
pure virtual

Returns the Integer value stored at the given index.

Parameters
[in,out]indexZero-based index of the.
Returns
The int.

Implemented in trUtil::JSON::Array.

◆ GetInt64()

Int64 trUtil::JSON::ArrayBase::GetInt64 ( int &  index) const
pure virtual

Returns the 64bit Integer value stored at the given index.

Parameters
[in,out]indexZero-based index of the.
Returns
The int 64.

Implemented in trUtil::JSON::Array.

◆ GetJSONRoot()

Value & trUtil::JSON::ArrayBase::GetJSONRoot ( )
pure virtual

Returns a reference to the internal JSON Root node.

Returns
The JSON root.

Implemented in trUtil::JSON::Array.

◆ GetObject()

Object trUtil::JSON::ArrayBase::GetObject ( int &  index) const
pure virtual

Returns the Object value stored at the given index.

Parameters
[in,out]indexZero-based index of the.
Returns
The object.

Implemented in trUtil::JSON::Array.

◆ GetString()

const std::string trUtil::JSON::ArrayBase::GetString ( int &  index) const
pure virtual

Returns the String value stored at the given index.

Parameters
[in,out]indexZero-based index of the.
Returns
The string.

Implemented in trUtil::JSON::Array.

◆ GetUInt()

unsigned int trUtil::JSON::ArrayBase::GetUInt ( int &  index) const
pure virtual

Returns the Unsigned Integer value stored at the given index.

Parameters
[in,out]indexZero-based index of the.
Returns
The u int.

Implemented in trUtil::JSON::Array.

◆ GetUInt64()

UInt64 trUtil::JSON::ArrayBase::GetUInt64 ( int &  index) const
pure virtual

Returns the 64bit Integer value stored at the given index.

Parameters
[in,out]indexZero-based index of the.
Returns
The u int 64.

Implemented in trUtil::JSON::Array.

◆ IsArray()

bool trUtil::JSON::ArrayBase::IsArray ( int &  index) const
pure virtual

Checks if the value stored at the specific index is an Array.

Parameters
[in,out]indexZero-based index of the.
Returns
True if array, false if not.

Implemented in trUtil::JSON::Array.

◆ IsBool()

bool trUtil::JSON::ArrayBase::IsBool ( int &  index) const
pure virtual

Checks if the value stored at the specific index is a Boolean.

Parameters
[in,out]indexZero-based index of the.
Returns
True if bool, false if not.

Implemented in trUtil::JSON::Array.

◆ IsDouble()

bool trUtil::JSON::ArrayBase::IsDouble ( int &  index) const
pure virtual

Checks if the value stored at the specific index is a Double.

Parameters
[in,out]indexZero-based index of the.
Returns
True if double, false if not.

Implemented in trUtil::JSON::Array.

◆ IsFalse()

bool trUtil::JSON::ArrayBase::IsFalse ( int &  index) const
pure virtual

Checks if the value stored at the specific index is False.

Parameters
[in,out]indexZero-based index of the.
Returns
True if false, false if not.

Implemented in trUtil::JSON::Array.

◆ IsFloat()

bool trUtil::JSON::ArrayBase::IsFloat ( int &  index) const
pure virtual

Checks if the value stored at the specific index is a float.

Parameters
[in,out]indexZero-based index of the.
Returns
True if float, false if not.

Implemented in trUtil::JSON::Array.

◆ IsInt()

bool trUtil::JSON::ArrayBase::IsInt ( int &  index) const
pure virtual

Checks if the value stored at the specific index is an Integer.

Parameters
[in,out]indexZero-based index of the.
Returns
True if int, false if not.

Implemented in trUtil::JSON::Array.

◆ IsInt64()

bool trUtil::JSON::ArrayBase::IsInt64 ( int &  index) const
pure virtual

Checks if the value stored at the specific index is a 64bit Integer.

Parameters
[in,out]indexZero-based index of the.
Returns
True if int 64, false if not.

Implemented in trUtil::JSON::Array.

◆ IsNull()

bool trUtil::JSON::ArrayBase::IsNull ( int &  index) const
pure virtual

Checks if the value stored at the specific index is a NULL.

Parameters
[in,out]indexZero-based index of the.
Returns
True if null, false if not.

Implemented in trUtil::JSON::Array.

◆ IsNumber()

bool trUtil::JSON::ArrayBase::IsNumber ( int &  index) const
pure virtual

Checks if the value stored at the specific index is a Number.

Parameters
[in,out]indexZero-based index of the.
Returns
True if number, false if not.

Implemented in trUtil::JSON::Array.

◆ IsObject()

bool trUtil::JSON::ArrayBase::IsObject ( int &  index) const
pure virtual

Checks if the value stored at the specific index is an Object.

Parameters
[in,out]indexZero-based index of the.
Returns
True if object, false if not.

Implemented in trUtil::JSON::Array.

◆ IsString()

bool trUtil::JSON::ArrayBase::IsString ( int &  index) const
pure virtual

Checks if the value stored at the specific index is a String.

Parameters
[in,out]indexZero-based index of the.
Returns
True if string, false if not.

Implemented in trUtil::JSON::Array.

◆ IsTrue()

bool trUtil::JSON::ArrayBase::IsTrue ( int &  index) const
pure virtual

Checks if the value stored at the specific index is True.

Parameters
[in,out]indexZero-based index of the.
Returns
True if true, false if not.

Implemented in trUtil::JSON::Array.

◆ IsUInt()

bool trUtil::JSON::ArrayBase::IsUInt ( int &  index) const
pure virtual

Checks if the value stored at the specific index is an Unsigned Integer.

Parameters
[in,out]indexZero-based index of the.
Returns
True if u int, false if not.

Implemented in trUtil::JSON::Array.

◆ IsUInt64()

bool trUtil::JSON::ArrayBase::IsUInt64 ( int &  index) const
pure virtual

Checks if the value stored at the specific index is a 64bit Integer.

Parameters
[in,out]indexZero-based index of the.
Returns
True if u int 64, false if not.

Implemented in trUtil::JSON::Array.

◆ PrintJSONRoot()

void trUtil::JSON::ArrayBase::PrintJSONRoot ( )
pure virtual

Prints out to the screen the whole JSON Root content.

Implemented in trUtil::JSON::Array.


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