List of all members | Public Member Functions | Static Public Member Functions
JSONObject Class Reference

The JSONObject class is used to represent and (de)serialize JSON objects. More...

#include <ArmarXCore/util/json/JSONObject.h>

+ Inheritance diagram for JSONObject:

Public Member Functions

void append (const armarx::AbstractObjectSerializerPtr &val) override
 
std::string asString (bool pretty=false) const
 
armarx::AbstractObjectSerializerPtr createElement () const override
 
void fromString (const ::std::string &jsonString, const ::Ice::Current &=Ice::emptyCurrent) override
 
template<typename T>
void getArray (const std::string &key, std::vector< T > &result)
 
bool getBool (const ::std::string &key) const override
 
double getDouble (const ::std::string &key) const override
 
void getDoubleArray (const ::std::string &key, std::vector< double > &result) override
 
armarx::AbstractObjectSerializerPtr getElement (const ::std::string &key) const override
 
armarx::AbstractObjectSerializerPtr getElement (unsigned int index) const override
 
std::vector< std::string > getElementNames () const override
 
armarx::ElementType getElementType (const ::Ice::Current &=Ice::emptyCurrent) const override
 
float getFloat (const ::std::string &key) const override
 
void getFloatArray (const ::std::string &key, std::vector< float > &result) override
 
int getInt (const ::std::string &key) const override
 
void getIntArray (const ::std::string &key, std::vector< int > &result) override
 
const Json::Value & getJsonValue () const
 
std::string getString (const ::std::string &key) const override
 
void getStringArray (const ::std::string &key, std::vector< std::string > &result) override
 
void getVariantArray (const ::std::string &key, std::vector< armarx::VariantPtr > &result) override
 
void getVariantMap (const ::std::string &key, armarx::StringVariantBaseMap &result) override
 
bool hasElement (const ::std::string &key) const override
 
 JSONObject (armarx::ElementType nodeType=armarx::ElementTypes::eObject, const Ice::CommunicatorPtr ic=Ice::CommunicatorPtr())
 
 JSONObject (const Ice::CommunicatorPtr ic)
 
 JSONObject (const JSONObject &toCopy)
 
void merge (const armarx::AbstractObjectSerializerPtr &val) override
 
void reset () override
 
template<typename T>
void set (const ::std::string &key, T val)
 
template<typename T>
void set (int index, T val)
 
template<typename T>
void setArray (const ::std::string &key, const std::vector< T > &val)
 
void setBool (const ::std::string &key, bool val) override
 
void setBool (unsigned int index, bool val) override
 
void setDouble (const ::std::string &key, double val) override
 
void setDouble (unsigned int index, double val) override
 
void setDoubleArray (const ::std::string &key, const std::vector< double > &val) override
 
void setElement (const ::std::string &key, const armarx::AbstractObjectSerializerPtr &obj) override
 
void setElement (unsigned int index, const armarx::AbstractObjectSerializerPtr &obj) override
 
void setElementType (armarx::ElementType nodeType, const ::Ice::Current &=Ice::emptyCurrent) override
 
void setFloat (const ::std::string &key, float val) override
 
void setFloat (unsigned int index, float val) override
 
void setFloatArray (const ::std::string &key, const std::vector< float > &val) override
 
void setInt (const ::std::string &key, int val) override
 
void setInt (unsigned int index, int val) override
 
void setIntArray (const ::std::string &key, const std::vector< int > &val) override
 
void setString (const ::std::string &key, const std::string &val) override
 
void setString (unsigned int index, const std::string &val) override
 
void setStringArray (const ::std::string &key, const std::vector< std::string > &val) override
 
void setVariantArray (const ::std::string &key, const std::vector< armarx::VariantBasePtr > &val) override
 
void setVariantArray (const ::std::string &key, const std::vector< armarx::VariantPtr > &val) override
 
void setVariantMap (const ::std::string &key, const armarx::StringVariantBaseMap &val) override
 
unsigned int size () const override
 
std::string toString (const ::Ice::Current &=Ice::emptyCurrent) const override
 
 ~JSONObject () override
 
- Public Member Functions inherited from AbstractObjectSerializer
 AbstractObjectSerializer ()
 
 AbstractObjectSerializer (const Ice::CommunicatorPtr ic)
 
