/**
 * @module cdat
 * @author Guenther Neuwirth (0626638), Manuel Mausz (0728348)
 * @brief  TODO
 * @date   10.05.2009
 */

#ifndef CDAT_H
#define CDAT_H

#include <boost/operators.hpp>
#include <iostream>

/**
 * @class CDat
 *
 * TODO
 *
 * On error TODO will be thrown.
 */
class CDat
  : boost::operators<CDat>
{
  public:
    /**
     * @method CDat
     * @brief  Default ctor
     * @param  -
     * @return -
     * @globalvars none
     * @exception  bad_alloc
     * @conditions none
     */
    CDat()
    {}

    /**
     * @method ~CDat
     * @brief  Default dtor
     * @param  -
     * @return -
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    ~CDat()
    {}

    /**
     * @method CDat
     * @brief  Copy constructor for CDat
     * @param  other  reference to CDat which will be copied
     * @return -
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat(const CDat& other)
      : m_value(other.m_value)
    {}

    /**
     * @method CDat
     * @brief  Copy constructor for int
     * @param  newval  new value for CDat
     * @return -
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat(int newval)
      : m_value(newval)
    {}

    /**
     * @method value
     * @brief  returns value of CDat
     * @param  -
     * @return value of CDat
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    int value() const;

    /**
     * @method operator<
     * @brief  implementation of operator <
     * @param  reference to CDat
     * @return true if cdat is less than object x
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    bool operator<(const CDat& x) const;

    /**
     * @method operator==
     * @brief  implementation of operator ==
     * @param  reference to CDat
     * @return true if cdat equals object x
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    bool operator==(const CDat& x) const;

    /**
     * @method operator+=
     * @brief  implementation of operator +=
     * @param  reference to CDat
     * @return refecence to CDat
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat& operator+=(const CDat& x);

    /**
     * @method operator-=
     * @brief  implementation of operator -=
     * @param  reference to CDat
     * @return refecence to CDat
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat& operator-=(const CDat& x);

    /**
     * @method operator*=
     * @brief  implementation of operator *=
     * @param  reference to CDat
     * @return refecence to CDat
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat& operator*=(const CDat& x);

    /**
     * @method operator/=
     * @brief  implementation of operator /=
     * @param  reference to CDat
     * @return refecence to CDat
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat& operator/=(const CDat& x);

    /**
     * @method operator%=
     * @brief  implementation of operator %=
     * @param  reference to CDat
     * @return refecence to CDat
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat& operator%=(const CDat& x);

    /**
     * @method operator|=
     * @brief  implementation of operator |=
     * @param  reference to CDat
     * @return refecence to CDat
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat& operator|=(const CDat& x);

    /**
     * @method operator&=
     * @brief  implementation of operator &=
     * @param  reference to CDat
     * @return refecence to CDat
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat& operator&=(const CDat& x);

    /**
     * @method operator^=
     * @brief  implementation of operator ^=
     * @param  reference to CDat
     * @return refecence to CDat
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat& operator^=(const CDat& x);

    /**
     * @method operator++
     * @brief  implementation of operator ++
     * @param  -
     * @return refecence to CDat
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat& operator++();

    /**
     * @method operator--
     * @brief  implementation of operator --
     * @param  -
     * @return refecence to CDat
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    CDat& operator--();

    /**
     * @method operator<<
     * @brief  Shift/output operator for outputstream
     * @param  stream  reference to outputstream
     * @param  cdat    object which will be printed to stream
     * @return reference to outputstream
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    friend std::ostream& operator<<(std::ostream& stream, CDat cdat);

    /**
     * @method operator>>
     * @brief  Shift/read operator for inputstream
     * @param  stream  reference to inputstream
     * @param  cdat    reference to object which will be read from stream
     * @return reference to inputstream
     * @globalvars none
     * @exception  none
     * @conditions none
     */
    friend std::istream& operator>>(std::istream & stream, CDat& cdat);

  private:
    /* members */
    int m_value;
};

#endif

/* vim: set et sw=2 ts=2: */