ossimRpfToc.h

Go to the documentation of this file.

//*******************************************************************
//
// License:  MIT
//
// See LICENSE.txt file in the top level directory for more details.
// 
// Author: Garrett Potts
//
//*************************************************************************
// $Id: ossimRpfToc.h 18044 2010-09-06 14:20:52Z dburken $
#ifndef osimRpfToc_HEADER
#define osimRpfToc_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimErrorCodes.h>
#include <ossim/base/ossimException.h>
#include <ossim/base/ossimFilename.h>
#include <ossim/base/ossimReferenced.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/support_data/ossimNitfFileHeader.h>
#include <ossim/support_data/ossimRpfHeader.h>

#include <vector>
#include <iosfwd>

class ossimRpfFrameFileIndexSubsection;
class ossimRpfTocEntry;
class ossimRpfFrameEntry;

class OSSIM_DLL ossimRpfToc : public ossimReferenced
{
public:
   friend OSSIM_DLL std::ostream& operator <<(std::ostream& out,
                                              const ossimRpfToc& data);
   ossimRpfToc();

   virtual ~ossimRpfToc();

   ossimErrorCode parseFile(const ossimFilename &fileName,
                            bool keepFileHeader = false);

   void createTocAndCopyFrames( const ossimFilename& dotRpfFile,
                                const ossimFilename& outputDir);

   std::ostream& print( std::ostream& out,
                        const std::string& prefix=std::string(),
                        bool printOverviews=false ) const;
   
   std::ostream& printHeader( std::ostream& out,
                              const std::string& prefix=std::string() ) const;

   std::ostream& printTocEntry( std::ostream& out,
                                ossim_uint32 entryIndex,
                                const std::string& prefix=std::string(),
                                bool printOverviews=false ) const;
   
   
   ossim_uint32 getNumberOfEntries()const;
   
   const ossimRpfTocEntry* getTocEntry(ossim_uint32 index)const;

   ossim_int32 getTocEntryIndex(const ossimRpfTocEntry* entry);

   const ossimNitfFileHeader* getNitfFileHeader()const;
   
   const ossimRpfHeader* getRpfHeader() const;

   ossim_uint32 getNumberOfFramesHorizontal(ossim_uint32 idx)const;

   ossim_uint32 getNumberOfFramesVertical(ossim_uint32 idx)const;

   bool getRpfFrameEntry(ossim_uint32 entryIdx, 
                         ossim_uint32 row,
                         ossim_uint32 col,
                         ossimRpfFrameEntry& result)const;

   const ossimString getRelativeFramePath( ossim_uint32 entryIdx,
                                           ossim_uint32 row,
                                           ossim_uint32 col)const;

   void getRootDirectory(ossimFilename& dir) const;

private:
   void deleteAll();
   void clearAll();
   void deleteTocEntryList();
   void buildTocEntryList(ossimRpfHeader* rpfHeader);
   void allocateTocEntryList(ossim_uint32 numberOfEntries);

   void getFirstEntry(const ossimRpfTocEntry* rpfTocEntry,
                      ossimRpfFrameEntry& frameEntry) const;

   void writeFrameFileIndexSection(ossimRpfFrameFileIndexSubsection* frameFileSubSection,
                                   std::ifstream& dotRpfStr,
                                   std::ofstream& dotTocStr);

   void copyFrames(std::ifstream& dotRpfStr, const ossimFilename& outputDir);

   

   ossim_uint32 getNumberOfFrames(std::ifstream& dotRpfStr) const;

   ossimFilename getSourceTocFile(std::ifstream& dotRpfStr) const;

   bool getCorespondingEntry(ossimRpfFrameFileIndexSubsection* frameFileSubSection,
                             std::ifstream& dotRpfStr,
                             ossim_uint32& entry) const;
   
   bool getFile(const std::string& line, ossimFilename& file) const;

   std::vector<ossimRpfTocEntry*> m_tocEntryList;
   
   ossimFilename m_filename;

   ossimRefPtr<const ossimNitfFileHeader> m_nitfFileHeader;
   
   ossimRefPtr<ossimRpfHeader> m_rpfHeader;
};

#endif