outcome.h

Go to the documentation of this file.

#ifndef OUTCOME_CLASS
#define OUTCOME_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : outcome                                                           *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1990-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "definitions.h"

namespace basis {


class outcome
{
public:
  outcome(int value = 0) : c_outcome_value(value) {}

  ~outcome() { c_outcome_value = 0; }  

  bool equal_to(const outcome &to_compare) const
      { return c_outcome_value == to_compare.c_outcome_value; }

  bool operator == (int to_compare) const
      { return c_outcome_value == to_compare; }

  int value() const { return c_outcome_value; }
    //<! returns the numerical value for the outcome.

  int packed_size() const { return 4; }

private:
  int c_outcome_value;  //<! the numerical id for the outcome.
};


#define PROMOTE_OUTCOME(outc) \
  if (outc != common::OKAY) return outc



#define DEFINE_OUTCOME(NAME, CURRENT_VALUE, INFO_STRING) \
  NAME = CURRENT_VALUE


#define DEFINE_API_OUTCOME(NAME, CURRENT_VALUE, INFO_STRING) \
  NAME = CURRENT_VALUE


} //namespace.

#endif