ossimErrorStatusInterface Class Reference

#include <ossimErrorStatusInterface.h>

Inheritance diagram for ossimErrorStatusInterface:

Public Member Functions
	ossimErrorStatusInterface ()
virtual	~ossimErrorStatusInterface ()
virtual ossimErrorCode	getErrorStatus () const
virtual ossimString	getErrorStatusString () const
virtual void	setErrorStatus (ossimErrorCode error_status) const
virtual void	setErrorStatus () const
virtual void	clearErrorStatus () const
bool	hasError () const
virtual std::ostream &	print (std::ostream &out) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...

Protected Attributes
ossimErrorCode	theErrorStatus

Friends
OSSIMDLLEXPORT std::ostream &	operator<< (std::ostream &out, const ossimErrorStatusInterface &obj)

Detailed Description

class ossimErrorStatusInterface Provides common interfaces for error handling.

Note: For error codes and associated strings use the ossimErrorCodes class.

Definition at line 29 of file ossimErrorStatusInterface.h.

Constructor & Destructor Documentation

ossimErrorStatusInterface()

ossimErrorStatusInterface::ossimErrorStatusInterface

(

)

Definition at line 20 of file ossimErrorStatusInterface.cpp.

   :
   theErrorStatus(ossimErrorCodes::OSSIM_OK)
{}

~ossimErrorStatusInterface()

ossimErrorStatusInterface::~ossimErrorStatusInterface ( )

virtual

Definition at line 25 of file ossimErrorStatusInterface.cpp.

{}

Member Function Documentation

clearErrorStatus()

void ossimErrorStatusInterface::clearErrorStatus ( ) const

virtual

Clears theErrorStatus by setting to ossimErrorCodes::OSSIM_OK or 0.

Definition at line 48 of file ossimErrorStatusInterface.cpp.

References ossimErrorCodes::OSSIM_OK, and theErrorStatus.

Referenced by ossimAOD::allocate(), ossimFormosatDimapSupportData::clearFields(), ossimSpotDimapSupportData::clearFields(), ossimplugins::ossimSpot6DimapSupportData::clearFields(), ossimplugins::ossimPleiadesDimapSupportData::clearFields(), ossimGammaRemapper::initialize(), ossimplugins::ossimPleiadesModel::open(), ossimplugins::ossimSpot6Model::open(), ossimSrtmHandler::open(), ossimQuickbirdRpcModel::ossimQuickbirdRpcModel(), ossimDtedVol::parse(), ossimDtedHdr::parse(), ossimDtedAcc::parse(), ossimDtedUhl::parse(), ossimDtedDsi::parse(), ossimQuickbirdRpcModel::parseTiffFile(), and ossimSpot5Model::updateModel().

{
   theErrorStatus = ossimErrorCodes::OSSIM_OK;
}

getErrorStatus()

ossimErrorCode ossimErrorStatusInterface::getErrorStatus ( ) const

virtual

return theErrorStatus

Definition at line 28 of file ossimErrorStatusInterface.cpp.

References theErrorStatus.

Referenced by ossimDtedElevationDatabase::createCell(), ossimSensorModelFactory::createProjection(), ossimChipProcTool::execute(), ossimFgdcFileWriter::find(), ossimQbTileFilesHandler::getImageGeometry(), ossimDtedInfo::getProperty(), ossimSpot5Model::initFromMetadata(), ossimSensorModelFactory::isLandsat(), ossimDemUtil::isUsgsDem(), ossimCastTileSourceFilter::loadState(), ossimSpot5Model::loadState(), ossimElevImageSource::loadState(), ossimRangeDomeTileSource::loadState(), ossimNitfXmlDataContentDes::loadValueFromXml(), ossimDtedInfo::open(), ossimAffineProjection::ossimAffineProjection(), ossimplugins::ossimFormosatModel::ossimFormosatModel(), ossimGeoidEgm96::ossimGeoidEgm96(), ossimWarpProjection::ossimWarpProjection(), ossimplugins::ossimSpot6DimapSupportData::parseXmlFile(), ossimplugins::ossimPleiadesDimapSupportData::parseXmlFile(), ossimDtedInfo::print(), ossimElevImageSource::saveState(), ossimRangeDomeTileSource::saveState(), ossimPointCloudImageHandler::saveState(), ossimImageHandler::saveState(), ossimGeneralRasterElevHandler::setFilename(), ossimOverviewBuilderBase::setInputSource(), ossimSpot5Model::setupOptimizer(), ossimGeneralRasterWriter::writeFile(), ossimJpegWriter::writeFile(), ossimKmlSuperOverlayWriter::writeFile(), ossimKakaduJp2Writer::writeFile(), ossimKakaduNitfWriter::writeFile(), ossimWriter::writeFile(), ossimPngWriter::writeFile(), and ossimGeneralRasterWriter::writeStream().

{
   return theErrorStatus;
}

getErrorStatusString()

ossimString ossimErrorStatusInterface::getErrorStatusString ( ) const

virtual

return theErrorStatus as an ossimString

Definition at line 33 of file ossimErrorStatusInterface.cpp.

References ossimErrorCodes::getErrorString(), ossimErrorCodes::instance(), and theErrorStatus.

Referenced by print().

{
   return ossimErrorCodes::instance()->getErrorString(theErrorStatus);
}

hasError()

bool ossimErrorStatusInterface::hasError

(

)

const

Returns

true if theErrorStatus != ossimErrorCodes::OSSIM_OK.

Definition at line 53 of file ossimErrorStatusInterface.cpp.

References ossimErrorCodes::OSSIM_OK, and theErrorStatus.

Referenced by ossimOverviewSequencer::getNextTile().

{
   return ( theErrorStatus != ossimErrorCodes::OSSIM_OK );
}

print()

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

virtual

Outputs theErrorStatus as an ossimErrorCode and an ossimString.

Returns

std::ostream&

Note

Derived classes should only have to implement a virtual print, not an operator<< funtion as it's implemented here.

Reimplemented in ossimHistogramRemapper, ossimKeywordlist, ossimTiffTileSource, ossimGeoTiff, ossimMapProjection, ossimWatermarkFilter, ossimElevManager, ossimGdalOverviewBuilder, ossimElevSource, ossimplugins::ossimGeometricSarSensorModel, ossimPixelFlipper, ossimImageElevationDatabase, ossimSensorModel, ossimKakaduNitfOverviewBuilder, ossimTiledElevationDatabase, ossimElevationCellDatabase, ossimPiecewiseRemapper, ossimLambertConformalConicProjection, ossimRpcModel, ossimFcsiModel, ossimplugins::ossimRadarSat2Model, ossimplugins::ossimTerraSarModel, ossimplugins::ossimRadarSat2RPCModel, ossimplugins::ossimEnvisatAsarModel, ossimLlxyProjection, ossimSarModel, ossimElevCellHandler, ossimTransMercatorProjection, ossimRpcProjection, ossimGdalOgrVectorAnnotation, ossimProjection, ossimLandSatModel, ossimRsmModel, ossimUtmProjection, ossimElevationDatabase, ossimAffineProjection, ossimWarpProjection, ossimERS, ossimCoarseGridModel, ossimplugins::ossimFormosatModel, ossimplugins::ossimPleiadesModel, ossimplugins::ossimSpot6Model, ossimGeneralRasterElevationDatabase, ossimSpot5Model, ossimAdjMapModel, ossimDtedElevationDatabase, ossimHsiRemapper, ossimBilinearProjection, ossimplugins::ossimTileMapModel, ossimTableRemapper, ossimSource, ossimCcfHead, ossimAOD, ossimAtCorrRemapper, ossimGammaRemapper, ossimNitfMapModel, ossimHistogramEqualization, ossimImageSourceHistogramFilter, and ossimPolynomProjection.

Definition at line 58 of file ossimErrorStatusInterface.cpp.

References getErrorStatusString(), and theErrorStatus.

Referenced by operator<<(), ossimCcfHead::print(), ossimSource::print(), and ossimProjection::print().

{
   out << "ossimErrorStatusInterface::print"
       << "\ntheErrorStatus:         " << theErrorStatus
       << "\ntheErrorStatus string:  " << getErrorStatusString()
       << std::endl;
   return out;
}

setErrorStatus() [1/2]

void ossimErrorStatusInterface::setErrorStatus ( ossimErrorCode  error_status ) const

virtual

Sets theErrorStatus to error_status.

Definition at line 38 of file ossimErrorStatusInterface.cpp.

References theErrorStatus.

{
   theErrorStatus = error_status;
}

setErrorStatus() [2/2]

void ossimErrorStatusInterface::setErrorStatus ( ) const

virtual

Set theErrorStatus to ossimErrorCodes::OSSIM_ERROR.

Definition at line 43 of file ossimErrorStatusInterface.cpp.

References ossimErrorCodes::OSSIM_ERROR, and theErrorStatus.

Referenced by ossimAOD::allocate(), ossimSpotDimapSupportData::convertTimeStamp(), ossimFormosatDimapSupportData::convertTimeStamp(), ossimSpotDimapSupportData::getInterpolatedLookAngle(), ossimFormosatDimapSupportData::getInterpolatedLookAngle(), ossimSpotDimapSupportData::getLagrangeInterpolation(), ossimFormosatDimapSupportData::getLagrangeInterpolation(), ossimOverviewSequencer::getNextTile(), ossimSpotDimapSupportData::getPixelLookAngleX(), ossimSpotDimapSupportData::getPixelLookAngleY(), ossimFormosatDimapSupportData::initFramePoints(), ossimSpotDimapSupportData::initFramePoints(), ossimGammaRemapper::initialize(), ossimSpotDimapSupportData::initImageId(), ossimFormosatDimapSupportData::initImageId(), ossimplugins::ossimRadarSat2Model::InitLut(), ossimSpotDimapSupportData::initMetadataVersion(), ossimFormosatDimapSupportData::initMetadataVersion(), ossimplugins::ossimRadarSat2Model::InitRefNoiseLevel(), ossimSpotDimapSupportData::initSceneSource(), ossimFormosatDimapSupportData::initSceneSource(), ossimEnviCgModel::loadEnviGeocFile(), ossimRS1SarModel::loadState(), ossimQuickbirdRpcHeader::open(), ossimplugins::ossimRadarSat2RPCModel::open(), ossimTiffWriter::openTiff(), ossimAffineProjection::ossimAffineProjection(), ossimAOD::ossimAOD(), ossimElevImageSource::ossimElevImageSource(), ossimGammaRemapper::ossimGammaRemapper(), ossimGeneralRasterElevHandler::ossimGeneralRasterElevHandler(), ossimQuickbirdRpcModel::ossimQuickbirdRpcModel(), ossimRS1SarModel::ossimRS1SarModel(), ossimWarpProjection::ossimWarpProjection(), ossimplugins::ossimSpot6DimapSupportData::parseDatasetContent(), ossimplugins::ossimPleiadesDimapSupportData::parseDatasetContent(), ossimplugins::ossimSpot6DimapSupportData::parseDatasetSources(), ossimplugins::ossimPleiadesDimapSupportData::parseDatasetSources(), ossimNitfRsmModel::parseFile(), ossimNitfRpcModel::parseFile(), ossimplugins::ossimSpot6DimapSupportData::parseGeometricData(), ossimplugins::ossimPleiadesDimapSupportData::parseGeometricData(), ossimplugins::ossimSpot6DimapSupportData::parseMetadataIdentificationDIMAPv2(), ossimplugins::ossimPleiadesDimapSupportData::parseMetadataIdentificationDIMAPv2(), ossimQuickbirdRpcModel::parseNitfFile(), ossimSpotDimapSupportData::parsePart1(), ossimFormosatDimapSupportData::parsePart1(), ossimFormosatDimapSupportData::parsePart2(), ossimSpotDimapSupportData::parsePart2(), ossimFormosatDimapSupportData::parsePart3(), ossimSpotDimapSupportData::parsePart3(), ossimFormosatDimapSupportData::parsePart4(), ossimSpotDimapSupportData::parsePart4(), ossimplugins::ossimSpot6DimapSupportData::parseRadiometricData(), ossimplugins::ossimPleiadesDimapSupportData::parseRadiometricData(), ossimplugins::ossimSpot6DimapSupportData::parseRasterData(), ossimplugins::ossimPleiadesDimapSupportData::parseRasterData(), ossimplugins::ossimSpot6DimapSupportData::parseRPCMetadata(), ossimplugins::ossimPleiadesDimapSupportData::parseRPCMetadata(), ossimQuickbirdRpcModel::parseTiffFile(), ossimplugins::ossimSpot6DimapSupportData::parseXmlFile(), ossimplugins::ossimPleiadesDimapSupportData::parseXmlFile(), ossimXmlDocument::read(), ossimRS1SarModel::saveState(), and ossimTiffWriter::writeTiffTags().

{
   theErrorStatus = ossimErrorCodes::OSSIM_ERROR;
}

Friends And Related Function Documentation

operator<<

OSSIMDLLEXPORT std::ostream& operator<< ( std::ostream &  out, const ossimErrorStatusInterface &  obj  )

friend

Definition at line 67 of file ossimErrorStatusInterface.cpp.

{
   return obj.print(out);
}

Member Data Documentation

theErrorStatus

ossimErrorCode ossimErrorStatusInterface::theErrorStatus

mutableprotected

Definition at line 68 of file ossimErrorStatusInterface.h.

Referenced by clearErrorStatus(), ossimERS::clearFields(), ossimFfL5::convertGeoPoint(), ossimFfL7::convertGeoPoint(), ossimERS::errorStatus(), ossimAdrgTileSource::fillBuffer(), ossimCcfTileSource::fillBuffer(), ossimCcfTileSource::fillUcharBuffer(), ossimCcfTileSource::fillUshortBuffer(), for(), getErrorStatus(), getErrorStatusString(), hasError(), ossimAdjMapModel::initializeFromMap(), ossimplugins::ossimTileMapModel::loadState(), ossimQuickbirdRpcHeader::open(), ossimSrtmHandler::open(), ossimNitfTileSource::open(), ossimJpegTileSource::open(), ossimAdjMapModel::ossimAdjMapModel(), ossimCcfHead::ossimCcfHead(), ossimDtedAcc::ossimDtedAcc(), ossimDtedDsi::ossimDtedDsi(), ossimDtedHdr::ossimDtedHdr(), ossimDtedUhl::ossimDtedUhl(), ossimDtedVol::ossimDtedVol(), ossimERS::ossimERS(), ossimERSTileSource::ossimERSTileSource(), ossimFfL7::ossimFfL7(), ossimGeneralRasterElevHandler::ossimGeneralRasterElevHandler(), ossimJpegTileSource::ossimJpegTileSource(), ossimKeywordlist::ossimKeywordlist(), ossimDtedVol::parse(), ossimDtedHdr::parse(), ossimDtedAcc::parse(), ossimDtedUhl::parse(), ossimDtedDsi::parse(), ossimCcfHead::parseCcfHeader(), ossimERS::parseError(), ossimERS::parseHeader(), ossimCcfHead::print(), print(), ossimFfL7::readAdminRecord(), ossimFfL7::readGeomRecord(), ossimFfL5::readHeaderRevB(), ossimFfL7::readRadiomRecord(), and setErrorStatus().

---

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

• ossimErrorStatusInterface.h
• ossimErrorStatusInterface.cpp