ossimRpfLocationSection Class Reference

#include <ossimRpfLocationSection.h>

Public Member Functions
	ossimRpfLocationSection ()
virtual	~ossimRpfLocationSection ()
virtual ossimErrorCode	parseStream (std::istream &in, ossimByteOrder endianOrder)
void	writeStream (std::ostream &out)
	Write method. 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...
bool	hasComponent (ossimRpfComponentId componentId) const
bool	getComponent (ossimRpfComponentId componentId, ossimRpfComponentLocationRecord &result) const
void	addComponentRecord (const ossimRpfComponentLocationRecord &record)
	Method to add a component location record. More...
void	setLocationSectionLength (ossim_uint16 length)
void	setLocationTableOffset (ossim_uint32 offset)
void	setNumberOfComponentLocationRecords (ossim_uint16 count)
void	setLocationRecordLength (ossim_uint16 length)
void	setComponentAggregateLength (ossim_uint32 length)
void	clearFields ()
	Clears records and fields. More...
std::vector< ossimRpfComponentLocationRecord > &	getLocationRecordList ()
	Brief Direct access to the list of records. More...

Private Attributes
ossim_uint16	m_locationSectionLength
ossim_uint32	m_locationTableOffset
ossim_uint16	m_numberOfComponentLocationRecords
ossim_uint16	m_locationRecordLength
ossim_uint32	m_componentAggregateLength
std::vector< ossimRpfComponentLocationRecord >	m_componentLocationList

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

Detailed Description

Definition at line 81 of file ossimRpfLocationSection.h.

Constructor & Destructor Documentation

ossimRpfLocationSection()

ossimRpfLocationSection::ossimRpfLocationSection

(

)

Definition at line 127 of file ossimRpfLocationSection.cpp.

References clearFields().

{
   clearFields();
}

~ossimRpfLocationSection()

virtual ossimRpfLocationSection::~ossimRpfLocationSection ( )

inlinevirtual

Definition at line 87 of file ossimRpfLocationSection.h.

{}

Member Function Documentation

addComponentRecord()

void ossimRpfLocationSection::addComponentRecord

(

const ossimRpfComponentLocationRecord &

record

)

Method to add a component location record.

This will push the record onto the back of theComponentLocationList array.

Parameters

record

Record to add to array.

Definition at line 271 of file ossimRpfLocationSection.cpp.

References m_componentLocationList.

{
   m_componentLocationList.push_back(record);
}

clearFields()

void ossimRpfLocationSection::clearFields

(

)

Clears records and fields.

Public interface to clearFields.

Definition at line 301 of file ossimRpfLocationSection.cpp.

References m_componentAggregateLength, m_componentLocationList, m_locationRecordLength, m_locationSectionLength, m_locationTableOffset, and m_numberOfComponentLocationRecords.

Referenced by ossimRpfLocationSection(), and parseStream().

{
   m_locationSectionLength            = 0;
   m_locationTableOffset              = 0;
   m_numberOfComponentLocationRecords = 0;
   m_locationRecordLength             = 0;
   m_componentAggregateLength         = 0;

   m_componentLocationList.clear();
}

getComponent()

bool ossimRpfLocationSection::getComponent	(	ossimRpfComponentId	componentId,
		ossimRpfComponentLocationRecord &	result
	)		const

Definition at line 251 of file ossimRpfLocationSection.cpp.

References m_componentLocationList.

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(), hasComponent(), ossimRpfFrame::populateColorGrayscaleSection(), ossimRpfFrame::populateMasks(), and ossimRpfFrame::populateReplaceUpdateTable().

{
   std::vector<ossimRpfComponentLocationRecord>::const_iterator component =
      m_componentLocationList.begin();
   
   while(component != m_componentLocationList.end())
   {
      if((*component).m_componentId == static_cast<unsigned short>(componentId))
      {
         result = *component;

         return true;
      }      
      ++component;
   }
   
   return false;
}

getLocationRecordList()

std::vector< ossimRpfComponentLocationRecord > & ossimRpfLocationSection::getLocationRecordList

(

)

Brief Direct access to the list of records.

Definition at line 312 of file ossimRpfLocationSection.cpp.

References m_componentLocationList.

{
   return m_componentLocationList;
}

