Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
us::ServiceException Class Reference

#include <usServiceException.h>

Inheritance diagram for us::ServiceException:
Collaboration diagram for us::ServiceException:

Public Types

enum  Type {
  UNSPECIFIED, UNREGISTERED, FACTORY_ERROR, FACTORY_EXCEPTION,
  REMOTE, FACTORY_RECURSION
}
 

Public Member Functions

 ServiceException (const std::string &msg, const Type &type=UNSPECIFIED)
 
 ServiceException (const ServiceException &o)
 
ServiceExceptionoperator= (const ServiceException &o)
 
 ~ServiceException () override throw ()
 
Type GetType () const
 

Detailed Description

A service exception used to indicate that a service problem occurred.

A ServiceException object is created by the framework or to denote an exception condition in the service. An enum type is used to identify the exception type for future extendability.

This exception conforms to the general purpose exception chaining mechanism.

Definition at line 50 of file usServiceException.h.

Member Enumeration Documentation

◆ Type

Enumerator
UNSPECIFIED 

No exception type is unspecified.

UNREGISTERED 

The service has been unregistered.

FACTORY_ERROR 

The service factory produced an invalid service object.

FACTORY_EXCEPTION 

The service factory threw an exception.

REMOTE 

An error occurred invoking a remote service.

FACTORY_RECURSION 

The service factory resulted in a recursive call to itself for the requesting module.

Definition at line 54 of file usServiceException.h.

Constructor & Destructor Documentation

◆ ServiceException() [1/2]

us::ServiceException::ServiceException ( const std::string &  msg,
const Type type = UNSPECIFIED 
)

Creates a ServiceException with the specified message, type and exception cause.

Parameters
msgThe associated message.
typeThe type for this exception.

◆ ServiceException() [2/2]

us::ServiceException::ServiceException ( const ServiceException o)

◆ ~ServiceException()

us::ServiceException::~ServiceException ( )
throw (
)
inlineoverride

Definition at line 94 of file usServiceException.h.

Member Function Documentation

◆ GetType()

Type us::ServiceException::GetType ( ) const

Returns the type for this exception or UNSPECIFIED if the type was unspecified or unknown.

Returns
The type of this exception.

◆ operator=()

ServiceException& us::ServiceException::operator= ( const ServiceException o)

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