ossimNitfFileHeaderV2_1.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_1_HEADER
#define ossimNitfFileHeaderV2_1_HEADER 1

#include <ossim/support_data/ossimNitfFileHeaderV2_X.h>
#include <ossim/base/ossimDate.h>
#include <ossim/base/ossimIosFwd.h>
#include <ossim/base/ossimKeywordlist.h>

class OSSIMDLLEXPORT ossimNitfImageInfoRecordV2_1
{
public:
   friend std::ostream& operator <<(std::ostream& out,
                                    const ossimNitfImageInfoRecordV2_1 &data);
   
   ossim_uint64 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 ossimNitfGraphicInfoRecordV2_1
{
public:
   friend std::ostream& operator <<(std::ostream& out,
                                    const ossimNitfGraphicInfoRecordV2_1 &data);
   
   ossim_uint64 getHeaderLength()const;
   ossim_uint64 getGraphicLength()const;
   ossim_uint64 getTotalLength()const;
   char theGraphicSubheaderLength[5];
   
   char theGraphicLength[7];
};


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


   ossim_uint64 getHeaderLength()const;
   ossim_uint64 getTextLength()const;
   ossim_uint64 getTotalLength()const;

   void setSubheaderLength(ossim_uint64 length);
   void setTextLength(ossim_uint64 length);
   
   char theTextFileSubheaderLength[5];

   char theTextFileLength[6];
};

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

   ossim_uint64 getHeaderLength()const;
   ossim_uint64 getDataExtSegLength()const;
   ossim_uint64 getTotalLength()const;
   char theDataExtSegSubheaderLength[5];

   char theDataExtSegLength[10];
};

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

   ossim_uint64 getHeaderLength()const;
   ossim_uint64 getResExtSegLength()const;
   ossim_uint64 getTotalLength()const;
   char theResExtSegSubheaderLength[5];

   char theResExtSegLength[8];
};

class OSSIMDLLEXPORT ossimNitfFileHeaderV2_1 : public ossimNitfFileHeaderV2_X
{
public:
   
   ossimNitfFileHeaderV2_1();
   virtual ~ossimNitfFileHeaderV2_1();
   virtual void parseStream(ossim::istream& in);
   virtual void writeStream(ossim::ostream& out);
   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 const char* getVersion()const;
   virtual const char* getDateTime()const;
   virtual ossimDrect getImageRect()const;

   virtual void addImageInfoRecord(const ossimNitfImageInfoRecordV2_1& recordInfo);
   virtual void deleteLastImageInfoRecord();
   virtual void deleteLastDataExtSegInfoRecord();

   virtual void addTextInfoRecord(const ossimNitfTextFileInfoRecordV2_1& recordInfo);
    virtual void addDataExtSegInfoRecord(const ossimNitfDataExtSegInfoRecordV2_1& recordInfo);

   virtual void replaceImageInfoRecord(int i, const ossimNitfImageInfoRecordV2_1& 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 ossimString getSecurityClassificationSys()const;
   virtual ossimString getCodeWords()const;
   virtual ossimString getControlAndHandling()const;
   virtual ossimString getReleasingInstructions()const;
   virtual ossimString getDeclassificationType()const;
   virtual ossimString getDeclassificationDate()const;
   virtual ossimString getDeclassificationExemption()const;
   virtual ossimString getDowngrade()const;
   virtual ossimString getDowngradingDate()const;
   virtual ossimString getClassificationText()const;
   virtual ossimString getClassificationAuthorityType()const;
   virtual ossimString getClassificationAuthority()const;
   virtual ossimString getClassificationReason()const;
   virtual ossimString getSecuritySourceDate()const;
   virtual ossimString getSecurityControlNumber()const;
   virtual void getBackgroundColor(ossim_uint8& r,
                                   ossim_uint8& g,
                                   ossim_uint8& b)const;
   virtual ossimString getOriginatorsName()const;
   virtual ossimString getOriginatorsPhone()const;
   
   virtual void setFileLength(ossim_uint64 fileLength);
   virtual void setHeaderLength(ossim_uint64 headerLength);
   
   virtual void setSecurityClassificationSys(const ossimString& value);
   virtual void setCodeWords(const ossimString& codeWords);
   virtual void setControlAndHandling(const ossimString& controlAndHandling);
   virtual void setReleasingInstructions(const ossimString& releasingInstructions);
   virtual void setDeclassificationType(const ossimString& declassType);
   virtual void setDeclassificationDate(const ossimLocalTm& declassDate);
   virtual void setDeclassificationDate(const ossimString& declassDate);
   virtual void setDeclassificationExemption(const ossimString& exemption);
   virtual void setDowngrade(const ossimString& downgrade);
   virtual void setDowngradingDate(const ossimLocalTm& date);
   virtual void setDowngradingDate(const ossimString& date);
   virtual void setClassificationText(const ossimString& classificationText);
   virtual void setClassificationAuthorityType(const ossimString& authorityType);
   virtual void setClassificationAuthority(const ossimString& authorityType);
   virtual void setClassificationReason(const ossimString& reason);
   virtual void setSecuritySourceDate(const ossimLocalTm& date);
   virtual void setSecuritySourceDate(const ossimString& date);
   virtual void setSecurityControlNumber(const ossimString& number);
   virtual void setFileBackgroundColor(ossim_uint8 r,
                                       ossim_uint8 g,
                                       ossim_uint8 b);
   virtual void setOriginatorsName(const ossimString& name);
   virtual void setOriginatorsPhone(const ossimString& phone);
   
   virtual void setProperty(ossimRefPtr<ossimProperty> property);
   virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;
   virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;
   virtual bool isValid()const;

   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=0);

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

   static const ossimString FSCLSY_KW;
   static const ossimString FSDCTP_KW;
   static const ossimString FSDCDT_KW;
   static const ossimString FSDCXM_KW;
   static const ossimString FSDG_KW;
   static const ossimString FSDGDT_KW;
   static const ossimString FSCLTX_KW;
   static const ossimString FSCATP_KW;
   static const ossimString FSCRSN_KW;
   static const ossimString FSSRDT_KW;
   static const ossimString FBKGC_KW;
   
   void clearFields();

   void addTag(ossimNitfTagInformation tag, bool unique = true);
   void removeTag(const ossimString& tagName);
   bool takeOverflowTags(std::vector<ossimNitfTagInformation> &overflowTags,
                         ossim_uint32 potentialDesIndex, bool userDefinedTags = false);
   virtual std::ostream& print(std::ostream& out,
                               const std::string& prefix=std::string()) const;
   
private:
   void setNumberOfImageInfoRecords(ossim_uint64 num);
   void setNumberOfTextInfoRecords(ossim_uint64 num);
   void setNumberOfGraphicInfoRecords(ossim_uint64 num);
   void setNumberOfDataExtSegInfoRecords(ossim_uint64 num);

   void readImageInfoRecords(ossim::istream& in);
   void readGraphicInfoRecords(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 readDes(std::istream& in);     

   // Note: these are work variables and not part of the
   // Nitf header.  These variables will be used to quickly
   // access various parts of the file.
   ossim_uint32 theHeaderSize;

   ossimDrect theImageRect;
   
   std::vector<ossimNitfImageOffsetInformation>  theImageOffsetList;
   
   std::vector<ossimNitfGraphicOffsetInformation> theGraphicOffsetList;
   std::vector<ossimNitfTextOffsetInformation> theTextFileOffsetList;
   std::vector<ossimNitfDataExtSegOffsetInformation> theDataExtSegOffsetList;
   
   // START Of header variables
   char theSecurityClassificationSys[3];

   char theCodewords[12]; 

   char theControlAndHandling[3]; 

   char theReleasingInstructions[21]; 

   char theDeclassificationType[3];

   char theDeclassificationDate[9]; 

   char theDeclassificationExemption[5];
   
   char theDowngrade[2];

   char theDowngradingDate[9];

   char theClassificationText[44];

   char theClassificationAuthorityType[2];

   char theClassificationAuthority[41];

   char theClassificationReason[2];

   char theSecuritySourceDate[9];

   char theSecurityControlNumber[16];
   
   ossim_uint8 theFileBackgroundColor[3];
   
   char theOriginatorsName[25];

   char theOriginatorsPhone[19]; 

   char theFileLength[13];

   char theHeaderLength[7];

   char theNumberOfImageInfoRecords[4];

   std::vector<ossimNitfImageInfoRecordV2_1> theNitfImageInfoRecords;

   char theNumberOfGraphicInfoRecords[4];

   std::vector<ossimNitfGraphicInfoRecordV2_1> theNitfGraphicInfoRecords;

   char theReservedForFutureUse1[4];
   
   char theNumberOfTextFileInfoRecords[4];

   std::vector<ossimNitfTextFileInfoRecordV2_1> theNitfTextFileInfoRecords;

   char theNumberOfDataExtSegInfoRecords[4];

   std::vector<ossimNitfDataExtSegInfoRecordV2_1> theNitfDataExtSegInfoRecords;

   char theNumberOfResExtSegInfoRecords[4];

   std::vector<ossimNitfResExtSegInfoRecordV2_1> theNitfResExtSegInfoRecords;

   char theUserDefinedHeaderDataLength[6];

   char theUserDefinedHeaderOverflow[4];

   char theExtendedHeaderDataLength[6];

   char theExtendedHeaderDataOverflow[4];

TYPE_DATA
};

#endif