hasComponent()

bool ossimRpfLocationSection::hasComponent

(

ossimRpfComponentId

componentId

)

const

Will let you know if a component exists within the location section. these component Ids' are defined in the MIL-STD-2411-1 standards doc. the ossimRpfComponentId is in ossimRpfConstants.h

Definition at line 244 of file ossimRpfLocationSection.cpp.

References getComponent().

Referenced by ossimRpfHeader::hasComponent(), and ossimRpfFrame::populateReplaceUpdateTable().

{
   ossimRpfComponentLocationRecord result;
   
   return getComponent(componentId, result);
}

parseStream()

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

virtual

Definition at line 132 of file ossimRpfLocationSection.cpp.

References ossim::byteOrder(), clearFields(), m_componentAggregateLength, m_locationRecordLength, m_locationSectionLength, m_locationTableOffset, m_numberOfComponentLocationRecords, ossimErrorCodes::OSSIM_OK, and ossimEndian::swap().

Referenced by ossimRpfHeader::parseStream().

{
   ossimErrorCode result = ossimErrorCodes::OSSIM_OK;
   
   if(in)
   {
      clearFields();
      
      in.read((char*)&m_locationSectionLength, 2);
      in.read((char*)&m_locationTableOffset, 4);
      in.read((char*)&m_numberOfComponentLocationRecords, 2);
      in.read((char*)&m_locationRecordLength, 2);
      in.read((char*)&m_componentAggregateLength, 4);

      if( ossim::byteOrder() != byteOrder )
      {
         ossimEndian anEndian;
         anEndian.swap(m_locationSectionLength);
         anEndian.swap(m_locationTableOffset);
         anEndian.swap(m_numberOfComponentLocationRecords);
         anEndian.swap(m_locationRecordLength);
         anEndian.swap(m_componentAggregateLength);
      }
      
      if(traceDebug())
      {
         print(ossimNotify(ossimNotifyLevel_DEBUG));
         ossimNotify(ossimNotifyLevel_DEBUG) << std::endl;
      }

      m_componentLocationList.resize(m_numberOfComponentLocationRecords);
      for(ossim_uint32 index = 0;
          (index < m_componentLocationList.size())&&
             (result == ossimErrorCodes::OSSIM_OK);
          ++index)
      {        
         result = m_componentLocationList[index].parseStream(in, byteOrder);
      }
   }
   else
   {
      result = ossimErrorCodes::OSSIM_ERROR;
   }

   return result;
}

print()

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

References m_componentAggregateLength, m_componentLocationList, m_locationRecordLength, m_locationSectionLength, m_locationTableOffset, and m_numberOfComponentLocationRecords.

Referenced by operator<<().

{
   out << prefix << "LocationSectionLength:            "
       << m_locationSectionLength << "\n"
       << prefix << "LocationTableOffset:              "
       << m_locationTableOffset << "\n"
       << prefix << "NumberOfComponentLocationRecords: "
       << m_numberOfComponentLocationRecords << "\n"
       << prefix << "LocationRecordLength:             "
       << m_locationRecordLength << "\n"
       << prefix << "ComponentAggregateLength:         "
       << m_componentAggregateLength << "\n";
   
   if(m_numberOfComponentLocationRecords > 0)
   {
      std::vector<ossimRpfComponentLocationRecord>::const_iterator i =
         m_componentLocationList.begin();
      while (i != m_componentLocationList.end())
      {
         (*i).print(out, prefix);
         ++i;
      }
   }
   return out;
}

setComponentAggregateLength()

void ossimRpfLocationSection::setComponentAggregateLength

(

ossim_uint32

length

)

Definition at line 296 of file ossimRpfLocationSection.cpp.

References m_componentAggregateLength.

{
   m_componentAggregateLength = length;
}

setLocationRecordLength()

void ossimRpfLocationSection::setLocationRecordLength

(

ossim_uint16

length

)

Definition at line 291 of file ossimRpfLocationSection.cpp.

References m_locationRecordLength.

{
   m_locationRecordLength = length;
}

setLocationSectionLength()

void ossimRpfLocationSection::setLocationSectionLength

(

ossim_uint16

length

)

Definition at line 276 of file ossimRpfLocationSection.cpp.

