HdfUtilities::Exception Class Reference

An HdfUtilitiesException is a simple exception that wraps a string. More...

#include <HdfUtilities.h>

List of all members.

Public Member Functions
	Exception (const std::string &str)
std::string	getText () const

---

Detailed Description

An HdfUtilitiesException is a simple exception that wraps a string.

Various HdfUtilities throw an HdfUtilities::Exception when an error condition occurrs and the function can't just 'return false.'

Definition at line 34 of file HdfUtilities.h.

---

Constructor & Destructor Documentation

HdfUtilities::Exception::Exception

(

const std::string &

str

)

[explicit]

Creates an HdfUtilitiesException based on a string.

Parameters:

str

Text to place into the exception. Should not be empty (but can be).

Definition at line 43 of file HdfUtilities.h.

---

Member Function Documentation

std::string HdfUtilities::Exception::getText

(

)

const

Gets the message from the exception.

Returns:

The string that was passed in to the constructor.

Definition at line 53 of file HdfUtilities.h.