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                               *
\*****************************************************************************/

// forward.
class byte_array;


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

  inline ~outcome() { _o_value = 0; }  

  inline bool operator == (const outcome &to_compare) const
      { return _o_value == to_compare._o_value; }

  inline bool operator != (const outcome &to_compare) const
      { return _o_value != to_compare._o_value; }

  inline bool operator == (int to_compare) const
      { return _o_value == to_compare; }
  inline bool operator != (int to_compare) const
      { return _o_value != to_compare; }

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

  void pack(byte_array &packed_form) const;
    //<! creates a packed form of the outcome in "packed_form".

  bool unpack(byte_array &packed_form);
    //<! restores the outcome from the "packed_form".

  int packed_size() const { return sizeof(_o_value); }
    //<! the size in bytes of an outcome when packed.

private:
  int _o_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


#endif

---