ossim::JsonParam Class Reference

Represents a single configuration parameter. More...

#include <JsonConfig.h>

Public Types
enum	ParamType {   UNASSIGNED =0, BOOL =1, INT =2, UINT =3,   FLOAT =4, STRING =5, VECTOR =6 }

Public Member Functions
	JsonParam ()
	JsonParam (const ossimString &argname, const ossimString &arglabel, const ossimString &argdescr, ParamType argparamType, void *value)
	JsonParam (const JsonParam &copy)
	~JsonParam ()
bool	loadJSON (const Json::Value &json_node)
	Initializes from a JSON node. More...
void	saveJSON (Json::Value &json_node) const
const ossimString &	name () const
const ossimString &	label () const
const ossimString &	descr () const
ParamType	type () const
bool	isBool () const
bool	asBool () const
bool	isUint () const
unsigned int	asUint () const
bool	isInt () const
int	asInt () const
bool	isFloat () const
double	asFloat () const
bool	isString () const
std::string	asString () const
bool	isVector () const
void	asVector (std::vector< double > &v) const
bool	operator== (const JsonParam &p) const

Private Member Functions
void	setValue (void *value)
void	resetValue ()

Private Attributes
ossimString	_name
ossimString	_label
ossimString	_descr
ParamType	_type
void *	_value
std::vector< ossimString >	_allowedValues

Friends
std::ostream &	operator<< (std::ostream &out, const JsonParam &obj)
	Outputs JSON to output stream provided. More...

Detailed Description

Represents a single configuration parameter.

This class provides for packing and unpacking the parameter from JSON payload, and provides for handling all datatypes of parameters.

Definition at line 112 of file JsonConfig.h.

Member Enumeration Documentation

ParamType

enum ossim::JsonParam::ParamType

Enumerator
UNASSIGNED
BOOL
INT
UINT
FLOAT
STRING
VECTOR

Definition at line 115 of file JsonConfig.h.

                  {
      UNASSIGNED=0,
      BOOL=1,
      INT=2,
      UINT=3,
      FLOAT=4,
      STRING=5,
      VECTOR=6
   };

Constructor & Destructor Documentation

JsonParam() [1/3]

ossim::JsonParam::JsonParam ( )

inline

Definition at line 125 of file JsonConfig.h.

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

JsonParam() [2/3]

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

Definition at line 22 of file JsonConfig.cpp.

References setValue().

:  _name (argname),
   _label (arglabel),
   _descr (argdescr),
   _type (argparamType),
   _value(0)
{
   setValue(value);
}

JsonParam() [3/3]

ossim::JsonParam::JsonParam

(

const JsonParam &

copy

)

Definition at line 36 of file JsonConfig.cpp.

References _value, and setValue().

:  _label (copy._label),
   _name (copy._name),
   _descr (copy._descr),
   _type (copy._type),
   _value (0),
   _allowedValues (copy._allowedValues)
{
   setValue(copy._value);
}

~JsonParam()

ossim::JsonParam::~JsonParam ( )

inline

Definition at line 135 of file JsonConfig.h.

References resetValue().

{ resetValue(); }

Member Function Documentation

asBool()

bool ossim::JsonParam::asBool

(

)

const

Definition at line 257 of file JsonConfig.cpp.

References _type, _value, and BOOL.

Referenced by ATP::AtpGenerator::constructChain(), ATP::ossimAtpTool::doPairwiseMatching(), ATP::AtpTileSource::filterPoints(), ATP::ossimCorrelationSource::findFeatures(), ATP::ossimCorrelationSource::getTile(), and ATP::AtpTileSource::initializeStaticMembers().

{
   if (_type == BOOL)
      return *(bool*)_value;
   return false;
}

asFloat()

double ossim::JsonParam::asFloat

(

)

const

Definition at line 278 of file JsonConfig.cpp.

References _type, _value, FLOAT, and ossim::nan().

Referenced by ATP::AtpAnnotatedImage::annotateCorrelations(), ATP::AtpAnnotatedImage::annotateResiduals(), ATP::AtpGenerator::constructChain(), ATP::ossimCorrelationSource::findFeatures(), ATP::AtpTileSource::initializeStaticMembers(), and ATP::ossimCorrelationSource::OpenCVCorrelation().

{
   if (_type == FLOAT)
      return *(double*)_value;
   return ossim::nan();
}

asInt()

int ossim::JsonParam::asInt

(

)

const

Definition at line 271 of file JsonConfig.cpp.

References _type, _value, INT, and UINT.

Referenced by ATP::AtpAnnotatedImage::AtpAnnotatedImage().

{
   if ((_type == INT) || (_type == UINT))
      return *(int*)_value;
   return 0;
}

asString()

std::string ossim::JsonParam::asString

(

)

const

Definition at line 285 of file JsonConfig.cpp.

References _type, _value, and STRING.

Referenced by ATP::AtpGenerator::constructChain(), ATP::ossimDescriptorSource::getTile(), ATP::AtpGenerator::initialize(), and ATP::ossimAtpTool::loadJSON().

{
   if (_type == STRING)
      return *(string*)_value;
   return "";
}

asUint()

unsigned int ossim::JsonParam::asUint

(

)

const

Definition at line 264 of file JsonConfig.cpp.

References _type, _value, and UINT.

Referenced by ATP::AtpAnnotatedImage::annotateCorrelations(), ATP::AtpAnnotatedImage::annotateResiduals(), ATP::ossimCorrelationSource::correlate(), ATP::ossimCorrelationSource::findFeatures(), ATP::ossimDescriptorSource::getTile(), ATP::ossimCorrelationSource::getTile(), ATP::ossimCorrelationSource::initialize(), ATP::AtpGenerator::initialize(), ATP::AtpTileSource::initializeStaticMembers(), ATP::AtpGenerator::layoutSearchTileRects(), and ATP::ossimCorrelationSource::OpenCVCorrelation().

{
   if (_type == UINT)
      return *(unsigned int*)_value;
   return 0;
}

asVector()

void ossim::JsonParam::asVector

(

std::vector< double > &

v

)

const

Definition at line 292 of file JsonConfig.cpp.

References _type, _value, and VECTOR.

{
   v.clear();
   if (_type == VECTOR)
      v = *(vector<double>*)_value;
}

descr()

const ossimString& ossim::JsonParam::descr ( ) const

inline

Definition at line 144 of file JsonConfig.h.

References _descr.

Referenced by ossim::JsonConfig::loadJSON().

{ return _descr; }

isBool()

bool ossim::JsonParam::isBool ( ) const

inline

Definition at line 147 of file JsonConfig.h.

References _type, and BOOL.

{return (_type == BOOL); }

isFloat()

bool ossim::JsonParam::isFloat ( ) const

inline

Definition at line 156 of file JsonConfig.h.

References _type, and FLOAT.

{return (_type == FLOAT);}

isInt()

bool ossim::JsonParam::isInt ( ) const

inline

Definition at line 153 of file JsonConfig.h.

References _type, and INT.

{return (_type == INT);}

isString()

bool ossim::JsonParam::isString ( ) const

inline

Definition at line 159 of file JsonConfig.h.

References _type, and STRING.

{return (_type == STRING);}

isUint()

bool ossim::JsonParam::isUint ( ) const

inline

Definition at line 150 of file JsonConfig.h.

References _type, and UINT.

{return (_type == UINT); }

isVector()

bool ossim::JsonParam::isVector ( ) const

inline

Definition at line 162 of file JsonConfig.h.

References _type, and VECTOR.

{return (_type == VECTOR);}

label()

const ossimString& ossim::JsonParam::label ( ) const

inline

Definition at line 143 of file JsonConfig.h.

References _label.

{ return _label; }

loadJSON()

bool ossim::JsonParam::loadJSON

(

const Json::Value &

json_node

)

Initializes from a JSON node.

Return true if successful

Definition at line 111 of file JsonConfig.cpp.

References _allowedValues, _descr, _label, _name, _type, BOOL, ossimString::empty(), FLOAT, INT, n, ossimNotify(), ossimNotifyLevel_WARN, setValue(), STRING, UINT, ossimString::upcase(), and VECTOR.

