ossimNitfTagInformation Class Reference

#include <ossimNitfTagInformation.h>

Inheritance diagram for ossimNitfTagInformation:

Public Member Functions
	ossimNitfTagInformation (ossimRefPtr< ossimNitfRegisteredTag > tagData=0)
virtual	~ossimNitfTagInformation ()
virtual void	parseStream (ossim::istream &in)
virtual void	writeStream (ossim::ostream &out)
void	setTagName (const ossimString &tagName)
void	setTagLength (ossim_uint32 tagLength)
ossim_uint32	getTotalTagLength () const
	Length of the 5 byte tag length the 6 byte tag name and the data length. More...
ossim_uint32	getTagLength () const
	Should return the value of theTagLength which is the length of the data in bytes. More...
ossim_uint64	getTagOffset () const
ossim_uint64	getTagDataOffset () const
ossimString	getTagName () const
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...
void	clearFields ()
ossimRefPtr< ossimNitfRegisteredTag >	getTagData ()
const ossimRefPtr< ossimNitfRegisteredTag >	getTagData () const
void	setTagData (ossimRefPtr< ossimNitfRegisteredTag > tagData)
ossimString	getTagType () const
void	setTagType (const ossimString &tagType) const
bool	operator< (const ossimNitfTagInformation &rhs) const
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimObject *	dup () const
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getDescription () const
virtual ossimString	getClassName () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
virtual void	accept (ossimVisitor &visitor)
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Private Attributes
char	theTagName [7]
	This is a 6 byte field. More...
char	theTagLength [6]
	This is a 5 byte field. More...
char	theTagType [7]
	This is a 6 byte field which should be UDHD, UDID, XHD, IXSHD, SXSHD, or TXSHD. More...
ossim_uint64	theTagOffset
	This will hold the offset to the start of the above information This is just a work variable. More...
ossim_uint64	theTagDataOffset
	This will hold the start to the data. More...
ossimRefPtr< ossimNitfRegisteredTag >	theTagData
	Used to hold the tag data. More...

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 22 of file ossimNitfTagInformation.h.

Constructor & Destructor Documentation

ossimNitfTagInformation()

ossimNitfTagInformation::ossimNitfTagInformation

(

ossimRefPtr< ossimNitfRegisteredTag >

tagData = 0

)

Definition at line 21 of file ossimNitfTagInformation.cpp.

References clearFields(), and setTagData().

{
   clearFields();
   setTagData(tagData);
}

~ossimNitfTagInformation()

ossimNitfTagInformation::~ossimNitfTagInformation ( )

virtual

Definition at line 27 of file ossimNitfTagInformation.cpp.

{
}

Member Function Documentation

clearFields()

void ossimNitfTagInformation::clearFields

(

)

Definition at line 129 of file ossimNitfTagInformation.cpp.

References theTagDataOffset, theTagLength, theTagName, theTagOffset, and theTagType.

Referenced by ossimNitfTagInformation(), parseStream(), and ossimNitfDataExtensionSegmentV2_1::parseStream().

{
   memset(theTagName, ' ', 6);
   memset(theTagLength, 0, 5);
   strcpy(theTagType, "IXSHD ");

   theTagName[6]    = '\0';
   theTagLength[5]  = '\0';
   
   theTagOffset     = 0;
   theTagDataOffset = 0;
}

getTagData() [1/2]

ossimRefPtr< ossimNitfRegisteredTag > ossimNitfTagInformation::getTagData

(

)

Definition at line 172 of file ossimNitfTagInformation.cpp.

References theTagData.

{
   return theTagData;
}

getTagData() [2/2]

const ossimRefPtr< ossimNitfRegisteredTag > ossimNitfTagInformation::getTagData

(

)

const

Definition at line 177 of file ossimNitfTagInformation.cpp.

References theTagData.

{
   return theTagData;
}

getTagDataOffset()

ossim_uint64 ossimNitfTagInformation::getTagDataOffset

(

)

const

Definition at line 107 of file ossimNitfTagInformation.cpp.

References theTagDataOffset.

Referenced by ossimRpfFrameFileReader::parseFile().

{
   return theTagDataOffset;
}

getTagLength()

ossim_uint32 ossimNitfTagInformation::getTagLength

(

)

const

Should return the value of theTagLength which is the length of the data in bytes.

Definition at line 97 of file ossimNitfTagInformation.cpp.

References theTagLength, and ossimString::toUInt32().

Referenced by getTotalTagLength(), and parseStream().

{
   return ossimString(theTagLength).toUInt32();
}

getTagName()

ossimString ossimNitfTagInformation::getTagName

(

)

const

Definition at line 112 of file ossimNitfTagInformation.cpp.

References theTagName, and ossimString::trim().