References m_locationSectionLength.

{
   m_locationSectionLength = length;
}

setLocationTableOffset()

void ossimRpfLocationSection::setLocationTableOffset

(

ossim_uint32

offset

)

Definition at line 281 of file ossimRpfLocationSection.cpp.

References m_locationTableOffset.

{
   m_locationTableOffset = offset;
}

setNumberOfComponentLocationRecords()

void ossimRpfLocationSection::setNumberOfComponentLocationRecords

(

ossim_uint16

count

)

Definition at line 286 of file ossimRpfLocationSection.cpp.

References m_numberOfComponentLocationRecords.

{
   m_numberOfComponentLocationRecords = count;
}

writeStream()

void ossimRpfLocationSection::writeStream

(

std::ostream &

out

)

Write method.

Parameters

out	Stream to write to.

Definition at line 181 of file ossimRpfLocationSection.cpp.

References ossim::byteOrder(), m_componentAggregateLength, m_componentLocationList, m_locationRecordLength, m_locationSectionLength, m_locationTableOffset, m_numberOfComponentLocationRecords, OSSIM_BIG_ENDIAN, and ossimEndian::swap().

Referenced by ossimRpfHeader::writeStream().

{
   if( ossim::byteOrder() != OSSIM_BIG_ENDIAN)
   {
      // Always write in big endian.
      ossimEndian endian;
      endian.swap(m_locationSectionLength);
      endian.swap(m_locationTableOffset);
      endian.swap(m_numberOfComponentLocationRecords);
      endian.swap(m_locationRecordLength);
      endian.swap(m_componentAggregateLength);
   }
   
   out.write((char*)&m_locationSectionLength, 2);
   out.write((char*)&m_locationTableOffset, 4);
   out.write((char*)&m_numberOfComponentLocationRecords, 2);
   out.write((char*)&m_locationRecordLength, 2);
   out.write((char*)&m_componentAggregateLength, 4);

   if( ossim::byteOrder() != OSSIM_BIG_ENDIAN)
   {
      // Swap back to native byte order.
      ossimEndian endian;
      endian.swap(m_locationSectionLength);
      endian.swap(m_locationTableOffset);
      endian.swap(m_numberOfComponentLocationRecords);
      endian.swap(m_locationRecordLength);
      endian.swap(m_componentAggregateLength);
   }
   
   for(ossim_uint32 i = 0; i < m_componentLocationList.size(); ++i)
   {
      m_componentLocationList[i].writeStream(out);
   }
}

Friends And Related Function Documentation

operator<<

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

friend

Definition at line 72 of file ossimRpfLocationSection.cpp.

{
   return data.print(out);
}

Member Data Documentation

m_componentAggregateLength

ossim_uint32 ossimRpfLocationSection::m_componentAggregateLength

private

Definition at line 156 of file ossimRpfLocationSection.h.

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

m_componentLocationList

std::vector<ossimRpfComponentLocationRecord> ossimRpfLocationSection::m_componentLocationList

private

Since there are not very many components within an Rpf file it would be overkill to sort these components into an stl map. We will just use an array (stl vector) and do linear searches for components when we need to.

Definition at line 164 of file ossimRpfLocationSection.h.

Referenced by addComponentRecord(), clearFields(), getComponent(), getLocationRecordList(), print(), and writeStream().

m_locationRecordLength

ossim_uint16 ossimRpfLocationSection::m_locationRecordLength

private

Definition at line 154 of file ossimRpfLocationSection.h.

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

m_locationSectionLength

ossim_uint16 ossimRpfLocationSection::m_locationSectionLength

private

This is a 2 byte unsigned short >= 34 indicatin the length in bytes of the entire location section

Definition at line 148 of file ossimRpfLocationSection.h.

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

m_locationTableOffset

ossim_uint32 ossimRpfLocationSection::m_locationTableOffset

private

Definition at line 150 of file ossimRpfLocationSection.h.

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

m_numberOfComponentLocationRecords

ossim_uint16 ossimRpfLocationSection::m_numberOfComponentLocationRecords

private

Definition at line 152 of file ossimRpfLocationSection.h.

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

---

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

• ossimRpfLocationSection.h
• ossimRpfLocationSection.cpp