ossim::JsonConfig Class Reference

Base class for maintaining parameters affecting the runtime configuration of OSSIM executables. More...

#include <JsonConfig.h>

Inheritance diagram for ossim::JsonConfig:

Public Member Functions
	JsonConfig ()
	Default Ctor loads all default .json files in the share/ossim system dir. More...
	JsonConfig (const ossimFilename &configFile)
virtual	~JsonConfig ()
	Destructor. More...
bool	open (const ossimFilename &configFile)
	Opens and parses JSON file. The "parameters" keyword is expected in the root node. More...
virtual void	loadJSON (const Json::Value &params_json_node)
	Reads the params controlling the process from the JSON node named "parameters". More...
virtual void	saveJSON (Json::Value &params_json_node) const
	Reads the params controlling the process from the JSON node named "parameters". More...
JsonParam &	getParameter (const char *paramName)
	Returns a parameter (might be a null parameter if paramName not found in the configuration. More...
void	setParameter (const JsonParam &p)
	Adds parameter to the configuration. More...
bool	diagnosticLevel (unsigned int level) const
	Convenience method returns TRUE if the currently set diagnostic level is <= level. More...
bool	paramExists (const char *paramName) const
Public Member Functions inherited from ossim::JsonInterface
	JsonInterface ()
virtual	~JsonInterface ()

Protected Member Functions
	JsonConfig (const JsonConfig &)
bool	getBoolValue (bool &rtn_val, const std::string &json_value) const

Protected Attributes
std::map< std::string, JsonParam >	m_paramsMap

Static Protected Attributes
static JsonParam	s_nullParam

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

Detailed Description

Base class for maintaining parameters affecting the runtime configuration of OSSIM executables.

The state is imported and exported via JSON. There are default configuration files that should be part of the install, that are accessed by this class. Custom settings can also be loaded.

There are two functionally equivalent forms for specifying parameters: long and short. Parameters are initially declared via the long form with descriptions and default values. These values must be supplied in default JSON files as part of the OSSIM install.

Once the parameters are declared via the long form, the short form can be used to supply runtime overrides.

The long form format is

{ "parameters": [ { "name": "<param_name>", "descr": "<param description", "type": "string"|"float"|"uint"|"int"|"bool", "value":

}, ... ] }

The short form is:

{ "parameters": [ "<param_name>":

, ... ] }

The short form parameter is only accepted if it has previously been loaded via the long form so that the data type is known.

Parameters are usually accessed knowing the data type ahead of time. For example, a string parameter is accessed as:

string paramVal = jsonConfig.getParameter("param_name").asSTring();

If the parameter is not found, the special null-parameter is returned from getParameter(), and casting to a tye will return 0, false, or empty string.

Definition at line 64 of file JsonConfig.h.

Constructor & Destructor Documentation

JsonConfig() [1/3]

ossim::JsonConfig::JsonConfig

(

)

Default Ctor loads all default .json files in the share/ossim system dir.

Definition at line 309 of file JsonConfig.cpp.

References ossimDirectory::findAllFilesThatMatch(), ossimPreferences::instance(), ossimFilename::isDir(), m_paramsMap, ossimDirectory::open(), open(), ossimNotify(), ossimNotifyLevel_WARN, and ossimException::what().

{
   // This ctor could eventually curl a spring config server for the param JSON. For now it
   // is reading the installed share/ossim system directory for config JSON files.

   // The previous parameters list is cleared first for a fresh start:
   m_paramsMap.clear();
   ossimFilename configFilename;
   try
   {
      // First establish the directory location of the default config files:
      ossimFilename shareName (ossimPreferences::instance()->
         preferencesKWL().findKey( std::string( "ossim_share_directory" )));
      if (!shareName.isDir())
         throw ossimException("Nonexistent share drive provided for config files.");

      // Fetch all JSON files:
      ossimDirectory shareDir;
      if (!shareDir.open(shareName))
         throw ossimException("Share drive provided for config files is not readable.");
      std::vector<ossimFilename> jsonFiles;
      shareDir.findAllFilesThatMatch(jsonFiles, ".*\\.json");

      // Process those that contain the "parameters" JSON node:
      for (unsigned int i=0; i<jsonFiles.size(); i++)
      {
         configFilename = jsonFiles[i];
         if (!open(configFilename))
            throw ossimException("Bad file open or parse.");
      }

   }
   catch (ossimException& e)
   {
      ossimNotify(ossimNotifyLevel_WARN)<<"JsonConfig::readConfig():  Could not open/parse "
            "config file at <"<< configFilename << ">. Error: "<<e.what()<<endl;
   }
}

JsonConfig() [2/3]

ossim::JsonConfig::JsonConfig

(

const ossimFilename &

configFile

)

Definition at line 348 of file JsonConfig.cpp.

References open().

{
   if (!open(configFile))
      throw ossimException("Bad file open or parse.");
}

~JsonConfig()

ossim::JsonConfig::~JsonConfig ( )

virtual

Destructor.

Definition at line 354 of file JsonConfig.cpp.

References m_paramsMap.

{
   m_paramsMap.clear();
}

JsonConfig() [3/3]

ossim::JsonConfig::JsonConfig ( const JsonConfig &  )

inlineprotected

Definition at line 99 of file JsonConfig.h.

{}

Member Function Documentation

diagnosticLevel()

bool ossim::JsonConfig::diagnosticLevel

(

unsigned int

level

)

const

Convenience method returns TRUE if the currently set diagnostic level is <= level.

Definition at line 461 of file JsonConfig.cpp.

References m_paramsMap.

Referenced by ATP::AtpGenerator::constructChain(), ATP::ossimCorrelationSource::correlate(), ATP::AtpTileSource::filterPoints(), ATP::AtpTileSource::filterWithoutParallax(), ATP::AtpTileSource::filterWithParallax(), ATP::AtpGenerator::generateTiePointList(), ATP::ossimCorrelationSource::getTile(), ATP::ossimDescriptorSource::getTile(), ATP::AtpGenerator::initialize(), ATP::AtpGenerator::layoutSearchTileRects(), ATP::ossimAtpTool::loadJSON(), main(), and ATP::ossimCorrelationSource::OpenCVCorrelation().

{
   map<string, JsonParam>::const_iterator i = m_paramsMap.find(string("diagnosticLevel"));
   if (i != m_paramsMap.end())
   {
      unsigned int levelSetting = i->second.asUint();
      return (level <= levelSetting);
   }
   return false;
}

getBoolValue()

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

protected

getParameter()

JsonParam & ossim::JsonConfig::getParameter

(

const char *

paramName

)

Returns a parameter (might be a null parameter if paramName not found in the configuration.

Definition at line 377 of file JsonConfig.cpp.

References m_paramsMap, and s_nullParam.

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

{
   map<string, JsonParam>::iterator i = m_paramsMap.find(string(paramName));
   if (i != m_paramsMap.end())
      return i->second;
   return s_nullParam;
}

loadJSON()

void ossim::JsonConfig::loadJSON ( const Json::Value &  params_json_node )

virtual

Reads the params controlling the process from the JSON node named "parameters".

Implements ossim::JsonInterface.

Definition at line 403 of file JsonConfig.cpp.

References ossimString::contains(), ossim::JsonParam::descr(), ossimString::empty(), getParameter(), ossim::JsonParam::loadJSON(), ossim::JsonParam::name(), ossimNotify(), ossimNotifyLevel_WARN, ossim::JsonParam::saveJSON(), setParameter(), and ossimString::string().

Referenced by ATP::ossimAtpTool::loadJSON(), main(), and open().

{
   // Support two forms: long (with full param descriptions and types), or short (just name: value)
   if (json_node.isArray())
   {
      // Long form:
      for (const auto &i : json_node)
      {
         JsonParam p;
         if (p.loadJSON(i))
            setParameter(p);
      }
   }
   else
   {
      // Short form expects a prior entry in the params map whose value will be overriden here:
      Json::Value::Members members = json_node.getMemberNames();
      for (auto &member : members)
      {
         JsonParam& p = getParameter(member.c_str());
         if (p.name().empty())
         {
            ossimNotify(ossimNotifyLevel_WARN)<<"JsonConfig::loadJSON():  Attempted to override "
                  "nonexistent parameter <"<< member << ">. Ignoring request."<<endl;
            continue;
         }
         if (p.descr().contains("DEPRECATED"))
         {
            ossimNotify(ossimNotifyLevel_WARN)<<"JsonConfig::loadJSON()  Parameter "<<p.name()
                  <<" "<<p.descr()<<endl;
            continue;
         }

         // Create a full JSON representation of the named parameter from the default list, replace
         // its value, and recreate the parameter from the updated full JSON:
         Json::Value paramNode;
         p.saveJSON(paramNode);
         paramNode["value"] = json_node[p.name().string()];
         p.loadJSON(paramNode);
     }
   }
}

open()

bool ossim::JsonConfig::open

(

const ossimFilename &

configFile

)

Opens and parses JSON file. The "parameters" keyword is expected in the root node.

Definition at line 359 of file JsonConfig.cpp.

References loadJSON(), and ossimString::string().

Referenced by JsonConfig().

{
   ifstream configFile (configFileName.string());
   if (configFile.fail())
      return false;
   Json::Value jsonRoot;
   configFile >> jsonRoot;
   if (jsonRoot.empty())
      return false;
   if (jsonRoot.isMember("parameters"))
   {
      Json::Value& paramsNode = jsonRoot["parameters"];
      loadJSON(paramsNode);
   }
   configFile.close();
   return true;
}

paramExists()

bool ossim::JsonConfig::paramExists

(

const char *

paramName

)

const

Definition at line 395 of file JsonConfig.cpp.

References m_paramsMap.

Referenced by ATP::AtpTileSource::filterPoints(), ATP::ossimDescriptorSource::getTile(), ATP::ossimCorrelationSource::getTile(), ATP::AtpTileSource::initializeStaticMembers(), and ATP::ossimCorrelationSource::OpenCVCorrelation().

{
   auto i = m_paramsMap.find(string(paramName));
   if (i != m_paramsMap.end())
      return true;
   return false;
}

saveJSON()

void ossim::JsonConfig::saveJSON ( Json::Value &  params_json_node ) const

virtual

Reads the params controlling the process from the JSON node named "parameters".

Implements ossim::JsonInterface.

Definition at line 447 of file JsonConfig.cpp.

References m_paramsMap.

Referenced by ATP::ossimAtpTool::getParameters(), ossimDemTool::getParameters(), and ossim::operator<<().

{

   map<string, JsonParam>::const_iterator param = m_paramsMap.begin();
   int entry = 0;
   while (param != m_paramsMap.end())
   {
      Json::Value paramNode;
      param->second.saveJSON(paramNode);
      json_node[entry++] = paramNode;
      ++param;
   }
}

setParameter()

void ossim::JsonConfig::setParameter

(

const JsonParam &

p

)

Adds parameter to the configuration.

Any previous parameter of the same name is replaced.

Definition at line 385 of file JsonConfig.cpp.

References m_paramsMap, ossim::JsonParam::name(), and ossimString::string().

Referenced by loadJSON().

{
   // Tricky stuff to make sure it is a deep copy of the parameter:
   string key = p.name().string();
   std::map<std::string, JsonParam>::iterator iter = m_paramsMap.find(key);
   if (iter != m_paramsMap.end())
      m_paramsMap.erase(key);
   m_paramsMap.emplace(key, p);
}

Friends And Related Function Documentation

operator<<

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

friend

Outputs JSON to output stream provided.

Definition at line 472 of file JsonConfig.cpp.

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

Member Data Documentation

m_paramsMap

std::map<std::string, JsonParam> ossim::JsonConfig::m_paramsMap

protected

Definition at line 103 of file JsonConfig.h.

Referenced by diagnosticLevel(), getParameter(), JsonConfig(), paramExists(), saveJSON(), setParameter(), and ~JsonConfig().

s_nullParam

JsonParam ossim::JsonConfig::s_nullParam

staticprotected

Definition at line 104 of file JsonConfig.h.

Referenced by getParameter().

---

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

• JsonConfig.h
• JsonConfig.cpp