Sierra Toolkit Version of the Day
sierra::ExTemp< T > Class Template Reference

Template ExTemp takes a zero argument exception and makes it into a parallel throwable and put-to-able (<<) exception. This exception may be caught with either the base class T type or the template ExTemp<T> type. More...

#include <Exception.hpp>

Inheritance diagram for sierra::ExTemp< T >:
Collaboration diagram for sierra::ExTemp< T >:

List of all members.

Public Types

typedef ExTemp< T > ParallelExceptionType
 Parallel exception type.
typedef T BaseExceptionType
 Base exception type.

Public Member Functions

 ExTemp ()
 ExTemp (const std::string &message)
 ExTemp (const ExTemp &x)
virtual ~ExTemp () throw ()
virtual const char * what () const throw ()
 Member function what returns the exception's description.
ExTempoperator<< (std::ostream &(*f)(std::ostream &))
 Member function operator<< passes the std manipilator functions to the ExTemp object. This allows the manipulators to modify the description. (Currently in a limited fashion).
template<class U >
ExTempoperator<< (const U &t)
virtual void throw_copy () const
 Member function copy throws a copy of the original exception. It copies the original message, sets the parallel thrown flag and throws the new exception.

Static Public Member Functions

static void registerException ()
 Member function registerException registers the exception with the parallel exception registry.

Detailed Description

template<class T>
class sierra::ExTemp< T >

Template ExTemp takes a zero argument exception and makes it into a parallel throwable and put-to-able (<<) exception. This exception may be caught with either the base class T type or the template ExTemp<T> type.

Definition at line 536 of file Exception.hpp.


Constructor & Destructor Documentation

template<class T >
sierra::ExTemp< T >::ExTemp ( ) [inline]

Creates a new ExTemp instance.

Definition at line 546 of file Exception.hpp.

template<class T >
sierra::ExTemp< T >::ExTemp ( const std::string &  message) [inline, explicit]

Creates a new ExTemp instance with an initial description.

Parameters:
messagea std::string const reference to the initial exception description.

Definition at line 557 of file Exception.hpp.

template<class T >
sierra::ExTemp< T >::ExTemp ( const ExTemp< T > &  x) [inline]

Creates a new ExTemp copy.

Parameters:
xan ExTemp variable ...

Definition at line 567 of file Exception.hpp.

template<class T >
virtual sierra::ExTemp< T >::~ExTemp ( ) throw () [inline, virtual]

Destroys a ExTemp instance.

Definition at line 576 of file Exception.hpp.


Member Function Documentation

template<class T >
virtual const char* sierra::ExTemp< T >::what ( ) const throw () [inline, virtual]

Member function what returns the exception's description.

Returns:
a char const pointer to the exception's description.

Reimplemented from sierra::ExParallel.

Definition at line 585 of file Exception.hpp.

template<class T >
ExTemp& sierra::ExTemp< T >::operator<< ( std::ostream &(*)(std::ostream &)  f) [inline]

Member function operator<< passes the std manipilator functions to the ExTemp object. This allows the manipulators to modify the description. (Currently in a limited fashion).

Returns:
an ExParallel reference to this parallel exception.

Reimplemented from sierra::ExParallel.

Definition at line 597 of file Exception.hpp.

template<class T >
template<class U >
ExTemp& sierra::ExTemp< T >::operator<< ( const U &  t) [inline]

Member function operator<< passes any data type to the exception string class for conversion to a string.

Parameters:
ta T const reference that is to be converted to a string.
Returns:
a ExTemp reference to this object;

Reimplemented from sierra::ExParallel.

Definition at line 612 of file Exception.hpp.

template<class T >
static void sierra::ExTemp< T >::registerException ( ) [inline, static]

Member function registerException registers the exception with the parallel exception registry.

Returns:
an ExParallel reference to the exception to be cloned when thrown.

Definition at line 638 of file Exception.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines