ossimDataObject Class Reference

#include <ossimDataObject.h>

Inheritance diagram for ossimDataObject:

Public Member Functions
	ossimDataObject (ossimSource *source=0, ossimDataObjectStatus status=OSSIM_STATUS_UNKNOWN)
	ossimDataObject (const ossimDataObject &rhs)
virtual	~ossimDataObject ()
virtual ossim_uint32	getHashId () const =0
virtual void	setOwner (ossimSource *aSource)
	Sets the owner of this Data object. More...
virtual ossimSource *	getOwner ()
virtual const ossimSource *	getOwner () const
virtual void	setDataObjectStatus (ossimDataObjectStatus status) const
	Full list found in ossimConstants.h. More...
virtual ossimDataObjectStatus	getDataObjectStatus () const
virtual ossimString	getDataObjectStatusString () const
virtual ossim_uint32	getObjectSizeInBytes () const
virtual ossim_uint32	getDataSizeInBytes () const =0
virtual bool	isInitialize () const
	This is to be overriden in the derived classes so they can check If their data is null. More...
virtual void	initialize ()=0
	Will allow derived classes to initialize their buffers. More...
virtual void	assign (const ossimDataObject *rhs)
virtual const ossimDataObject *	operator= (const ossimDataObject *rhs)
virtual const ossimDataObject &	operator= (const ossimDataObject &rhs)
virtual bool	operator== (const ossimDataObject &rhs) const
virtual bool	operator!= (const ossimDataObject &rhs) const
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
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	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

Protected Attributes
ossimSource *	theOwner
ossimDataObjectStatus	theDataObjectStatus

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

Detailed Description

Definition at line 22 of file ossimDataObject.h.

Constructor & Destructor Documentation

ossimDataObject() [1/2]

ossimDataObject::ossimDataObject	(	ossimSource *	source = 0,
		ossimDataObjectStatus	status = OSSIM_STATUS_UNKNOWN
	)

Definition at line 17 of file ossimDataObject.cpp.

   :
      theOwner(source),
      theDataObjectStatus(status)
{
}

ossimDataObject() [2/2]

ossimDataObject::ossimDataObject

(

const ossimDataObject &

rhs

)

Definition at line 25 of file ossimDataObject.cpp.

   : ossimObject(),
     theOwner(0),
     theDataObjectStatus(rhs.theDataObjectStatus)
{
}

~ossimDataObject()

ossimDataObject::~ossimDataObject ( )

virtual

Definition at line 32 of file ossimDataObject.cpp.

{
}

Member Function Documentation

assign()

void ossimDataObject::assign ( const ossimDataObject *  rhs )

virtual

Reimplemented in ossimImageData.

Definition at line 114 of file ossimDataObject.cpp.

References theDataObjectStatus, and theOwner.

Referenced by ossimRectilinearDataObject::assign(), and operator=().

{
   if(rhs != this)
   {
      theOwner               = rhs->theOwner;
      theDataObjectStatus     = rhs->theDataObjectStatus;
   }
}

getDataObjectStatus()

ossimDataObjectStatus ossimDataObject::getDataObjectStatus ( ) const

virtual

Returns

Returns enumerated status: OSSIM_STATUS_UNKNOWN = 0 OSSIM_NULL = 1 OSSIM_EMPTY = 2 OSSIM_PARTIAL = 3 OSSIM_FULL = 4

Definition at line 56 of file ossimDataObject.cpp.

References theDataObjectStatus.

