ossimRpfComponentLocationRecord Class Reference

#include <ossimRpfLocationSection.h>

Public Member Functions
	ossimRpfComponentLocationRecord ()
	default constructor More...
	ossimRpfComponentLocationRecord (const ossimRpfComponentLocationRecord &record)
	copy constructor More...
const ossimRpfComponentLocationRecord &	operator= (const ossimRpfComponentLocationRecord &rhs)
	assignment operator 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...
ossimErrorCode	parseStream (std::istream &in, ossimByteOrder endianOrder)
void	writeStream (std::ostream &out)
	Write method. More...

Public Attributes
ossim_uint16	m_componentId
ossim_uint32	m_componentLength
ossim_uint32	m_componentLocation

Friends
std::ostream &	operator<< (std::ostream &out, const ossimRpfComponentLocationRecord &data)

Detailed Description

Definition at line 24 of file ossimRpfLocationSection.h.

Constructor & Destructor Documentation

ossimRpfComponentLocationRecord() [1/2]

ossimRpfComponentLocationRecord::ossimRpfComponentLocationRecord

(

)

default constructor

Definition at line 31 of file ossimRpfLocationSection.cpp.

   : m_componentId(0),
     m_componentLength(0),
     m_componentLocation(0)
{
}

ossimRpfComponentLocationRecord() [2/2]

ossimRpfComponentLocationRecord::ossimRpfComponentLocationRecord

(

const ossimRpfComponentLocationRecord &

record

)

copy constructor

Definition at line 38 of file ossimRpfLocationSection.cpp.

   : m_componentId(record.m_componentId),
     m_componentLength(record.m_componentLength),
     m_componentLocation(record.m_componentLocation)
{
}

Member Function Documentation

operator=()

const ossimRpfComponentLocationRecord & ossimRpfComponentLocationRecord::operator=

(

const ossimRpfComponentLocationRecord &

rhs

)

assignment operator

Definition at line 46 of file ossimRpfLocationSection.cpp.

References m_componentId, m_componentLength, and m_componentLocation.

{
   if (this != &rhs)
   {
      m_componentId       = rhs.m_componentId;
      m_componentLength   = rhs.m_componentLength;
      m_componentLocation = rhs.m_componentLocation;
   }
   return *this;
}

parseStream()

ossimErrorCode ossimRpfComponentLocationRecord::parseStream	(	std::istream &	in,
		ossimByteOrder	endianOrder
	)

Definition at line 77 of file ossimRpfLocationSection.cpp.

References ossim::byteOrder(), m_componentId, m_componentLength, m_componentLocation, ossimErrorCodes::OSSIM_ERROR, ossimErrorCodes::OSSIM_OK, and ossimEndian::swap().

{
   if(in)
   {
      in.read((char*)&m_componentId, 2);
      in.read((char*)&m_componentLength, 4);
      in.read((char*)&m_componentLocation, 4);

      if( ossim::byteOrder() != byteOrder)
      {
         // swap to native
         ossimEndian anEndian;
         anEndian.swap(m_componentId);
         anEndian.swap(m_componentLength);
         anEndian.swap(m_componentLocation);
      }
   }
   else
   {
      return ossimErrorCodes::OSSIM_ERROR;
   }

   return  ossimErrorCodes::OSSIM_OK;
}

print()

std::ostream & ossimRpfComponentLocationRecord::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 58 of file ossimRpfLocationSection.cpp.

References ossimLookUpTable::getEntryString(), ossimRpfComponentIdLut::instance(), m_componentId, m_componentLength, and m_componentLocation.

Referenced by operator<<().

{
   out << prefix << "ComponentId:             "
       << m_componentId << "\n"
       << prefix << "ComponentIdString:       "
       << ossimRpfComponentIdLut::instance()->getEntryString(m_componentId) << "\n"
       << prefix << "ComponentLength:         "
       << m_componentLength   << "\n"
       << prefix << "ComponentLocation:       "
       << m_componentLocation << "\n";
   return out;
}

writeStream()

void ossimRpfComponentLocationRecord::writeStream

(

std::ostream &

out

)

Write method.

Parameters

out	Stream to write to.

Definition at line 103 of file ossimRpfLocationSection.cpp.

References ossim::byteOrder(), m_componentId, m_componentLength, m_componentLocation, OSSIM_BIG_ENDIAN, and ossimEndian::swap().

{
   if( ossim::byteOrder() != OSSIM_BIG_ENDIAN)
   {
      ossimEndian endian;
      endian.swap(m_componentId);
      endian.swap(m_componentLength);
      endian.swap(m_componentLocation);
   }

   out.write((char*)&m_componentId, 2);
   out.write((char*)&m_componentLength, 4);
   out.write((char*)&m_componentLocation, 4);

   if( ossim::byteOrder() != OSSIM_BIG_ENDIAN)
   {
      // Swap back to native byte order.
      ossimEndian endian;
      endian.swap(m_componentId);
      endian.swap(m_componentLength);
      endian.swap(m_componentLocation);
   }
}

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const ossimRpfComponentLocationRecord &  data  )

friend

Definition at line 26 of file ossimRpfLocationSection.cpp.

{
   return data.print(out);
}

Member Data Documentation

m_componentId

ossim_uint16 ossimRpfComponentLocationRecord::m_componentId

The component is a 2-Byte unsigned value which identitfies a level-2 component. The table can be found in MIL-STD-2411-1 in section 5.1.1 and in ossimRpfConstants.h.

Definition at line 65 of file ossimRpfLocationSection.h.

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

m_componentLength

ossim_uint32 ossimRpfComponentLocationRecord::m_componentLength

Is a 4 byte unsigned integer indicating the length in bytes of the component.

Definition at line 71 of file ossimRpfLocationSection.h.

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

m_componentLocation

ossim_uint32 ossimRpfComponentLocationRecord::m_componentLocation

Is a 4 byte value defining the absolute address (byte number) of the first byte of the component measured from the beginning of the RPF Frame file.

Definition at line 78 of file ossimRpfLocationSection.h.

Referenced by ossimRpfFrame::fillSubFrameBuffer(), ossimRpfHeader::getNewAttributeSectionSubheader(), ossimRpfHeader::getNewBoundaryRectSectSubheader(), ossimRpfHeader::getNewBoundaryRectTable(), ossimRpfHeader::getNewColorGrayscaleSubheader(), ossimRpfHeader::getNewCompressionSection(), ossimRpfHeader::getNewCompressionSectionSubheader(), ossimRpfHeader::getNewCoverageSection(), ossimRpfHeader::getNewFileIndexSubsection(), ossimRpfHeader::getNewFrameFileIndexSectionSubheader(), ossimRpfHeader::getNewImageDescriptionSubheader(), ossimRpfHeader::getNewImageDisplayParameterSubheader(), ossimRpfHeader::getNewMaskSubsection(), operator=(), parseStream(), ossimRpfFrame::populateColorGrayscaleSection(), ossimRpfFrame::populateMasks(), ossimRpfFrame::populateReplaceUpdateTable(), print(), and writeStream().

---

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

• ossimRpfLocationSection.h
• ossimRpfLocationSection.cpp