---

Base.h

Go to the documentation of this file.

//
//      Title     : Base.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: Acts as the base class for all other OSCAR classes.
//
//----------------------------------------------------------------------------
//
//      $Revisions$
//
//      $Log: Base.h,v $
//      Revision 1.15  2005/03/14 21:50:05  pmarch
//      Added to namespace OSCAR and removed "RR" from front of class names.
//
//      Revision 1.14  2005/01/06 22:43:00  chetan
//      Added TLS
//
//      Revision 1.13  2005/01/06 17:22:06  chetan
//      Added documentation for ToDo related to thread safety
//
//      Revision 1.12  2004/11/15 21:49:45  chetan
//      removed const qualified from OSCARError argument in constructor
//
//      Revision 1.11  2004/07/30 18:45:17  chetan
//      Getting rid of warnings (level 4) in VC++ 6.0
//
//      Revision 1.10  2004/07/19 16:32:57  edjung
//      -made fix to constructors for ANSI C++ compliance with temporary OSCARError objects
//      -added DUMMY_ERROR class
//
//      Revision 1.9  2004/06/04 16:04:23  chetan
//      Removed #include Commdefs.h
//
//      Revision 1.8  2004/06/01 18:15:13  pmarch
//      Added std:: in front of input/output objects.
//
//      Revision 1.7  2004/05/26 19:37:17  pmarch
//      Added /defgroup and /ingroup tags
//
//      Revision 1.6  2003/10/07 01:42:39  ndesai
//      no message
//
//      Revision 1.5  2003/10/07 01:41:32  ndesai
//      sadfgsadfgdafsg
//
//      Revision 1.4  2003/09/19 03:44:21  edjung
//      -Changed Base constructor to const RROSCAR& err
//      for .Net
//
//      Revision 1.3  2003/09/05 15:36:20  eswint
//      - Changed default arguments OSCARError(0,"No Error"...) to OSCARError(noError) and String(" ") to String("")
//      - Commented, format
//
//      Revision 1.2  2003/09/05 13:37:17  eswint
//      - Changed default parameters OSCARError(0,"No Error"...) to OSCARError(noError) and String(" ") to String("")
//
//      Revision 1.1  2003/08/14 16:20:25  pmarch
//      Added files to module
//
//
#ifndef Base_hpp
#define Base_hpp

#include "BaseError.h"
#include "CommIncludes.h"
#include "Console.h"
#include "OSCARError.h"
#include "String.h"

namespace OSCAR {

  class Base
  {
  public:
  
    Base(const String& name = String(), OSCARError &err = DUMMY_ERROR(noError));
  
    //Base(const String& name = String());
  
    Base(const Base& rhs);
  
    virtual ~Base();
  
    virtual Base& operator=(const Base& rhs);
  
    virtual const String& GetName() const;
  
    virtual void SetName(const String& name);
  
    virtual const OSCARError&   GetError() const;
  
    virtual void ClearError() const;
  
    static bool EnableErrorLogging(const String& errLogFileName = String("OSCARErrorLog.txt"));
  
    static bool DisableErrorLogging();
  
  protected:
  
    String name; //name of the Base Object     
  
    mutable OSCARError error;  //This is declared mutable because a change to error should
    //not be considered as a change to the object. This will allow
    //const methods that set the error code, to still be declared constant.
  
    virtual void setError(const OSCARError& err) const;
  
    static TLS std::ofstream errLogStream;  //output stream for logging errors
  
    static TLS bool errLogging;  //this variable determines whether errors are to be logged or not
  
  
  };  //End of Base definition

  #include "Base.ipp"
}
#endif //end of #ifndef "Base_hpp"

RRG Homepage

OSCAR Overview

OSCAR Tutorials

Simulations