Referenced by ossimCastTileSourceFilter::applyCast(), ossimEquationCombiner::applyClamp(), ossimMeanMedianFilter::applyMean(), ossimMeanMedianFilter::applyMeanNullCenterOnly(), ossimMeanMedianFilter::applyMedian(), ossimMeanMedianFilter::applyMedianNullCenterOnly(), ossimEquationCombiner::applyOp(), ossimImageData::assignBand(), ossimEquationCombiner::assignValue(), ossimPixelFlipper::clipTile(), ossimElevationMosaic::combine(), ossimImageMosaic::combine(), ossimMaxMosaic::combine(), ossimBlendMosaic::combine(), ossimFeatherMosaic::combine(), ossimElevationMosaic::combineNorm(), ossimImageMosaic::combineNorm(), ossimMaxMosaic::combineNorm(), ossimBlendMosaic::combineNorm(), ossimImageData::computeAlphaChannel(), ossimImageData::computeAverageBandValue(), ossimImageHistogramSource::computeFastModeHistogram(), ossimHistogramRemapper::computeHistogram(), ossimBrightnessMatch::computeInputBrightness(), ossimIntensityAdjustmentFilter::computeMeanIntensity(), ossimImageData::computeMeanSquaredError(), ossimImageHistogramSource::computeNormalModeHistogram(), ATP::AtpTileSource::computeParallax(), ossimImageStatisticsSource::computeStatisticsTemplate(), ossimNBandToIndexFilter::convertInputTileToOutputTemplate(), ossimS16ImageData::convertToNormalizedDouble(), ossimU11ImageData::convertToNormalizedDouble(), ossimU12ImageData::convertToNormalizedDouble(), ossimU13ImageData::convertToNormalizedDouble(), ossimU14ImageData::convertToNormalizedDouble(), ossimU15ImageData::convertToNormalizedDouble(), ossimU8ImageData::convertToNormalizedDouble(), ossimU16ImageData::convertToNormalizedDouble(), ossimImageData::convertToNormalizedDouble(), ossimS16ImageData::convertToNormalizedFloat(), ossimU11ImageData::convertToNormalizedFloat(), ossimU12ImageData::convertToNormalizedFloat(), ossimU13ImageData::convertToNormalizedFloat(), ossimU14ImageData::convertToNormalizedFloat(), ossimU15ImageData::convertToNormalizedFloat(), ossimU8ImageData::convertToNormalizedFloat(), ossimU16ImageData::convertToNormalizedFloat(), ossimImageData::convertToNormalizedFloat(), ossimConvolutionSource::convolve(), ossimImageData::copyNormalizedBufferToTile(), ossimImageData::copyTileBandToNormalizedBuffer(), ossimImageData::copyTileToNormalizedBuffer(), ossimImageData::createTestTile(), demo1(), demo3(), ossimDilationFilter::doDilation(), ossimErosionFilter::doErosion(), ossimJpegCodec::encode(), ossimMaskFilter::executeMaskFilter(), ossimMaskFilter::executeMaskFilterInvertSelection(), ossimMaskFilter::executeMaskFilterSelection(), ossimMaskFilter::executeMaskFilterWeighted(), ossimTopographicCorrectionFilter::executeTopographicCorrectionMinnaertTemplate(), ossimTopographicCorrectionFilter::executeTopographicCorrectionTemplate(), ossimCacheTileSource::fillTile(), ossimImageRenderer::fillTile(), ossimGeoPdfReader::fillTile(), ossimTilePatch::fillTileTemplate(), ATP::ossimCorrelationSource::findFeatures(), ossimClosestToCenterCombiner::findIdx(), ossimNullPixelFlip::flipPixels(), ossimImageCombiner::getNextNormTile(), ossimImageCombiner::getNextTile(), ossimS16ImageData::getNormalizedFloat(), ossimU11ImageData::getNormalizedFloat(), ossimU12ImageData::getNormalizedFloat(), ossimU13ImageData::getNormalizedFloat(), ossimU14ImageData::getNormalizedFloat(), ossimU15ImageData::getNormalizedFloat(), ossimU8ImageData::getNormalizedFloat(), ossimU16ImageData::getNormalizedFloat(), ossimImageData::getNormalizedFloat(), ossimFusionCombiner::getNormIntensity(), ossimFusionCombiner::getNormTile(), ossimIntensityAdjustmentFilter::getTile(), ossimHsvToRgbSource::getTile(), ossimRgbToHsiSource::getTile(), ossimRgbToHsvSource::getTile(), ossimRgbToJpegYCbCrSource::getTile(), ossimJpegYCbCrToRgbSource::getTile(), ossimHsiToRgbSource::getTile(), ossimColorNormalizedFusion::getTile(), ossimHistogramThreshholdFilter::getTile(), ossimHistogramEqualization::getTile(), ossimMultiBandHistogramTileSource::getTile(), ossimTrimFilter::getTile(), ossimSICDToDetectedImage::getTile(), ossim3x3ConvolutionFilter::getTile(), ossimHistoMatchRemapper::getTile(), ATP::ossimDescriptorSource::getTile(), ATP::ossimCorrelationSource::getTile(), ossimNullPixelFlip::getTile(), ossimRgbToGreyFilter::getTile(), ossimBrightnessContrastSource::getTile(), ossimGammaRemapper::getTile(), ossimPolyCutter::getTile(), ossimAOD::getTile(), ossimBandMergeSource::getTile(), ossimSFIMFusion::getTile(), ossimBandSelector::getTile(), ossimMapCompositionSource::getTile(), ossimRectangleCutFilter::getTile(), ossimTableRemapper::getTile(), ossimShiftFilter::getTile(), ossimLinearStretchRemapper::getTile(), ossimLocalCorrelationFusion::getTile(), ossimAnnotationSource::getTile(), ossimUsgsDemTileSource::getTile(), ossimJpegTileSource::getTile(), ossimTiledImagePatch::getTile(), ossimBandAverageFilter::getTile(), ossimHsiRemapper::getTile(), ossimGpkgReader::getTile(), ossimValueAssignImageSourceFilter::getTile(), ossimHdf5ImageHandler::getTile(), ossimCcfTileSource::getTile(), ossimDtedTileSource::getTile(), ossimConvolutionFilter1D::getTile(), ossimPngReader::getTile(), ossimH5ImageHandler::getTile(), ossimHistogramRemapper::getTile(), ossimBandClipFilter::getTile(), ossimKMeansFilter::getTile(), ossimAdrgTileSource::getTile(), ossimHdfReader::getTile(), ossimTopographicCorrectionFilter::getTile(), ossimPointCloudImageHandler::getTile(), ossimWatermarkFilter::getTile(), ossimLasReader::getTile(), ossimTiffTileSource::getTile(), ossimGridRemapSource::getTile(), ossimImageSourceSequencer::getTile(), ossimGeoPdfReader::getTile(), ossimRpfCacheTileSource::getTile(), ossimTiledImageHandler::getTile(), ossimNitfTileSource::getTile(), ossimCibCadrgTileSource::getTile(), ossimBandLutFilter::getTile(), ossimBumpShadeTileSource::getTile(), ossimIndexToRgbLutFilter::getTile(), ossimMaskFilter::getTile(), ossimImageRenderer::getTileAtResLevel(), ossimGdalDatasetRasterBand::IReadBlock(), isInitialize(), ossimImageData::loadBandTemplate(), ossimImageData::loadShortBand(), ossimImageData::loadTile(), ossimImageData::loadTileFromBilTemplate(), ossimImageData::loadTileFromBipAlphaTemplate(), ossimImageData::loadTileFromBipTemplate(), ossimImageData::loadTileFromBsqTemplate(), ossimImageData::makeBlank(), ossimImageData::nullTileAlphaTemplate(), ossimImageData::populateHistogram(), ossimBrightnessContrastSource::processRgbTile(), ossimResampler::resampleTile(), ossimImageRenderer::resampleTileToDecimation(), ossimBandClipFilter::runClamp(), ossimHistogramEqualization::runEqualizationAlgorithm(), ossimScaleFilter::runFilterTemplate(), ossimBandClipFilter::runLinearStretch(), ossimBandClipFilter::runMedianStretch(), ossimRgbImage::setCurrentImageData(), ossimS16ImageData::setNormalizedFloat(), ossimU14ImageData::setNormalizedFloat(), ossimU11ImageData::setNormalizedFloat(), ossimU15ImageData::setNormalizedFloat(), ossimU13ImageData::setNormalizedFloat(), ossimU12ImageData::setNormalizedFloat(), ossimU8ImageData::setNormalizedFloat(), ossimU16ImageData::setNormalizedFloat(), ossimImageData::setNormalizedFloat(), ossimImageData::stretchMinMax(), ossimImageData::unloadBandTemplate(), ossimImageData::unloadBandToBsqTemplate(), ossimImageData::unloadTileToBilTemplate(), ossimImageData::unloadTileToBipAlphaTemplate(), ossimImageData::unloadTileToBipTemplate(), ossimImageData::unloadTileToBsqTemplate(), ossimS16ImageData::validate(), ossimU13ImageData::validate(), ossimU11ImageData::validate(), ossimU15ImageData::validate(), ossimU14ImageData::validate(), ossimU12ImageData::validate(), ossimU8ImageData::validate(), ossimU16ImageData::validate(), ossimImageData::validate(), ossimOpjCompressor::writeTile(), ossimKakaduCompressor::writeTile(), and ossimGpkgWriter::writeTile().

{
   return theDataObjectStatus;
}

getDataObjectStatusString()

ossimString ossimDataObject::getDataObjectStatusString ( ) const

virtual

Returns

Returns the status as a string, like "OSSIM_NULL".

Definition at line 61 of file ossimDataObject.cpp.

References OSSIM_EMPTY, OSSIM_FULL, OSSIM_NULL, OSSIM_PARTIAL, OSSIM_STATUS_UNKNOWN, and theDataObjectStatus.

Referenced by print(), and saveState().

{
   ossimString s;
   
   switch (theDataObjectStatus)
   {
      case OSSIM_NULL:
         s = "OSSIM_NULL";
         break;

      case OSSIM_EMPTY:
         s = "OSSIM_EMPTY";
         break;

      case OSSIM_PARTIAL:
         s = "OSSIM_PARTIAL";
         break;

      case OSSIM_FULL:
         s = "OSSIM_FULL";
         break;
         
      case OSSIM_STATUS_UNKNOWN:
      default:
         s = "OSSIM_STATUS_UNKNOWN";
         break;
   }
   
   return s;
}

getDataSizeInBytes()

virtual ossim_uint32 ossimDataObject::getDataSizeInBytes ( ) const

pure virtual

Implemented in ossimImageData, ossimRectilinearDataObject, and ossimPointBlock.

