JStatus.hh

Go to the documentation of this file.

#ifndef __JEEP__JSTATUS__
#define __JEEP__JSTATUS__

#include <istream>
#include <ostream>

#include "JLang/JEquals.hh"
#include "JIO/JSerialisable.hh"
#include "JIO/JSTDIO.hh"


/**
 * \author mdejong
 */

namespace JEEP {}
namespace JPP { using namespace JEEP; }

namespace JEEP {

  using JLANG::JEquals;
  using JIO::JReader;
  using JIO::JWriter;

 
  /**
   * Auxiliary class for status identifier.
   */
  class JStatus :
    public JEquals<JStatus>
  {
  public:
    /**
     * Default constructor.
     */
    JStatus() :
      __status(0)
    {}

  
    /**
     * Constructor.
     *
     * \param  status     status
     */
    JStatus(const int& status) :
      __status(status)
    {}


    /**
     * Get status.
     *
     * \return            status
     */
    int getStatus() const
    { 
      return this->__status;
    }


    /**
     * Get status.
     *
     * \return            status
     */
    int& getStatus() 
    { 
      return this->__status;
    }


    /**
     * Set status.
     *
     * \param  status    status
     */
    void setStatus(const int status)
    { 
      this->__status = status;
    }

    
    /**
     * Equal method.
     *
     * \param  status     status
     * \result            true if this status equal to given status; else false
     */
    inline bool equals(const JStatus& status) const
    {
      return this->getStatus() == status.getStatus();
    }

    
    /**
     * Read status from input.
     *
     * \param  in         input stream
     * \param  status     status
     * \return            input stream
     */
    friend inline std::istream& operator>>(std::istream& in, JStatus& status)
    {
      return in >> status.__status;
    }


    /**
     * Write status to output.
     *
     * \param  out        output stream
     * \param  status     status
     * \return            output stream
     */
    friend inline std::ostream& operator<<(std::ostream& out, const JStatus& status)
    {
      return out << status.__status;
    }
  

    /**
     * Read status from input.
     *
     * \param  in         reader
     * \param  status     status
     * \return            reader
     */
    friend inline JReader& operator>>(JReader& in, JStatus& status)
    {
      return in >> status.__status;
    }


    /**
     * Write status to output.
     *
     * \param  out        writer
     * \param  status     status
     * \return            writer
     */
    friend inline JWriter& operator<<(JWriter& out, const JStatus& status)
    {
      return out << status.__status;
    }       
           
  protected:
    int __status;
  };
}

#endif