ossimNitfFileHeaderV2_0.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
//
// Description: Nitf support class
// 
//********************************************************************
// $Id$ 

#ifndef ossimNitfFileHeaderV2_0_HEADER
#define ossimNitfFileHeaderV2_0_HEADER 1

#include <ossim/support_data/ossimNitfFileHeaderV2_X.h>
#include <ossim/base/ossimFilename.h>
#include <ossim/base/ossimIosFwd.h>
#include <ossim/base/ossimString.h>
#include <ossim/support_data/ossimNitfTagInformation.h>

class ossimNitfRegisteredTag;

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

   ossim_uint32 getHeaderLength()const;
   ossim_uint64 getImageLength()const;
   ossim_uint64 getTotalLength()const;
   void setSubheaderLength(ossim_uint32 length);
   void setImageLength(ossim_uint64 length);

   char theImageSubheaderLength[7];

   char theImageLength[11];
};

struct ossimNitfSymbolInfoRecordV2_0
{
public:
   friend std::ostream& operator <<(std::ostream& out,
                                    const ossimNitfSymbolInfoRecordV2_0 &data);

   ossim_int32 getHeaderLength()const;
   ossim_int32 getImageLength()const;
   ossim_int32 getTotalLength()const;
   
   char theSymbolSubheaderLength[5];

   char theSymbolLength[7];
};

struct ossimNitfLabelInfoRecordV2_0
{
public:
   friend std::ostream& operator <<(std::ostream& out,
                                    const ossimNitfLabelInfoRecordV2_0 &data);

   ossim_int32 getHeaderLength()const;
   ossim_int32 getImageLength()const;
   ossim_int32 getTotalLength()const;
   
   char theLabelSubheaderLength[5];

   char theLabelLength[4];
};

struct ossimNitfTextInfoRecordV2_0
{
public:
   friend std::ostream& operator <<(std::ostream& out,
                                    const ossimNitfTextInfoRecordV2_0 &data);

   ossim_int32 getHeaderLength()const;
   ossim_int32 getImageLength()const;
   ossim_int32 getTotalLength()const;
   char theTextSubheaderLength[5];

   char theTextLength[6];
};

struct ossimNitfDataExtSegInfoRecordV2_0
{
public:
   friend std::ostream& operator <<(std::ostream& out,
                                    const ossimNitfDataExtSegInfoRecordV2_0 &data);

   ossim_int32 getHeaderLength()const;
   ossim_int32 getImageLength()const;
   ossim_int32 getTotalLength()const;
   char theDataExtSegSubheaderLength[5];

   char theDataExtSegLength[10];
};

struct ossimNitfResExtSegInfoRecordV2_0
{
public:
   friend std::ostream& operator <<(std::ostream& out,
                                    const ossimNitfResExtSegInfoRecordV2_0 &data);

   char theResExtSegSubheaderLength[5];

   char theResExtSegLength[8];
};

class OSSIMDLLEXPORT ossimNitfFileHeaderV2_0 : public ossimNitfFileHeaderV2_X
{
public:
   
   ossimNitfFileHeaderV2_0();
   virtual ~ossimNitfFileHeaderV2_0();

   virtual void parseStream(ossim::istream& in);
   
   virtual void writeStream(ossim::ostream& out);
   
   virtual std::ostream& print(std::ostream& out,
                               const std::string& prefix=std::string()) const;
   
   virtual bool isEncrypted()const;
   virtual ossim_int32 getNumberOfImages()const;
   virtual ossim_int32 getNumberOfLabels()const;
   virtual ossim_int32 getNumberOfSymbols()const;
   virtual ossim_int32 getNumberOfGraphics()const;
   virtual ossim_int32 getNumberOfTextSegments()const;
   virtual ossim_int32 getNumberOfDataExtSegments()const;
   virtual ossim_int32 getNumberOfReservedExtSegments()const;
   virtual ossim_int32 getHeaderSize()const;
   virtual ossim_int64 getFileSize()const;
   virtual ossimString getSecurityClassification()const;
   
   virtual const char* getDateTime()const;
   virtual const char* getVersion()const;

   virtual ossimDrect getImageRect()const;
  
   virtual void addImageInfoRecord(const ossimNitfImageInfoRecordV2_0& recordInfo);
   virtual void replaceImageInfoRecord(ossim_uint32 i, const ossimNitfImageInfoRecordV2_0& recordInfo);

   virtual ossimNitfImageHeader*  getNewImageHeader(ossim_uint32 imageNumber,
                                                    ossim::istream& in)const;
   virtual ossimNitfSymbolHeader* getNewSymbolHeader(ossim_uint32 symbolNumber,
                                                     ossim::istream& in)const;
   virtual ossimNitfLabelHeader* getNewLabelHeader(ossim_uint32 labelNumber,
                                                   ossim::istream& in)const;
   virtual ossimNitfTextHeader*   getNewTextHeader(ossim_uint32 textNumber,
                                                   ossim::istream& in)const;
   virtual ossimNitfDataExtensionSegment* getNewDataExtensionSegment(
      ossim_int32 dataExtNumber, ossim::istream& in)const;
   
   virtual ossimNitfImageHeader*  allocateImageHeader()const;
   virtual ossimNitfSymbolHeader* allocateSymbolHeader()const;
   virtual ossimNitfLabelHeader*  allocateLabelHeader()const;
   virtual ossimNitfTextHeader*   allocateTextHeader()const;
   virtual ossimNitfDataExtensionSegment *allocateDataExtSegment()const;

