ossimSrcRecord.h

Go to the documentation of this file.

//*************************************************************************************************
//                          OSSIM -- Open Source Software Image Map
//
//  LICENSE: See top level LICENSE.txt file.
//   AUTHOR: Oscar Kramer
//
//*************************************************************************************************
//  $Id: ossimSrcRecord.h 2788 2011-06-29 13:20:37Z oscar.kramer $
#ifndef ossimSrcRecord_HEADER
#define ossimSrcRecord_HEADER

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimCommon.h>
#include <ossim/base/ossimString.h>
#include <ossim/base/ossimFilename.h>
#include <ossim/base/ossimKeywordlist.h>
#include <vector>

//*************************************************************************************************
//  CLASS DESCRIPTION: 
//*************************************************************************************************
class OSSIM_DLL ossimSrcRecord
{
public:
   struct PixelFlipParams
   {
   public:
      PixelFlipParams() : 
         replacementMode(""), 
         clampMin(ossim::nan()), clampMax(ossim::nan()),
         clipMin(ossim::nan()), clipMax(ossim::nan()) {}

      ossimString replacementMode;
      double      clampMin;
      double      clampMax;
      double      clipMin;
      double      clipMax;
   };
   ossimSrcRecord();
      
   ossimSrcRecord(const ossimKeywordlist& kwl, ossim_uint32 index=0, ossimString prefix_str="image");
   
   //
   bool loadState(const ossimKeywordlist& kwl, const char* prefix=0);

   bool valid() const { return !m_filename.empty(); }

   const ossimFilename&             getFilename()    const { return m_filename; }
   ossim_int32                      getEntryIndex()  const { return m_entryIndex; }
   const ossimFilename&             getSupportDir()  const { return m_supportDir;}
   const ossimString&               getHistogramOp() const { return m_histogramOp;}
   const std::vector<ossim_uint32>& getBands()       const { return m_bandList; }
   const double&                    getWeight()      const { return m_weight; }  

   const PixelFlipParams&           getPixelFlipParams() const { return m_pixelFlipParams; }
   
   const ossimFilename& getOverviewPath()  const { return m_overviewPath; }
   const ossimFilename& getHistogramPath() const { return m_histogramPath; }
   const ossimFilename& getMaskPath() const { return m_maskPath; }
   const ossimFilename& getGeomPath() const { return m_geomPath; }
   
   void setFilename(const ossimFilename& f);          
   void setEntryIndex(ossim_int32 i);                 
   void setOverview(const ossimFilename& f);          
   void setMask(const ossimFilename& f)              { m_maskPath = f; }
   void setHistogram(const ossimFilename& f)         { m_histogramPath = f; }
   void setHistogramOp(const ossimString& s)         { m_histogramOp = s; }
   void setGeom(const ossimFilename& f);
   void setBands(const std::vector<ossim_uint32>& v) { m_bandList = v; }
   void setWeight(const double& weight)              { m_weight = weight; }
   void setRgbDataBool(bool isRgbData)               { m_isRgbData = isRgbData; }

   void setSupportDir(const ossimFilename& f);

   bool isVectorData() const { return m_isVectorData; }

   bool isRgbData() const { return m_isRgbData; }

   ossimFilename  getRgbFilename     (int band) const { return m_rgbFilenames[band];      }
   ossimFilename  getRgbHistogramPath(int band) const { return m_rgbHistogramPaths[band]; }
   ossimString    getRgbHistogramOp  (int band) const { return m_rgbHistogramOps[band];   }
   ossimFilename  getRgbOverviewPath (int band) const { return m_rgbOverviewPaths[band];  }

   const ossimKeywordlist& getAttributesKwl() const { return m_attributesKwl; }

private:
   ossimFilename m_filename;
   ossim_int32   m_entryIndex;
   ossimFilename m_supportDir;
   std::vector<ossim_uint32> m_bandList;
   ossimString   m_histogramOp;
   double        m_weight;

   ossimFilename m_overviewPath;
   ossimFilename m_histogramPath;
   ossimFilename m_maskPath;
   ossimFilename m_geomPath;

   bool m_isVectorData;
   ossimKeywordlist m_attributesKwl;

   std::vector<ossimString> m_rgbFilenames;
   std::vector<ossimString> m_rgbHistogramPaths;
   std::vector<ossimString> m_rgbHistogramOps;
   std::vector<ossimString> m_rgbOverviewPaths;
   bool m_isRgbData;
   PixelFlipParams m_pixelFlipParams;
};

#endif