Referenced by ossimTileCache::insert(), ossimAppTileCache::insert(), ossimTileCache::remove(), and ossimAppTileCache::removeTile().

getHashId()

virtual ossim_uint32 ossimDataObject::getHashId ( ) const

pure virtual

Implemented in ossimImageData, and ossimPointBlock.

getObjectSizeInBytes()

ossim_uint32 ossimDataObject::getObjectSizeInBytes ( ) const

virtual

Definition at line 92 of file ossimDataObject.cpp.

References theOwner.

{
   return sizeof(theOwner);
}

getOwner() [1/2]

ossimSource * ossimDataObject::getOwner ( )

virtual

Definition at line 41 of file ossimDataObject.cpp.

References theOwner.

Referenced by ossimImageData::assign().

{
   return theOwner;
}

getOwner() [2/2]

const ossimSource * ossimDataObject::getOwner ( ) const

virtual

Definition at line 46 of file ossimDataObject.cpp.

References theOwner.

{
   return theOwner;
}

initialize()

virtual void ossimDataObject::initialize ( )

pure virtual

Will allow derived classes to initialize their buffers.

This class does nothing with this and reset any internal attributes.

Implemented in ossimImageData, ossimRectilinearDataObject, and ossimPointBlock.

isInitialize()

bool ossimDataObject::isInitialize ( ) const

virtual

This is to be overriden in the derived classes so they can check If their data is null.

Definition at line 97 of file ossimDataObject.cpp.

References getDataObjectStatus(), and OSSIM_NULL.

Referenced by demo2().

{
   return (getDataObjectStatus()!=OSSIM_NULL);
}

loadState()

