ossimJ2kSotRecord Class Reference

#include <ossimJ2kSotRecord.h>

Public Member Functions
	ossimJ2kSotRecord ()
	default constructor More...
	~ossimJ2kSotRecord ()
	destructor More...
void	parseStream (ossim::istream &in)
	Parse method. More...
void	writeStream (std::ostream &out)
	Write method. More...
void	setIsot (ossim_uint16 isot)
	Sets the tile index. More...
std::ostream &	print (std::ostream &out, const std::string &prefix=std::string()) const
	print method that outputs a key/value type format adding prefix to keys. More...

Public Attributes
ossim_uint16	theLsot
	Length in bytes of the marker segment. More...
ossim_uint16	theIsot
	Tile index. More...
ossim_uint32	thePsot
	The length in bytes of this record including the SOT marker. More...
ossim_uint8	theTpsot
	Tile-Part index. More...
ossim_uint8	theTnsot
	0 = Number of tile-parts of this tile in the codestream is not defined in this header. More...

Friends
OSSIM_DLL std::ostream &	operator<< (std::ostream &out, const ossimJ2kSotRecord &obj)
	operator<<. More...

Detailed Description

Definition at line 16 of file ossimJ2kSotRecord.h.

Constructor & Destructor Documentation

ossimJ2kSotRecord()

ossimJ2kSotRecord::ossimJ2kSotRecord

(

)

default constructor

Definition at line 25 of file ossimJ2kSotRecord.cpp.

   :
   theLsot(0),
   theIsot(0),
   thePsot(0),
   theTpsot(0),
   theTnsot(0)
{
}

~ossimJ2kSotRecord()

ossimJ2kSotRecord::~ossimJ2kSotRecord

(

)

destructor

Definition at line 35 of file ossimJ2kSotRecord.cpp.

{
}

Member Function Documentation

parseStream()

void ossimJ2kSotRecord::parseStream

(

ossim::istream &

in

)

Parse method.

Performs byte swapping as needed.

Parameters

in	Stream to parse.

Note

Marker is not read.

Definition at line 39 of file ossimJ2kSotRecord.cpp.

References ossim::byteOrder(), OSSIM_LITTLE_ENDIAN, ossimEndian::swap(), theIsot, theLsot, thePsot, theTnsot, and theTpsot.

Referenced by ossimKakaduNitfReader::dumpTiles(), and ossimJ2kInfo::printSotMarker().

{
   // Note: marker not read...
   
   in.read((char*)&theLsot,  2);
   in.read((char*)&theIsot,  2);
   in.read((char*)&thePsot,  4);
   in.read((char*)&theTpsot, 1);
   in.read((char*)&theTnsot, 1);

   if (ossim::byteOrder() == OSSIM_LITTLE_ENDIAN)
   {
      // Stored big endian, must swap.
      ossimEndian endian;
      endian.swap(theLsot);
      endian.swap(theIsot);
      endian.swap(thePsot);
   }
}

print()

std::ostream & ossimJ2kSotRecord::print	(	std::ostream &	out,
		const std::string &	prefix = std::string()
	)		const

print method that outputs a key/value type format adding prefix to keys.

Parameters

out	String to output to.
prefix	This will be prepended to key. e.g. Where prefix = "nitf." and key is "file_name" key becomes: "nitf.file_name:"

Returns

output stream.

Definition at line 98 of file ossimJ2kSotRecord.cpp.

References theIsot, theLsot, thePsot, theTnsot, and theTpsot.

Referenced by ossimKakaduNitfReader::dumpTiles(), operator<<(), and ossimJ2kInfo::printSotMarker().

{
   // Capture the original flags.
   std::ios_base::fmtflags f = out.flags();

   std::string pfx = prefix;
   pfx += "sot.";

   out.setf(std::ios_base::hex, std::ios_base::basefield);
   out << pfx << "marker: 0xff90\n";
   out.setf(std::ios_base::fmtflags(0), std::ios_base::basefield);

   out << pfx << "Lsot:   "  << theLsot      << "\n"
       << pfx << "Isot:   "  << theIsot      << "\n"
       << pfx << "Psot:   "  << thePsot      << "\n"
       << pfx << "Tpsot:  " << int(theTpsot) << "\n"
       << pfx << "Tnsot:  " << int(theTnsot)
       << std::endl;

   // Reset flags.
   out.setf(f);

   return out;
}

setIsot()

void ossimJ2kSotRecord::setIsot

(

ossim_uint16

isot

)

Sets the tile index.

Parameters

isot

Definition at line 93 of file ossimJ2kSotRecord.cpp.

References theIsot.

{
   theIsot = isot;
}

writeStream()

void ossimJ2kSotRecord::writeStream

(

std::ostream &

out

)

Write method.

Note: Write includes two marker bytes.

Parameters

out	Stream to write to.

Definition at line 59 of file ossimJ2kSotRecord.cpp.

References ossim::byteOrder(), OSSIM_LITTLE_ENDIAN, ossimEndian::swap(), theIsot, theLsot, thePsot, theTnsot, and theTpsot.

{
   ossimEndian* endian = 0;
   if (ossim::byteOrder() == OSSIM_LITTLE_ENDIAN)
   {
      // Stored in file big endian, must swap.
      endian = new ossimEndian();
      endian->swap( theLsot );
      endian->swap( theIsot );
      endian->swap( thePsot );      
   }
   
   // Marker 0xff90:
   out.put( 0xff );
   out.put( 0x90 );
   
   out.write( (char*)&theLsot,  2);
   out.write( (char*)&theIsot,  2);
   out.write( (char*)&thePsot,  4);
   out.write( (char*)&theTpsot, 1);
   out.write( (char*)&theTnsot, 1);   
      
   if ( endian )
   {
      // Swap back to native:
      endian->swap(theLsot);
      endian->swap(theIsot);
      endian->swap(thePsot);

      delete endian;
      endian = 0;
   }  
}

Friends And Related Function Documentation

operator<<

OSSIM_DLL std::ostream& operator<< ( std::ostream &  out, const ossimJ2kSotRecord &  obj  )

friend

operator<<.

Definition at line 124 of file ossimJ2kSotRecord.cpp.

{
   return obj.print(out);
}

Member Data Documentation

theIsot

ossim_uint16 ossimJ2kSotRecord::theIsot

Tile index.

Tiles are in raster order starting at 0.

Definition at line 72 of file ossimJ2kSotRecord.h.

Referenced by parseStream(), print(), setIsot(), and writeStream().

theLsot

ossim_uint16 ossimJ2kSotRecord::theLsot

Length in bytes of the marker segment.

Definition at line 69 of file ossimJ2kSotRecord.h.

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

thePsot

ossim_uint32 ossimJ2kSotRecord::thePsot

The length in bytes of this record including the SOT marker.

Definition at line 75 of file ossimJ2kSotRecord.h.

Referenced by ossimKakaduNitfReader::dumpTiles(), parseStream(), print(), ossimJ2kInfo::printSotMarker(), and writeStream().

theTnsot

ossim_uint8 ossimJ2kSotRecord::theTnsot

0 = Number of tile-parts of this tile in the codestream is not defined in this header.

1-255 number of tile-parts of this tile in the codestream.

Definition at line 86 of file ossimJ2kSotRecord.h.

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

theTpsot

ossim_uint8 ossimJ2kSotRecord::theTpsot

Tile-Part index.

Definition at line 78 of file ossimJ2kSotRecord.h.

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

---

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

• ossimJ2kSotRecord.h
• ossimJ2kSotRecord.cpp