ossimTool.h

Go to the documentation of this file.

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

#ifndef ossimUtility_HEADER
#define ossimUtility_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimObject.h>
#include <ossim/base/ossimArgumentParser.h>
#include <ossim/base/ossimKeywordlist.h>
#include <ossim/base/JsonInterface.h>
#include <iostream>

class OSSIM_DLL ossimTool : public ossimObject, public ossim::JsonInterface

{
public:
   ossimTool();
   virtual ~ossimTool();

   virtual bool initialize(ossimArgumentParser& ap);

   virtual void initialize(const ossimKeywordlist& kwl);

   virtual void loadJSON(const Json::Value& json_request) {};

   virtual void saveJSON(Json::Value& json) const { json.clear(); }

   virtual bool execute() = 0;

   virtual const std::string& getResponse() const { return m_response; }

   virtual void clear();

   virtual void abort();

   virtual void getKwlTemplate(ossimKeywordlist& kwl);

   void getAPI(std::string& out) const;
   std::string getAPI() const;

   virtual ossimString getClassName() const;

   void getBuildDate(std::string& s) const;

   void getRevision(std::string& s) const;

   void getVersion(std::string& s) const;

   // NOTE: The ossimToolFactory::getCapabilities() needs to access a brief description of each
   // utility. For convenience, the ossimTool-derived (final) classes should declare a public
   // static member to hold the description string. See ossimViewshedTool for an example.
   // static const char* DESCRIPTION;

   virtual bool isChipProcessor() const { return false; }

   void setOutputStream(std::ostream* os) { m_consoleStream = os; }

   bool helpRequested() const { return m_helpRequested; }

protected:
   virtual void setUsage(ossimArgumentParser& ap);

   ossimKeywordlist m_kwl;
   std::ostream* m_consoleStream;
   bool m_helpRequested;
   std::string m_response;

private:
   bool readTextFile(const ossimFilename& filename, std::string& contents) const;

};

#endif