bool ossimDataObject::loadState ( const ossimKeywordlist &  kwl, const char *  prefix = 0  )

virtual

Method to the load (recreate) the state of the object from a keyword list. Return true if ok or false on error.

Reimplemented from ossimObject.

Reimplemented in ossimImageData, and ossimRectilinearDataObject.

Definition at line 165 of file ossimDataObject.cpp.

References ossimString::empty(), ossimKeywordlist::find(), ossimObject::loadState(), OSSIM_EMPTY, OSSIM_FULL, OSSIM_PARTIAL, OSSIM_STATUS_UNKNOWN, theDataObjectStatus, and ossimString::upcase().

Referenced by ossimRectilinearDataObject::loadState().

{
   ossimString data_object_status = kwl.find(prefix, "data_object_status");
   if(!data_object_status.empty())
   {
      data_object_status = data_object_status.upcase();
      if(data_object_status == "OSSIM_FULL")
      {
         theDataObjectStatus = OSSIM_FULL;
      }
      else if(data_object_status == "OSSIM_PARTIAL")
      {
         theDataObjectStatus = OSSIM_PARTIAL;
      }
      else if(data_object_status == "OSSIM_EMPTY")
      {
         theDataObjectStatus = OSSIM_EMPTY;
      }
      else if(data_object_status == "OSSIM_STATUS_UNKNOWN")
      {
         theDataObjectStatus = OSSIM_STATUS_UNKNOWN;
      }
   }
   
   return ossimObject::loadState(kwl, prefix);
}                     

operator!=()

bool ossimDataObject::operator!= ( const ossimDataObject &  rhs ) const

virtual

Definition at line 102 of file ossimDataObject.cpp.

References theDataObjectStatus, and theOwner.

{
   return ( theOwner               != rhs.theOwner ||
            theDataObjectStatus    != rhs.theDataObjectStatus );
}

operator=() [1/2]

const ossimDataObject * ossimDataObject::operator= ( const ossimDataObject *  rhs )

virtual

Definition at line 123 of file ossimDataObject.cpp.

References assign().

Referenced by ossimRectilinearDataObject::operator=().

{
   assign(rhs);
   return this;
}

operator=() [2/2]

const ossimDataObject & ossimDataObject::operator= ( const ossimDataObject &  rhs )

virtual

Definition at line 129 of file ossimDataObject.cpp.

References theDataObjectStatus, and theOwner.

{
   if (this != &rhs)
   {
      theOwner            = rhs.theOwner;
      theDataObjectStatus = rhs.theDataObjectStatus; 
   }
   return *this;
}

operator==()

bool ossimDataObject::operator== ( const ossimDataObject &  rhs ) const

virtual

Definition at line 108 of file ossimDataObject.cpp.

References theDataObjectStatus, and theOwner.

{
   return (theOwner            == rhs.theOwner &&
           theDataObjectStatus == rhs.theDataObjectStatus);
}

print()

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

virtual

Generic print method.

Derived classes should re-implement as they see fit.

Returns

std::ostream&

Reimplemented from ossimObject.

Reimplemented in ossimImageData, and ossimRectilinearDataObject.

Definition at line 139 of file ossimDataObject.cpp.

References ossimObject::getClassName(), getDataObjectStatusString(), and theOwner.

Referenced by ossimRectilinearDataObject::print().

{
   out << "ossimDataObject::print:";
   
   if (theOwner)
   {
      out << "\ntheOwner->getClassName():  "
          << theOwner->getClassName()<<endl;
   }
   else
   {
      out << "\ntheOwner is null"
          <<endl;
   }
   out << "theDataObjectStatus: " << getDataObjectStatusString()
       << endl;

   return out;
}

saveState()

bool ossimDataObject::saveState ( ossimKeywordlist &  kwl, const char *  prefix = 0  ) const

virtual

Method to save the state of the object to a keyword list. Return true if ok or false on error.

Reimplemented from ossimObject.

Reimplemented in ossimImageData, and ossimRectilinearDataObject.

Definition at line 159 of file ossimDataObject.cpp.

