termreason.h

Go to the documentation of this file.

// Termination Reason Class -*- C++ -*-

// $Id: termreason.h 347 2008-02-06 15:20:01Z schilly $
// Copyright (C) 2001-2003 Hermann Schichl
//
// This file is part of the COCONUT API.  This library
// is free software; you can redistribute it and/or modify it under the
// terms of the Library GNU General Public License as published by the
// Free Software Foundation; either version 2, or (at your option)
// any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// Library GNU General Public License for more details.

// As a special exception, you may use this file as part of a free software
// library without restriction.  Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the Library GNU General Public License.  This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the Library GNU General Public License.

#ifndef _TERMREASON_H_
#define _TERMREASON_H_

#include <string>
#include <map>

namespace coco {

const std::string& get_translated_message(const std::string& msg);
void set_translation_map(const std::map<std::string,std::string>& tr_msg_map);


class termination_reason
{
private:
  std::string termr_string;
  int termr_code;
public:
  termination_reason() : termr_string(std::string("SUCCESS")), termr_code(0) {}
  
  termination_reason(int termr_r, const std::string& termr_ref)
        : termr_string(termr_ref), termr_code(termr_r) {}

  termination_reason(const termination_reason& __t)
        : termr_string(__t.termr_string), termr_code(__t.termr_code) {}

  termination_reason& operator=(const termination_reason& __t)
  {
    termr_string = __t.termr_string;
    termr_code = __t.termr_code;
    return *this;
  }
  
  const std::string& get_message() const { return get_translated_message(termr_string); }

  int get_code() const { return termr_code; }

  friend std::ostream& operator<< (std::ostream& o, const termination_reason& __x);
};


inline std::ostream& operator<< (std::ostream& o, const termination_reason& __x)
{
  return o << __x.get_message();
}

} // namespace coco

#endif /* _TERMREASON_H_*/

---