Referenced by ossim::JsonConfig::loadJSON().

{
   try
   {
      _name = paramNode["name"].asString();
      _label = paramNode["label"].asString();
      _descr = paramNode["descr"].asString();
      Json::Value value = paramNode["value"];
      Json::Value allowedValues = paramNode["allowedValues"];

      ossimString ptype = paramNode["type"].asString();
      if (ptype.empty() || _name.empty())
         return false;

      ptype.upcase();

      if (ptype == "VECTOR")
      {
         _type = JsonParam::VECTOR;
         vector<double> v;
         if (value.isArray())
         {
            int n = value.size();
            for (unsigned int j=0; j<n; ++j)
               v.push_back(value[j].asDouble());
         }
         setValue(&v);
      }
      else
      {
         // Screen for param value list as found in the default config JSONs. Pick the first element
         // as the default:
         if (value.isArray())
            value = value[0];

         if (ptype == "BOOL")
         {
            _type = JsonParam::BOOL;
            bool v = value.asBool();
            setValue(&v);
         }
         else if (ptype == "UINT")
         {
            _type = JsonParam::UINT;
            unsigned int v = value.asUInt();
            setValue(&v);
         }
         else if (ptype == "INT")
         {
            _type = JsonParam::INT;
            int v = value.asInt();
            setValue(&v);
         }
         else if (ptype == "FLOAT")
         {
            _type = JsonParam::FLOAT;
            double v = value.asDouble();
            setValue(&v);
         }
         else if (ptype == "STRING")
         {
            _type = JsonParam::STRING;
            string v = value.asString();
            setValue(&v);
            if (!allowedValues.empty() && allowedValues.isArray())
            {
               for (const auto &allowedValue : allowedValues)
                  _allowedValues.emplace_back(allowedValue.asString());
            }
         }
      }
   }
   catch (exception& e)
   {
      ossimNotify(ossimNotifyLevel_WARN)<<"JsonParam::loadJSON() parse error encountered. Ignoring "
            "but should check the JsonConfig JSON for parameter <"<<_name<<">."<<endl;
      return false;
   }
   return true;
}

name()

const ossimString& ossim::JsonParam::name ( ) const

inline

Definition at line 142 of file JsonConfig.h.

References _name.

Referenced by ossim::JsonConfig::loadJSON(), and ossim::JsonConfig::setParameter().

{ return _name; }

operator==()

bool ossim::JsonParam::operator== ( const JsonParam &  p ) const

inline

Definition at line 165 of file JsonConfig.h.

References _name.

{ return (p._name == _name); }

resetValue()

void ossim::JsonParam::resetValue ( )

private

Definition at line 81 of file JsonConfig.cpp.

References _type, _value, BOOL, FLOAT, INT, STRING, UINT, and VECTOR.

Referenced by ~JsonParam().

{
   if (!_value)
      return;

   switch (_type)
   {
   case JsonParam::BOOL:
      delete (bool*)_value;
      break;
   case JsonParam::INT:
   case JsonParam::UINT:
      delete (int*)_value;
      break;
   case JsonParam::FLOAT:
      delete (double*)_value;
      break;
   case JsonParam::STRING:
      delete (string*)_value;
      break;
   case JsonParam::VECTOR:
      ((vector<double>*)_value)->clear();
      delete (vector<double>*)_value;
      break;
   default:
      break;
   }
   _value = 0;
}

saveJSON()

void ossim::JsonParam::saveJSON

(

Json::Value &

json_node

)

const

Definition at line 192 of file JsonConfig.cpp.

References _allowedValues, _descr, _label, _name, _type, _value, BOOL, FLOAT, INT, n, STRING, ossimString::string(), UINT, UNASSIGNED, and VECTOR.

Referenced by ossim::JsonConfig::loadJSON(), and ossim::operator<<().