References ossimKeywordlist::add(), getDataObjectStatusString(), and ossimObject::saveState().

Referenced by ossimRectilinearDataObject::saveState().

{
   kwl.add(prefix, "data_object_status", getDataObjectStatusString(), true);
   return ossimObject::saveState(kwl, prefix);
}

setDataObjectStatus()

void ossimDataObject::setDataObjectStatus ( ossimDataObjectStatus  status ) const

virtual

Full list found in ossimConstants.h.

OSSIM_STATUS_UNKNOWN OSSIM_NULL Null data. The buffers are never allocated OSSIM_EMPTY Allocated data but its empty. Most of the time this will be the default for an initialized data object. OSSIM_PARTIAL Says that some of the object is empty and is only partially full OSSIM_FULL This data is completey full

Definition at line 51 of file ossimDataObject.cpp.

References status, and theDataObjectStatus.

Referenced by ossimEquationCombiner::applyOp(), ossimPixelFlipper::clipTile(), ossimMaxMosaic::combine(), ossimFeatherMosaic::combine(), ossimImageData::computeAlphaChannel(), ossimImageData::computeAverageBandValue(), ossimBrightnessMatch::computeInputBrightness(), ossimImageData::computeMeanSquaredError(), ossimNBandToIndexFilter::convertInputTileToOutputTemplate(), ossimImageData::convertToNormalizedDouble(), ossimImageData::convertToNormalizedFloat(), ossimMaskFilter::executeMaskFilter(), ossimS16ImageData::fill(), ossimU11ImageData::fill(), ossimU12ImageData::fill(), ossimU13ImageData::fill(), ossimU14ImageData::fill(), ossimU15ImageData::fill(), ossimU8ImageData::fill(), ossimU16ImageData::fill(), ossimImageData::fill(), ossimCacheTileSource::fillTile(), ossimNullPixelFlip::flipPixels(), ossimImageCombiner::getNextNormTile(), ossimFusionCombiner::getNormIntensity(), ossimFusionCombiner::getNormTile(), ossimGammaRemapper::getTile(), ossimBrightnessContrastSource::getTile(), ossimPolyCutter::getTile(), ossimNBandToIndexFilter::getTile(), ossimRgbToIndexFilter::getTile(), ossimMeanMedianFilter::getTile(), ossimBandClipFilter::getTile(), ossimRangeDomeTileSource::getTile(), ossimRectilinearDataObject::initialize(), ossimImageData::loadTile(), ossimImageData::makeBlank(), ossimKakaduNitfReader::setNullPixelValue(), ossimImageData::stretchMinMax(), ossimS16ImageData::validate(), ossimU12ImageData::validate(), ossimU14ImageData::validate(), ossimU15ImageData::validate(), ossimU11ImageData::validate(), ossimU13ImageData::validate(), ossimU8ImageData::validate(), ossimU16ImageData::validate(), and ossimImageData::validate().

{
   theDataObjectStatus = status;
}

setOwner()

void ossimDataObject::setOwner ( ossimSource *  aSource )

virtual

Sets the owner of this Data object.

Definition at line 36 of file ossimDataObject.cpp.

References theOwner.

Referenced by ossimImageData::assign().

{
   theOwner = aSource;
}

Member Data Documentation

theDataObjectStatus

ossimDataObjectStatus ossimDataObject::theDataObjectStatus

mutableprotected

Definition at line 110 of file ossimDataObject.h.

Referenced by assign(), getDataObjectStatus(), getDataObjectStatusString(), loadState(), operator!=(), operator=(), operator==(), setDataObjectStatus(), ossimImageData::setImageRectangle(), and ossimImageData::setImageRectangleAndBands().

theOwner

ossimSource* ossimDataObject::theOwner

protected

Definition at line 109 of file ossimDataObject.h.

Referenced by assign(), getObjectSizeInBytes(), getOwner(), operator!=(), operator=(), operator==(), print(), and setOwner().

---

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

• ossimDataObject.h
• ossimDataObject.cpp