iRoCS Toolbox  1.1.0
Public Member Functions
BlitzH5Error Class Reference

The main error class for the BlitzHDF5 interface. More...

#include <BlitzHdf5Light.hh>

Inheritance diagram for BlitzH5Error:
Collaboration diagram for BlitzH5Error:

Public Member Functions

 BlitzH5Error ()
 Default constructor. More...
 
 BlitzH5Error (const std::string &message)
 Creates an error object with the given message. More...
 
 ~BlitzH5Error () throw ()
 Default destructor. More...
 
template<typename DataT >
BlitzH5Erroroperator<< (DataT const &data)
 Appends the given data to the message string. More...
 
std::string const & str () const
 Returns the error message. More...
 
char const * what () const throw ()
 Returns the error message as c-string. More...
 

Detailed Description

The main error class for the BlitzHDF5 interface.

Definition at line 74 of file BlitzHdf5Light.hh.

Constructor & Destructor Documentation

◆ BlitzH5Error() [1/2]

BlitzH5Error::BlitzH5Error ( )

Default constructor.

Creates an object without error message.

See also
BlitzH5Error::operator<<

Referenced by BlitzH5File::id().

◆ BlitzH5Error() [2/2]

BlitzH5Error::BlitzH5Error ( const std::string &  message)

Creates an error object with the given message.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
messageerror message

◆ ~BlitzH5Error()

BlitzH5Error::~BlitzH5Error ( )
throw (
)

Default destructor.

Member Function Documentation

◆ operator<<()

template<typename DataT >
BlitzH5Error& BlitzH5Error::operator<< ( DataT const &  data)

Appends the given data to the message string.

Parameters
data

◆ str()

std::string const& BlitzH5Error::str ( ) const

Returns the error message.

Returns
error message

◆ what()

char const* BlitzH5Error::what ( ) const
throw (
)

Returns the error message as c-string.

Returns
error message

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