{
   vector<double>& v = *(vector<double>*)_value; // maybe not used since maybe not valid cast
   unsigned int n = 0;
   int i;
   double f;
   string s;
   bool b;

   paramNode["name"] = _name.string();
   paramNode["label"] = _label.string();
   paramNode["descr"] = _descr.string();

   switch (_type)
   {
   case JsonParam::BOOL:
      paramNode["type"] = "bool";
      b = *(bool*)_value;
      paramNode["value"] = b;
      break;

   case JsonParam::INT:
      paramNode["type"] = "int";
      i = *(int*)_value;
      paramNode["value"] = i;
      break;

   case JsonParam::UINT:
      paramNode["type"] = "uint";
      n = *(unsigned int*)_value;
      paramNode["value"] = n;
      break;

   case JsonParam::FLOAT:
      paramNode["type"] = "float";
      f = *(double*)_value;
      paramNode["value"] = f;
      break;

   case JsonParam::STRING:
      paramNode["type"] = "string";
      s = *(string*)_value;
      paramNode["value"] = s;
      if (!_allowedValues.empty())
      {
         Json::Value allowedValues(Json::arrayValue);
         for (const auto &allowedValue : _allowedValues)
            allowedValues.append(allowedValue.c_str());
         paramNode["allowedValues"] = allowedValues;
      }
      break;

   case JsonParam::VECTOR:
      paramNode["type"] = "vector";
      n = v.size();
      for (unsigned int j=0; j<n; ++j)
         paramNode["value"][j] = v[j];
      break;

   case UNASSIGNED:
   default:
      break;
   }
}

setValue()

void ossim::JsonParam::setValue ( void *  value )

private

Definition at line 47 of file JsonConfig.cpp.

References _type, _value, BOOL, FLOAT, INT, STRING, UINT, and VECTOR.

Referenced by JsonParam(), and loadJSON().

{
   if (!value)
      return;

   switch (_type)
   {
   case JsonParam::BOOL:
      _value = new bool;
      memcpy(_value, value, sizeof(bool));
      break;
   case JsonParam::INT:
      _value = new int;
      memcpy(_value, value, sizeof(int));
      break;
   case JsonParam::UINT:
      _value = new unsigned int;
      memcpy(_value, value, sizeof(unsigned int));
      break;
   case JsonParam::FLOAT:
      _value = new double;
      memcpy(_value, value, sizeof(double));
      break;
   case JsonParam::STRING:
      _value = new string(*(string*)(value));
      break;
   case JsonParam::VECTOR:
      _value = new vector<double>(*(vector<double>*)(value));
      break;
   default:
      _value = 0;
   }
}

type()

ParamType ossim::JsonParam::type ( ) const

inline

Definition at line 145 of file JsonConfig.h.

References _type.

{ return _type; }

Friends And Related Function Documentation

operator<<

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

friend

Outputs JSON to output stream provided.

Definition at line 299 of file JsonConfig.cpp.

{
   Json::Value jsonNode;
   obj.saveJSON(jsonNode);
   out << jsonNode << endl;
   return out;
}

Member Data Documentation

_allowedValues

std::vector<ossimString> ossim::JsonParam::_allowedValues

private

Definition at line 179 of file JsonConfig.h.

Referenced by loadJSON(), and saveJSON().

_descr

ossimString ossim::JsonParam::_descr

private

Definition at line 176 of file JsonConfig.h.

Referenced by descr(), loadJSON(), and saveJSON().

_label

ossimString ossim::JsonParam::_label

private

Definition at line 175 of file JsonConfig.h.

Referenced by label(), loadJSON(), and saveJSON().

_name

ossimString ossim::JsonParam::_name

private

Definition at line 174 of file JsonConfig.h.

Referenced by loadJSON(), name(), operator==(), and saveJSON().

_type

ParamType ossim::JsonParam::_type

private

Definition at line 177 of file JsonConfig.h.

Referenced by asBool(), asFloat(), asInt(), asString(), asUint(), asVector(), isBool(), isFloat(), isInt(), isString(), isUint(), isVector(), loadJSON(), resetValue(), saveJSON(), setValue(), and type().

_value

void* ossim::JsonParam::_value

private

Definition at line 178 of file JsonConfig.h.

Referenced by asBool(), asFloat(), asInt(), asString(), asUint(), asVector(), JsonParam(), resetValue(), saveJSON(), and setValue().

---

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

• JsonConfig.h
• JsonConfig.cpp