---

OSCARError.h

Go to the documentation of this file.

//
//  Title     : OSCARError.h
//  Project   : OSCAR Version 2.0
//  Created   : 
//  Author    : Chetan Kapoor
//  Platforms : All
//  Copyright : Copyright© The University of Texas at Austin, 2002. All rights reserved.
//                 
//          This software and documentation constitute an unpublished work
//          and contain valuable trade secrets and proprietary information
//          belonging to the University. None of the foregoing material may be
//          copied or duplicated or disclosed without the express, written
//          permission of University. THE UNIVERSITY EXPRESSLY DISCLAIMS ANY
//          AND ALL WARRANTIES CONCERNING THIS SOFTWARE AND DOCUMENTATION,
//          INCLUDING ANY WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
//          PARTICULAR PURPOSE, AND WARRANTIES OF PERFORMANCE, AND ANY WARRANTY
//          THAT MIGHT OTHERWISE ARISE FROM COURSE OF DEALING OR USAGE OF TRADE.
//          NO WARRANTY IS EITHER EXPRESS OR IMPLIED WITH RESPECT TO THE USE OF
//          THE SOFTWARE OR DOCUMENTATION. Under no circumstances shall the
//          University be liable for incidental, special, indirect, direct or
//          consequential damages or loss of profits, interruption of business,
//          or related expenses which may arise from use of software or documentation,
//          including but not limited to those resulting from defects in software
//          and/or documentation, or loss or inaccuracy of data of any kind.
//
//    Purpose : Assists in error reporting. OSCARError objects contain specific 
//              information about the error state of each object in OSCAR. Each 
//              OSCARError object consists of an integer value that can uniquely
//              define the error, and a string description of the error.
//
//------------------------------------------------------------------------------
//
//    $Revisions$
//        
//      3/23/01 - Modified OSCARError to a class that contains string
//                    descriptions of the errors
//    $Log: OSCARError.h,v $
//    Revision 1.8  2005/03/14 21:50:07  pmarch
//    Added to namespace OSCAR and removed "RR" from front of class names.
//
//    Revision 1.7  2004/07/30 18:45:18  chetan
//    Getting rid of warnings (level 4) in VC++ 6.0
//
//    Revision 1.6  2004/07/19 16:32:59  edjung
//    -made fix to constructors for ANSI C++ compliance with temporary OSCARError objects
//    -added DUMMY_ERROR class
//
//    Revision 1.5  2004/06/04 16:04:38  chetan
//    Removed #include Commdefs.h
//
//    Revision 1.4  2004/06/01 18:15:11  pmarch
//    Added std:: in front of input/output objects.
//
//    Revision 1.3  2004/05/26 19:37:16  pmarch
//    Added /defgroup and /ingroup tags
//
//    Revision 1.2  2003/09/05 15:36:16  eswint
//    - Changed default arguments OSCARError(0,"No Error"...) to OSCARError(noError) and String(" ") to String("")
//    - Commented, format
//
//    Revision 1.1  2003/08/14 16:20:20  pmarch
//    Added files to module
//
//
#ifndef OSCARError_hpp
#define OSCARError_hpp

#include "CommIncludes.h"
#include "String.h"

namespace OSCAR {

  class OSCARError
  {
  public:
  
    OSCARError(int errorCode, const String& basicDescription, const String& customDescription = String());
  
    OSCARError(const OSCARError& rhs);
  
    virtual ~OSCARError();
  
    OSCARError& operator=(const OSCARError& rhs);
  
    void SetErrorCode(int errorCode);
  
    void SetBasicDescription(const String& basicDesc);
  
    void SetCustomDescription(const String& customDesc);
  
    int GetErrorCode() const;
  
    const String& GetBasicDescription() const;
  
    const String& GetCustomDescription() const;
  
    operator int() const;
  
    bool operator==(const OSCARError& err) const;
  
    bool operator!=(const OSCARError& err) const;
  
  protected:
  
    int errorCode;                //Uniquely defines the error.
  
    String  basicDescription;   //Basic error description defined with all static OSCARErrors
  
    String  customDescription;  //Customized error description supplied by programmer
  
  }; //end of OSCARError definition

  extern std::ostream& operator<<(std::ostream& strm, const OSCARError& err);

  extern OSCARError operator+(const OSCARError& e1, const OSCARError& e2);
    
  #include "OSCARError.ipp"
}
#endif    //end of #ifndef OSCARError_hpp

RRG Homepage

OSCAR Overview

OSCAR Tutorials

Simulations