   virtual void setCodeWords(const ossimString& codeWords);
   virtual void setControlAndHandling(const ossimString& controlAndHandling);
   virtual void setReleasingInstructions(const ossimString& releasingInstructions);
   virtual void setClassificationAuthority(const ossimString& classAuth);
   virtual void setSecurityControlNumber(const ossimString& controlNo);
   virtual void setOriginatorsName(const ossimString& originatorName);
   virtual void setOriginatorsPhone(const ossimString& origniatorPhone);

   virtual ossimString getCodeWords()const;
   virtual ossimString getControlAndHandling()const;
   virtual ossimString getReleasingInstructions()const;
   virtual ossimString getClassificationAuthority()const;
   virtual ossimString getSecurityControlNumber()const;
   virtual ossimString getOriginatorsName()const;
   virtual ossimString getOriginatorsPhone()const;

   virtual bool isValid()const;

   ossimString getComplianceLevel()const;
   ossimString getSecurityDowngrade()const;
   ossimString getDowngradingEvent()const;

   void setComplianceLevel(const ossimString& complianceLevel);
   void setSecurityDowngrade(const ossimString& securityDowngrade);
   void setDowngradingEvent(const ossimString& downgradeEvent);

   virtual void setFileLength(ossim_uint64 fileLength);
   virtual void setHeaderLength(ossim_uint64 headerLength);
   static const ossimString FSDWNG_KW;
   static const ossimString FSDEVT_KW;

   virtual void setProperty(ossimRefPtr<ossimProperty> property);
   virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;
   virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;

   
   virtual bool saveState(ossimKeywordlist& kwl, const ossimString& prefix="")const;
TYPE_DATA
private:

   struct ossimNitfDisplayInfo
   {
   public:
      ossimNitfDisplayInfo(const ossimString &filePartType,
                           ossim_int32 displayLevel,
                           ossim_int32 indexIntoList)
         :theFilePartType(filePartType),
          theDisplayLevel(displayLevel),
          theIndex(indexIntoList)
         {
         }
      
      ossimString theFilePartType;

      ossim_int32        theDisplayLevel;

      ossim_int32        theIndex;
      
   };

   void clearFields();
   void setNumberOfImageInfoRecords(ossim_uint64 num);
   
   void precomputeValues();
   
   void readImageInfoRecords(ossim::istream& in);
   void readSymbolInfoRecords(ossim::istream& in);
   void readLabelInfoRecords(ossim::istream& in);
   void readTextFileInfoRecords(ossim::istream& in);
   void readDataExtSegInfoRecords(ossim::istream& in);
   void readResExtSegInfoRecords(ossim::istream& in);
   void initializeAllOffsets();

   void readOverflowTags(ossim::istream& in);

   void initializeDisplayLevels(ossim::istream& in);

   void insertIntoDisplayInfoList(const ossimNitfDisplayInfo &displayInformation);

   
   ossimFilename theFilename;
   
   ossimDrect theImageRect;
   
   std::vector<ossimNitfDisplayInfo>             theDisplayInformationList;
   
   std::vector<ossimNitfImageOffsetInformation>  theImageOffsetList;

   std::vector<ossimNitfSymbolOffsetInformation> theSymbolOffsetList;

   std::vector<ossimNitfLabelOffsetInformation>  theLabelOffsetList;

   std::vector<ossimNitfTextOffsetInformation>   theTextOffsetList;

   std::vector<ossimNitfDataExtSegOffsetInformation> theDataExtSegOffsetList;



   
   // Note: these are work variables and not part of the
   // ossimNitf header.  These variables will be used to quickly
   // access various parts of the file.
   ossim_int32 theHeaderSize;
   
   char theCodewords[41]; 

   char theControlAndHandling[41]; 

   char theReleasingInstructions[41]; 

   char theClassificationAuthority[21];

   char theSecurityControlNumber[21]; 

   char theSecurityDowngrade[7];

   char theDowngradingEvent[41];

   char theOriginatorsName[28];

   char theOriginatorsPhone[19]; 

   char theFileLength[13];

   char theHeaderLength[7];

   char theNumberOfImageInfoRecords[4];

   std::vector<ossimNitfImageInfoRecordV2_0> theNitfImageInfoRecords;

   char theNumberOfSymbolInfoRecords[4];
   std::vector<ossimNitfSymbolInfoRecordV2_0> theNitfSymbolInfoRecords;

   char theNumberOfLabelInfoRecords[4];
   
   std::vector<ossimNitfLabelInfoRecordV2_0> theNitfLabelInfoRecords;

   char theNumberOfTextFileInfoRecords[4];

   std::vector<ossimNitfTextInfoRecordV2_0> theNitfTextInfoRecords;

   char theNumberOfDataExtSegInfoRecords[4];

   std::vector<ossimNitfDataExtSegInfoRecordV2_0> theNitfDataExtSegInfoRecords;

   char theNumberOfResExtSegInfoRecords[4];

   std::vector<ossimNitfResExtSegInfoRecordV2_0> theNitfResExtSegInfoRecords;

   char theUserDefinedHeaderDataLength[6];

   char theUserDefinedHeaderOverflow[4];

   char theExtendedHeaderDataLength[6];

   char theExtendedHeaderOverflow[4];
};

#endif