/* $Id: OSErrorClass.h 4292 2011-09-21 05:47:18Z kmartin $ */
/** @file ErrorClass.h
 *
 * @author  Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin,
 *
 * \remarks
 * Copyright (C) 2005-2011, Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin,
 * Dalhousie University, Northwestern University, and the University of Chicago.
 * All Rights Reserved.
 * This software is licensed under the Eclipse Public License.
 * Please see the accompanying LICENSE file in root directory for terms.
 *
 */

#ifndef ERRORCLASS_H
#define ERRORCLASS_H

#include <string>

/*! \class ErrorClass
 *  \brief used for throwing exceptions.
 *
 * @author Robert Fourer, Jun Ma, Kipp Martin
 * @version 1.0, 03/14/2004
 * @since OS 1.0
 *
 * \remarks
 * when an error is encountered in a try-catch block
 * we throw an ErrorClass with the errormsg_
 */
class ErrorClass
{
public:

    /** the class constructor it has a single
     *  @param errormsg_ holds the error message as a string.
     */
    ErrorClass( std::string errormsg_);

    /** errormsg is the error that is causing the exception
     * to be thrown */
    std::string errormsg;

};
#endif
