Changeset 895 in Sophya for trunk/SophyaLib/BaseTools/pexceptions.h

Timestamp:

Apr 12, 2000, 7:49:54 PM (25 years ago)

Author:

ansari

Message:

Documentation de fichiers - Reza 12/4/2000

File:

• trunk/SophyaLib/BaseTools/pexceptions.h (modified) (11 diffs)

trunk/SophyaLib/BaseTools/pexceptions.h

@@ -14 +14 @@
 namespace SOPHYA {
 
-  // Utiliatire pour accoler un nom de fichier et numero de ligne au message
+//! Utility function for appending a file name and line number to a message
   string BuildLongExceptionMessage(const char * s, const char *file, int line);
 
-  // Ancestor for PError and PException
-  // It has a message, and an id to give more
-  // information on the exception.
+//! Base exception class in Sophya.
+/*! Ancestor for PError and PException
+    It has a message, and an id to give more
+    information on the exception.
+*/
   class PThrowable {
   public:
+    //! Constructor with the message and error-id (optional) specification
     explicit PThrowable(const string& m, int ident=0) 
       : msg(m), id(ident) {}
     virtual ~PThrowable() { }
+    //! Returns the associated message string
     virtual string const& Msg() const  {return msg;}
+    //! Returns the associated error-id
+    virtual int Id() const {return id; }
   private:
     string msg;
     int    id;
   };
-  
-  // A PError is a serious logic error. Usually not caught...
+
+//  PThrowable
+//      PError
+//      PException
+  
+//! A PError is a serious logic error. Usually not caught...
   class PError : public PThrowable {
   public:
@@ -37 +47 @@
   };
   
-  // A PException is not as serious... Can be caught.
+//! A PException is not as serious... Can be caught.
   class PException : public PThrowable {
   public:
@@ -43 +53 @@
   };
   
-  // Errors
-  // Memory allocation failure
+//  ----   Errors ----
+//  PError
+//     AllocationError
+//     NullPtrError
+//     ForbiddenError
+//     AssertionFailedError
+
+//! Memory allocation failure
   class AllocationError : public PError {
   public:
@@ -50 +66 @@
   };
   
-  // Null pointer error
+//! Null pointer error
   class NullPtrError : public PError {
   public:
@@ -56 +72 @@
   };
   
-  // Size mismatch between objects
-  class SzMismatchError : public PError {
-  public:
-    explicit SzMismatchError(const string& m, int id=0) : PError(m,id) {}
-  };
-  
-  // Out of bounds for array, matrix, etc.
-  class RangeCheckError : public PError {
-  public:
-    explicit RangeCheckError(const string& m, int id=0) : PError(m,id) {}
-  };
-  
-  // Invalid parameter to method/constructor...
-  class ParmError : public PError {
-  public:
-    explicit ParmError(const string& m, int id=0) : PError(m,id) {}
-  };
-  
-  // Calling a forbidden method, trying a forbidden operation
+  
+//! Calling a forbidden method, trying a forbidden operation
   class ForbiddenError : public PError {
   public:
@@ -80 +79 @@
   };
 
-  // Calling a non available / not implemented method
-  class NotAvailableOperation : public PException {
-  public:
-    explicit NotAvailableOperation(const string& m, int id=0) : PException(m,id) {}
-  };
-  
-  // ASSERT macro failure. The message is the assertion...
+  
+//! ASSERT macro failure. The message is the assertion...
   class AssertionFailedError : public PError {
   public:
@@ -97 +91 @@
   //   IOExc
   //     FileFormatExc
+  //   SzMismatchError
+  //   RangeCheckError
+  //   ParmError
   //   TypeMismatchExc
+  //   MathExc
+  //     SingMatxExc
   //   DuplicateIdExc
   //   NotFoundExc
-  //   MathExc
-  //     SingMatxExc
-  
-  // generic IO Exception
+  //   CaughtSignalExc
+  
+  //! Generic IO Exception.
   class IOExc : public PException {
   public:
@@ -109 +107 @@
   };
 
-  // Bad type -> keep ?
+  //! Bad file format.
+  class FileFormatExc : public IOExc {
+  public:
+    explicit FileFormatExc(const string& m, int id=0) : IOExc(m,id) {}
+  };
+
+  //! Size mismatch between objects.
+  class SzMismatchError : public PException {
+  public:
+    explicit SzMismatchError(const string& m, int id=0) : PException(m,id) {}
+  };
+  
+  //! Out of bounds for array, matrix, etc.
+  class RangeCheckError : public PException {
+  public:
+    explicit RangeCheckError(const string& m, int id=0) : PException(m,id) {}
+  };
+  
+  //! Invalid parameter to method/constructor...
+  class ParmError : public PException {
+  public:
+    explicit ParmError(const string& m, int id=0) : PException(m,id) {}
+  };
+
+  //! Calling a non available / not implemented method
+  class NotAvailableOperation : public PException {
+  public:
+    explicit NotAvailableOperation(const string& m, int id=0) : PException(m,id) {}
+  };
+
+  //! Bad data type -> keep ?
   class TypeMismatchExc : public PException {
   public:
     explicit TypeMismatchExc(const string& m, int id=0) : PException(m,id) {}
   };
-  
+
+  //! Math operation exception
   class MathExc : public PException {
   public:
@@ -120 +149 @@
   };
   
+  //! Singular matrix 
+  class SingMatrixExc : public MathExc {
+  public:
+    explicit SingMatrixExc(const string& m, int id=0) : MathExc(m,id) {}
+  };
+
+  //! Duplicate identifier during registration
   class DuplicateIdExc : public PException {
   public:
@@ -125 +161 @@
   };
   
+  //! Not found identifier 
   class NotFoundExc : public PException {
   public:
@@ -130 +167 @@
   };
   
+  //! Generated exception when processing a signal
   class CaughtSignalExc : public PException {
   public:
     explicit CaughtSignalExc(const string& m, int id=0) : PException(m,id) {}
   };
-
-  // Bad file format
-  class FileFormatExc : public IOExc {
-  public:
-    explicit FileFormatExc(const string& m, int id=0) : IOExc(m,id) {}
-  };
-  
-  class SingMatrixExc : public MathExc {
-  public:
-    explicit SingMatrixExc(const string& m, int id=0) : MathExc(m,id) {}
-  };
-  
-  
-}
+    
+} // namespace SOPHYA