Referenced by ossimNitfImageHeader::addTag(), ossimNitfFileHeader::addTag(), ossimNitfFileHeaderV2_1::addTag(), ossimRpfFrameFileReader::parseFile(), parseStream(), and ossimNitfFile::print().

{
   return ossimString(theTagName).trim();
}

getTagOffset()

ossim_uint64 ossimNitfTagInformation::getTagOffset

(

)

const

Definition at line 102 of file ossimNitfTagInformation.cpp.

References theTagOffset.

{
   return theTagOffset;
}

getTagType()

ossimString ossimNitfTagInformation::getTagType

(

)

const

Definition at line 195 of file ossimNitfTagInformation.cpp.

References theTagType, and ossimString::trim().

{
   return ossimString(theTagType).trim();
}

getTotalTagLength()

ossim_uint32 ossimNitfTagInformation::getTotalTagLength

(

)

const

Length of the 5 byte tag length the 6 byte tag name and the data length.

So we have Data length + 11 bytes.

Definition at line 92 of file ossimNitfTagInformation.cpp.

References getTagLength().

Referenced by operator<().

{
   return (getTagLength() + (ossim_uint32)11);
}

operator<()

bool ossimNitfTagInformation::operator< ( const ossimNitfTagInformation &  rhs ) const

inline

Definition at line 59 of file ossimNitfTagInformation.h.

References getTotalTagLength().

   {
      return getTotalTagLength() < rhs.getTotalTagLength();
   }

parseStream()

void ossimNitfTagInformation::parseStream ( ossim::istream &  in )

virtual

Definition at line 31 of file ossimNitfTagInformation.cpp.

References clearFields(), ossimNitfTagFactoryRegistry::create(), ossimObject::getClassName(), getTagLength(), ossimNitfRegisteredTag::getTagLength(), getTagName(), ossimNitfRegisteredTag::getTagName(), ossimNitfTagFactoryRegistry::instance(), ossimNotify(), ossimNotifyLevel_WARN, ossimNitfRegisteredTag::parseStream(), ossimNitfRegisteredTag::setTagLength(), ossimNitfRegisteredTag::setTagName(), theTagData, theTagDataOffset, theTagLength, theTagName, theTagOffset, and ossimRefPtr< T >::valid().

Referenced by ossimNitfImageHeaderV2_0::parseStream(), ossimNitfDataExtensionSegmentV2_0::parseStream(), ossimNitfDataExtensionSegmentV2_1::parseStream(), and ossimNitfFileHeaderV2_1::parseStream().

{
   if(in)
   {
      clearFields();
      theTagOffset = in.tellg();
      in.read(theTagName, 6);
      in.read(theTagLength, 5);
      theTagDataOffset = in.tellg();

      theTagData = ossimNitfTagFactoryRegistry::instance()->create(getTagName());

      if (theTagData.valid())
      {
         if (theTagData->getClassName() == "ossimNitfUnknownTag")
         {
            // Unknown tag doesn't know his tag name yet.
            theTagData->setTagName( getTagName() );
         }

         //---
         // Tags with dynamic tag length construct with 0 length.
         // Set if 0.
         //---
         if ( theTagData->getTagLength() == 0 )
         {
            theTagData->setTagLength( getTagLength() );
         }
         // Sanity check fixed length in code with length from CEL field:
         else if ( theTagData->getTagLength() != getTagLength() )
         {
            ossimNotify(ossimNotifyLevel_WARN)
               << "ossimNitfTagInformation::parseStream WARNING!"
               << "\nCEL field length does not match fixed tag length for tag: "
               << theTagData->getTagName().c_str()
               << "\nCEL: " << getTagLength()
               << "\nTag: " << theTagData->getTagLength()
               << std::endl;
         }
                               
         theTagData->parseStream(in);
      }
      else
      {
         theTagData = (ossimNitfRegisteredTag*)NULL;
      }
   }
}

print()

std::ostream & ossimNitfTagInformation::print ( std::ostream &  out ) const

virtual

Generic print method.

Derived classes should re-implement as they see fit.

Returns

std::ostream&

Reimplemented from ossimObject.

Definition at line 117 of file ossimNitfTagInformation.cpp.

References theTagDataOffset, theTagLength, theTagName, theTagOffset, and theTagType.

{
   out << "theTagName:       " << theTagName
       << "\ntheTagLength:     " << theTagLength
       << "\ntheTagType:       " << theTagType
       << "\ntheTagOffset:     " << theTagOffset
       << "\ntheTagDataOffset: " << theTagDataOffset
       << std::endl;

   return out;
}

setTagData()

void ossimNitfTagInformation::setTagData

(

ossimRefPtr< ossimNitfRegisteredTag >

tagData

)

Definition at line 182 of file ossimNitfTagInformation.cpp.

References ossimNitfRegisteredTag::getRegisterTagName(), ossimNitfRegisteredTag::getSizeInBytes(), setTagLength(), setTagName(), theTagData, theTagLength, theTagName, and ossimRefPtr< T >::valid().

Referenced by ossimNitf20Writer::addRegisteredTag(), ossimNitfWriter::addRegisteredTag(), and ossimNitfTagInformation().

{
   theTagData = tagData;

   memset(theTagName, ' ', 6);
   memset(theTagLength, ' ', 5);
   
   if(theTagData.valid())
   {
      setTagName(theTagData->getRegisterTagName());
      setTagLength(theTagData->getSizeInBytes());
   }
}

setTagLength()

void ossimNitfTagInformation::setTagLength

(

ossim_uint32

tagLength

)

Definition at line 154 of file ossimNitfTagInformation.cpp.

References theTagLength.

Referenced by setTagData().

{
   memset(theTagLength, 0, 5);
   
   if(tagLength > 99999)
   {
      tagLength = 99999;
   }

   std::ostringstream out;

   out << std::setw(5)
       << std::setfill('0')
       << tagLength;
   
   memcpy(theTagLength, out.str().c_str(), 5);
}

setTagName()

void ossimNitfTagInformation::setTagName

(

const ossimString &

tagName

)

Definition at line 142 of file ossimNitfTagInformation.cpp.

References theTagName.

Referenced by setTagData().

{
   memset(theTagName, ' ', 6);

   std::ostringstream out;

   out << std::setw(6)
       << std::setfill(' ')
       << tagName;
   memcpy(theTagName, out.str().c_str(), 6);
}

setTagType()

void ossimNitfTagInformation::setTagType

(

const ossimString &

tagType

)

const

Definition at line 200 of file ossimNitfTagInformation.cpp.

References theTagType.

Referenced by ossimNitfWriter::addRegisteredTag(), and ossimNitfFileHeaderV2_1::parseStream().

{
   std::ostringstream out;
   out << std::setw(6)
       << std::setfill(' ')
       << std::setiosflags(std::ios::left)
       << tagType;
   memcpy(theTagType, out.str().c_str(), 6);
   theTagType[6] = 0;
}

writeStream()

void ossimNitfTagInformation::writeStream ( ossim::ostream &  out )

virtual

Definition at line 80 of file ossimNitfTagInformation.cpp.

References theTagData, theTagDataOffset, theTagLength, theTagName, theTagOffset, ossimRefPtr< T >::valid(), and ossimNitfRegisteredTag::writeStream().

{
   theTagOffset = out.tellp(); // Capture the offset.
   out.write(theTagName, 6);
   out.write(theTagLength, 5);
   if(theTagData.valid())
   {
      theTagDataOffset = out.tellp();
      theTagData->writeStream(out);
   }
}

Member Data Documentation

theTagData

ossimRefPtr<ossimNitfRegisteredTag> ossimNitfTagInformation::theTagData

private

Used to hold the tag data.

Definition at line 98 of file ossimNitfTagInformation.h.

Referenced by getTagData(), parseStream(), setTagData(), and writeStream().

theTagDataOffset

ossim_uint64 ossimNitfTagInformation::theTagDataOffset

private

This will hold the start to the data.

This is just the position in the file just past the tag length field. This is just a work variable

Definition at line 93 of file ossimNitfTagInformation.h.

Referenced by clearFields(), getTagDataOffset(), parseStream(), print(), and writeStream().

theTagLength

char ossimNitfTagInformation::theTagLength[6]

private

This is a 5 byte field.

Definition at line 74 of file ossimNitfTagInformation.h.

Referenced by clearFields(), getTagLength(), parseStream(), print(), setTagData(), setTagLength(), and writeStream().

theTagName

char ossimNitfTagInformation::theTagName[7]

private

This is a 6 byte field.

Definition at line 69 of file ossimNitfTagInformation.h.

Referenced by clearFields(), getTagName(), parseStream(), print(), setTagData(), setTagName(), and writeStream().

theTagOffset

ossim_uint64 ossimNitfTagInformation::theTagOffset

private

This will hold the offset to the start of the above information This is just a work variable.

Definition at line 86 of file ossimNitfTagInformation.h.

Referenced by clearFields(), getTagOffset(), parseStream(), print(), and writeStream().

theTagType

char ossimNitfTagInformation::theTagType[7]

mutableprivate

This is a 6 byte field which should be UDHD, UDID, XHD, IXSHD, SXSHD, or TXSHD.

This is declared as mutable since changing the tag type doesn't change the contents of the tag.

Definition at line 80 of file ossimNitfTagInformation.h.

Referenced by clearFields(), getTagType(), print(), and setTagType().

---

The documentation for this class was generated from the following files:

• ossimNitfTagInformation.h
• ossimNitfTagInformation.cpp