SerializablePtr deserializeIceObject ()
 
virtual SerializablePtr getIceObject (const ::std::string &key) const
 
virtual SerializablePtr getIceObject (int index) const
 
std::string getIdField () const
 
int getIntId () const
 
std::string getStringId () const
 
virtual VariantPtr getVariant (const ::std::string &key) const
 
virtual VariantPtr getVariant (int index) const
 
void serializeIceObject (const SerializablePtr &obj)
 
void setIceCommunicator (Ice::CommunicatorPtr ic)
 
virtual void setIceObject (const ::std::string &key, const SerializablePtr &val)
 
virtual void setIceObject (unsigned int index, const SerializablePtr &val)
 
void setId (const std::string &val)
 
void setId (int val)
 
void setIdField (const std::string &fieldName)
 
virtual void setVariant (const ::std::string &key, const VariantPtr &val)
 
virtual void setVariant (unsigned int index, const VariantPtr &val)
 
 ~AbstractObjectSerializer () override
 

Static Public Member Functions

static StringVariantBaseMap ConvertToBasicVariantMap (const JSONObjectPtr &serializer, const VariantBasePtr &variant)
 

Additional Inherited Members

- Protected Member Functions inherited from AbstractObjectSerializer
VariantPtr deserializeVariant ()
 
AbstractObjectSerializerPtr serializeVariant (const VariantPtr &val) const
 
- Protected Attributes inherited from AbstractObjectSerializer
Ice::CommunicatorPtr ic
 
std::string idField
 

Detailed Description

The JSONObject class is used to represent and (de)serialize JSON objects.

Accessing the object is not thread safe. (De)Serializing multiple JSON objects should be done with a new instance for each object.

Constructor & Destructor Documentation

◆ JSONObject() [1/3]

JSONObject ( armarx::ElementType nodeType = armarx::ElementTypes::eObject,
const Ice::CommunicatorPtr ic = Ice::CommunicatorPtr() )

◆ JSONObject() [2/3]

JSONObject ( const Ice::CommunicatorPtr ic)

◆ JSONObject() [3/3]

JSONObject ( const JSONObject & toCopy)

◆ ~JSONObject()

~JSONObject ( )
override

Member Function Documentation

◆ append()

void append ( const armarx::AbstractObjectSerializerPtr & val)
overridevirtual

Implements AbstractObjectSerializer.

◆ asString()

std::string asString ( bool pretty = false) const

◆ ConvertToBasicVariantMap()

StringVariantBaseMap ConvertToBasicVariantMap ( const JSONObjectPtr & serializer,
const VariantBasePtr & variant )
static

◆ createElement()

armarx::AbstractObjectSerializerPtr createElement ( ) const
overridevirtual

Implements AbstractObjectSerializer.

◆ fromString()

void fromString ( const ::std::string & jsonString,
const ::Ice::Current & = Ice::emptyCurrent )
override

◆ getArray()

template<typename T>
void getArray ( const std::string & key,
std::vector< T > & result )
inline

◆ getBool()

bool getBool ( const ::std::string & key) const
overridevirtual

Implements AbstractObjectSerializer.

◆ getDouble()

double getDouble ( const ::std::string & key) const
overridevirtual

Implements AbstractObjectSerializer.

◆ getDoubleArray()

void getDoubleArray ( const ::std::string & key,
std::vector< double > & result )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ getElement() [1/2]

armarx::AbstractObjectSerializerPtr getElement ( const ::std::string & key) const
overridevirtual

Implements AbstractObjectSerializer.

◆ getElement() [2/2]

armarx::AbstractObjectSerializerPtr getElement ( unsigned int index) const
overridevirtual

Implements AbstractObjectSerializer.

◆ getElementNames()

std::vector< std::string > getElementNames ( ) const
overridevirtual

Implements AbstractObjectSerializer.

◆ getElementType()

armarx::ElementType getElementType ( const ::Ice::Current & = Ice::emptyCurrent) const
overridevirtual

Implements AbstractObjectSerializer.

◆ getFloat()

float getFloat ( const ::std::string & key) const
overridevirtual

Implements AbstractObjectSerializer.

◆ getFloatArray()

void getFloatArray ( const ::std::string & key,
std::vector< float > & result )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ getInt()

int getInt ( const ::std::string & key) const
overridevirtual

Implements AbstractObjectSerializer.

◆ getIntArray()

void getIntArray ( const ::std::string & key,
std::vector< int > & result )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ getJsonValue()

const Json::Value & getJsonValue ( ) const

◆ getString()

std::string getString ( const ::std::string & key) const
overridevirtual

Implements AbstractObjectSerializer.

◆ getStringArray()

void getStringArray ( const ::std::string & key,
std::vector< std::string > & result )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ getVariantArray()

void getVariantArray ( const ::std::string & key,
std::vector< armarx::VariantPtr > & result )
overridevirtual

Implements AbstractObjectSerializer.

◆ getVariantMap()

void getVariantMap ( const ::std::string & key,
armarx::StringVariantBaseMap & result )
overridevirtual

Implements AbstractObjectSerializer.

◆ hasElement()

bool hasElement ( const ::std::string & key) const
overridevirtual

Implements AbstractObjectSerializer.

◆ merge()

void merge ( const armarx::AbstractObjectSerializerPtr & val)
overridevirtual

Implements AbstractObjectSerializer.

◆ reset()

void reset ( )
overridevirtual

Implements AbstractObjectSerializer.

◆ set() [1/2]

template<typename T>
void set ( const ::std::string & key,
T val )
inline

◆ set() [2/2]

template<typename T>
void set ( int index,
T val )
inline

◆ setArray()

template<typename T>
void setArray ( const ::std::string & key,
const std::vector< T > & val )
inline

◆ setBool() [1/2]

void setBool ( const ::std::string & key,
bool val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setBool() [2/2]

void setBool ( unsigned int index,
bool val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setDouble() [1/2]

void setDouble ( const ::std::string & key,
double val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setDouble() [2/2]

void setDouble ( unsigned int index,
double val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setDoubleArray()

void setDoubleArray ( const ::std::string & key,
const std::vector< double > & val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setElement() [1/2]

void setElement ( const ::std::string & key,
const armarx::AbstractObjectSerializerPtr & obj )
overridevirtual

Implements AbstractObjectSerializer.

◆ setElement() [2/2]

void setElement ( unsigned int index,
const armarx::AbstractObjectSerializerPtr & obj )
overridevirtual

Implements AbstractObjectSerializer.

◆ setElementType()

void setElementType ( armarx::ElementType nodeType,
const ::Ice::Current & = Ice::emptyCurrent )
overridevirtual

Implements AbstractObjectSerializer.

◆ setFloat() [1/2]

void setFloat ( const ::std::string & key,
float val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setFloat() [2/2]

void setFloat ( unsigned int index,
float val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setFloatArray()

void setFloatArray ( const ::std::string & key,
const std::vector< float > & val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setInt() [1/2]

void setInt ( const ::std::string & key,
int val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setInt() [2/2]

void setInt ( unsigned int index,
int val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setIntArray()

void setIntArray ( const ::std::string & key,
const std::vector< int > & val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setString() [1/2]

void setString ( const ::std::string & key,
const std::string & val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setString() [2/2]

void setString ( unsigned int index,
const std::string & val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setStringArray()

void setStringArray ( const ::std::string & key,
const std::vector< std::string > & val )
inlineoverridevirtual

Implements AbstractObjectSerializer.

◆ setVariantArray() [1/2]

void setVariantArray ( const ::std::string & key,
const std::vector< armarx::VariantBasePtr > & val )
overridevirtual

Implements AbstractObjectSerializer.

◆ setVariantArray() [2/2]

void setVariantArray ( const ::std::string & key,
const std::vector< armarx::VariantPtr > & val )
overridevirtual

Implements AbstractObjectSerializer.

◆ setVariantMap()

void setVariantMap ( const ::std::string & key,
const armarx::StringVariantBaseMap & val )
overridevirtual

Implements AbstractObjectSerializer.

◆ size()

unsigned int size ( ) const
overridevirtual

Implements AbstractObjectSerializer.

◆ toString()

std::string toString ( const ::Ice::Current & = Ice::emptyCurrent) const
override
The documentation for this class was generated from the following files: