Isis::iException Class Reference

Isis exception class. More...

#include <iException.h>

Classes
class	Info
	Exception information.
Public Types
enum	errType { None = 0, User = 1, Programmer = 2, Pvl = 3, Io = 5, Camera = 6, Projection = 7, Parse = 8, Math = 9, Spice = 10, Cancel = 200, System = 255 }
	Contains a set of throwable exception types. More...
Public Member Functions
	iException (const iException &other)
iException &	operator= (const iException &other)
const char *	what () const throw ()
	Returns what happened in output format.
errType	Type () const
	Returns the type of exception.
int	Report (bool fileinfo=true)
	Reports the exception to output.
Isis::Pvl	PvlErrors ()
	Adds a new PvlGroup called "Error" and appends it to the file (if PVL format output is enabled).
std::string	Errors ()
	Returns the Exception message to be output (non-PVL).
bool	IsPvlFormat ()
	Returns true or false based on whether the exception should output in PVL format.
void	Clear ()
	Clears the list of exceptions.
	~iException () throw ()
	Throws and destroys the iException object.
Static Public Member Functions
static iException &	Message (errType t, const std::string &m, const char *f, int l)
	Adds a message to an existing iException object (or creates a new one if it doesn't exist).

Detailed Description

Isis exception class.

The general Isis exception class. Contains an enumeration for what type of exception to throw.

Author:: ????-??-?? Jeff Anderson

Member Enumeration Documentation

enum Isis::iException::errType

Contains a set of throwable exception types.

Enumerator:

None
User
Programmer
Pvl
Io
Camera
Projection
Parse
Math
Spice
Cancel
System

Constructor & Destructor Documentation

Isis::iException::iException ( const iException & other )

Isis::iException::~iException ( ) throw ()

Throws and destroys the iException object.

Member Function Documentation

void Isis::iException::Clear ( )

Clears the list of exceptions.

Referenced by Isis::MosaicSceneWidget::addCubes(), Isis::PvlTranslationManager::Auto(), Isis::SerialNumber::Compose(), Isis::InfixToPostfix::Convert(), Isis::ImagePolygon::Create(), Isis::PlotWindowBestFitDialog::createBestFitLine(), Isis::ProjectionFactory::CreateForCube(), Isis::ProcessExport::CreateWorldFile(), Isis::CubeDisplayProperties::CubeDisplayProperties(), Isis::CubeViewport::CubeViewport(), Isis::PolygonTools::Despike(), Isis::ImageOverlapSet::FindAllOverlaps(), Isis::CubeInfixToPostfix::FindOperator(), Isis::CubeDisplayProperties::footprint(), Isis::ImagePolygon::initCube(), Isis::Area3D::intersect(), Isis::Chip::Load(), Isis::AutoReg::ModelSurface(), Isis::MosaicMainWindow::MosaicMainWindow(), Isis::ControlMeasureLogData::NameToDataType(), Isis::Cube::open(), Isis::Spice::readStoredValue(), Isis::PvlTokenizer::ReadToBrace(), Isis::PvlTokenizer::ReadToParen(), Isis::PolygonTools::ReducePrecision(), Report(), Isis::Pipeline::Run(), Isis::UserInterface::SaveHistory(), Isis::UserInterface::SetBatchList(), Isis::ControlNetGraphicsItem::snToFilename(), Isis::ControlNetFileV0001::ToPvl(), Isis::OverlapStatistics::toPvl(), Isis::UniversalGroundMap::UniversalGroundMap(), and Isis::UserInterface::UserInterface().

std::string Isis::iException::Errors ( )

Returns the Exception message to be output (non-PVL).

Referenced by Report(), and Isis::Pipeline::Run().

bool Isis::iException::IsPvlFormat ( )

Returns true or false based on whether the exception should output in PVL format.

Returns:: True if PVL format is enabled, false if not.

Referenced by Report().

iException & Isis::iException::Message	(	iException::errType	t,
		const std::string &	m,
		const char *	f,
		int	l
	)			`[static]`

Adds a message to an existing iException object (or creates a new one if it doesn't exist).

Parameters:

	t	An errType value of what type of exception is thrown.
	m	The message to add
	f	The filename
	l	The line number

Returns:: The modified exception object.

References ASSERT, Isis::PvlObject::FindGroup(), Isis::PvlContainer::HasKeyword(), and Isis::Preference::Preferences().

iException & Isis::iException::operator= ( const iException & other )

Pvl Isis::iException::PvlErrors ( )

Adds a new PvlGroup called "Error" and appends it to the file (if PVL format output is enabled).

References Isis::PvlObject::AddGroup(), and errors.

Referenced by Report().

int Isis::iException::Report ( bool fileinfo = true )

Reports the exception to output.

Parameters:

fileinfo

Allows the caller to overide the users preference setting for file name and line number where the error was thrown

Returns:: The type of exception.

References Clear(), Errors(), errors, IsPvlFormat(), PvlErrors(), and Type().

Referenced by Isis::MosaicSceneWidget::addCubes(), Isis::ImagePolygon::Create(), Isis::CubeDisplayProperties::CubeDisplayProperties(), and Isis::VoyagerCamera::VoyagerCamera().

iException::errType Isis::iException::Type ( ) const

Returns the type of exception.

Returns:: The type of exception (None if no type).

References None.

const char * Isis::iException::what ( ) const throw ()

Returns what happened in output format.

This pointer is valid as long as no new iException objects are created (iException::Message is not called again).

Returns:: The message stating what happened and where.

Referenced by Isis::MosaicMainWindow::MosaicMainWindow().

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

src/base/objs/iException/iException.h
src/base/objs/iException/iException.cpp

Isis::iException Class Reference

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation