itkExceptionObject.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkExceptionObject.h,v $
  Language:  C++
  Date:      $Date: 2008-10-13 15:36:31 $
  Version:   $Revision: 1.40 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
// itkExceptionObject.h is normally included through itkMacro.h, but
// some code includes it directly.
#ifndef __itkMacro_h
#include "itkMacro.h"
#else

#ifndef __itkExceptionObject_h
#define __itkExceptionObject_h

#include <string>
#include <stdexcept>

#include "itkSmartPointer.h"
#include "itkWin32Header.h"


namespace itk
{

class ITKCommon_EXPORT ExceptionObject : public std::exception
{
public:
  typedef std::exception Superclass;
  ExceptionObject();
  explicit ExceptionObject(const char *file, unsigned int lineNumber=0,
                  const char *desc="None", const char *loc="Unknown");
  explicit ExceptionObject(const std::string& file, unsigned int lineNumber=0,
                  const std::string& desc="None",
                  const std::string& loc="Unknown");
  ExceptionObject( const ExceptionObject &orig );
  
  virtual ~ExceptionObject() throw();

  ExceptionObject &operator= ( const ExceptionObject &orig );
  
  virtual bool operator==( const ExceptionObject &orig );
          
  virtual const char *GetNameOfClass() const 
    {return "ExceptionObject";}

  virtual void Print(std::ostream& os) const;

  virtual void SetLocation(const std::string& s);
  virtual void SetDescription(const std::string& s);
  virtual void SetLocation(const char * s);
  virtual void SetDescription (const char *s);
  virtual const char *GetLocation()    const;
  virtual const char *GetDescription() const;
  
  virtual const char *GetFile()    const;

  virtual unsigned int GetLine() const;
  
  virtual const char* what() const throw();
  
private:
  class ReferenceCounterInterface
    {
    public:
      virtual void Register() const = 0;
      virtual void UnRegister() const = 0;
      ReferenceCounterInterface() {}
      virtual ~ReferenceCounterInterface() {}
    };
  class ExceptionData;
  class ReferenceCountedExceptionData;
  SmartPointer<const ReferenceCounterInterface> m_ExceptionData;
  const ExceptionData * GetExceptionData() const;
};

inline std::ostream& operator<<(std::ostream& os, ExceptionObject &e)
{
  (&e)->Print(os);
  return os;
}

class MemoryAllocationError : public ExceptionObject
{
public:
  MemoryAllocationError() : ExceptionObject() {}

  MemoryAllocationError(const char *file, unsigned int lineNumber) : ExceptionObject(file, lineNumber) {}

  MemoryAllocationError(const std::string& file, unsigned int lineNumber) : ExceptionObject(file, lineNumber) {}  

  MemoryAllocationError(const std::string& file, unsigned int lineNumber, const std::string& desc, const std::string& loc) : ExceptionObject(file, lineNumber, desc, loc) {}  

  virtual ~MemoryAllocationError() throw() {}

  virtual const char* GetNameOfClass() const
    { return "MemoryAllocationError"; }
};

class RangeError : public ExceptionObject
{
public:
  RangeError() : ExceptionObject() {}
  
  RangeError(const char *file, unsigned int lineNumber) : ExceptionObject(file, lineNumber) {}

  RangeError(const std::string& file, unsigned int lineNumber) : ExceptionObject(file, lineNumber) {}  

  virtual ~RangeError() throw() {}

  virtual const char *GetNameOfClass() const 
    {return "RangeError";}

};

class InvalidArgumentError : public ExceptionObject
{
public:
  InvalidArgumentError() : ExceptionObject() {}
  
  InvalidArgumentError(const char *file, unsigned int lineNumber) : ExceptionObject(file, lineNumber) {}

  InvalidArgumentError(const std::string& file, unsigned int lineNumber) : ExceptionObject(file, lineNumber) {}  

  virtual ~InvalidArgumentError() throw() {}

  virtual const char *GetNameOfClass() const 
    {return "InvalidArgumentError";}
};

class IncompatibleOperandsError : public ExceptionObject
{
public:
  IncompatibleOperandsError() : ExceptionObject() {}
  
  IncompatibleOperandsError(const char *file, unsigned int lineNumber) : ExceptionObject(file, lineNumber) {}

  IncompatibleOperandsError(const std::string& file, unsigned int lineNumber) : ExceptionObject(file, lineNumber) {}  

  virtual ~IncompatibleOperandsError() throw() {}

  virtual const char *GetNameOfClass() const 
    {return "IncompatibleOperandsError";}
};

class ProcessAborted : public ExceptionObject
{
public:
  ProcessAborted() : ExceptionObject() {
    this->SetDescription("Filter execution was aborted by an external request"); }
  
  ProcessAborted(const char *file, unsigned int lineNumber) : ExceptionObject(file, lineNumber) {
    this->SetDescription("Filter execution was aborted by an external request"); }

  ProcessAborted(const std::string& file, unsigned int lineNumber) : ExceptionObject(file, lineNumber) {  
    this->SetDescription("Filter execution was aborted by an external request"); }

  virtual ~ProcessAborted() throw() {}

  virtual const char *GetNameOfClass() const 
    {return "ProcessAborted";}

};


} // end namespace itk

#endif

#endif