JsonConfig.h

Go to the documentation of this file.

//**************************************************************************************************
//
//     OSSIM Open Source Geospatial Data Processing Library
//     See top level LICENSE.txt file for license information
//
//**************************************************************************************************

#pragma once

#include <ostream>
#include <ossim/plugin/ossimPluginConstants.h>
#include <ossim/base/JsonInterface.h>
#include <ossim/base/ossimFilename.h>
#include <vector>
#include <map>

namespace ossim
{
// Forward decl defined after JsonParam
class JsonParam;

class OSSIM_DLL JsonConfig : public ossim::JsonInterface
{
public:
   JsonConfig();

   JsonConfig(const ossimFilename& configFile);

   virtual ~JsonConfig();

   bool open(const ossimFilename& configFile);

   virtual void loadJSON(const Json::Value& params_json_node);

   virtual void saveJSON(Json::Value& params_json_node) const;

   JsonParam& getParameter(const char* paramName);

   void setParameter(const JsonParam& p);

   bool diagnosticLevel(unsigned int level) const;

   friend std::ostream& operator<<(std::ostream& out, const JsonConfig& obj);

   bool paramExists(const char* paramName) const;

protected:
   JsonConfig(const JsonConfig& /*hide_this*/) {}

   bool getBoolValue(bool& rtn_val, const std::string& json_value) const;

   std::map<std::string, JsonParam> m_paramsMap;
   static JsonParam s_nullParam;
};


class JsonParam
{
public:
   enum ParamType {
      UNASSIGNED=0,
      BOOL=1,
      INT=2,
      UINT=3,
      FLOAT=4,
      STRING=5,
      VECTOR=6
   };

   JsonParam() : _type(UNASSIGNED), _value(0) {}

   JsonParam(const ossimString& argname,
            const ossimString& arglabel,
            const ossimString& argdescr,
            ParamType   argparamType,
            void* value);

   JsonParam(const JsonParam& copy);

   ~JsonParam() { resetValue(); }

   bool loadJSON(const Json::Value& json_node);

   void saveJSON(Json::Value& json_node) const;

   const ossimString& name() const { return _name; }
   const ossimString& label() const { return _label; }
   const ossimString& descr() const { return _descr; }
   ParamType    type() const { return _type; }

   bool isBool() const  {return (_type == BOOL); }
   bool asBool() const;

   bool isUint() const  {return (_type == UINT); }
   unsigned int asUint() const;

   bool isInt() const  {return (_type == INT);}
   int  asInt() const;

   bool isFloat() const {return (_type == FLOAT);}
   double asFloat() const;

   bool isString() const {return (_type == STRING);}
   std::string asString() const;

   bool isVector() const {return (_type == VECTOR);}
   void asVector(std::vector<double>& v) const;

   bool operator==(const JsonParam& p) const { return (p._name == _name); }

   friend std::ostream& operator<<(std::ostream& out, const JsonParam& obj);

private:
   void setValue(void* value);
   void resetValue();

   ossimString _name;
   ossimString _label;
   ossimString _descr;
   ParamType   _type;
   void*       _value;
   std::vector<ossimString> _allowedValues; // only used for multiple-choice string parameters
};


}