colorUnit.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: colorUnit.h,v 1.28 2005/12/23 17:02:08 amoll Exp $
//

#ifndef BALL_VIEW_DATATYPE_COLORUNIT_H
#define BALL_VIEW_DATATYPE_COLORUNIT_H

#ifndef BALL_COMMON_H
# include <BALL/common.h>
#endif

#ifndef BALL_DATATYPE_STRING_H
# include <BALL/DATATYPE/string.h>
#endif

#include <iostream>
#include <stdio.h>

namespace BALL
{
  namespace VIEW
  {
    class BALL_VIEW_EXPORT ColorUnit
    {
      public:

      //BALL_CREATE(ColorUnit)
      
      
      class BALL_VIEW_EXPORT NotInHexFormat:  public Exception::GeneralException
      {
        public:

        NotInHexFormat(const char* file, int line, const string& data);
      };



      ColorUnit();
    
      ColorUnit(const ColorUnit& color_unit);

      ColorUnit(const char* value)
        throw(Exception::InvalidRange, NotInHexFormat);

      ColorUnit(const String& value)
        throw(Exception::InvalidRange, NotInHexFormat);

      ColorUnit(const unsigned char value);

      ColorUnit(const short value)
        throw(Exception::InvalidRange);

      ColorUnit(const unsigned short value)
        throw(Exception::InvalidRange);

      ColorUnit(const int value)
        throw(Exception::InvalidRange);
    
      ColorUnit(const unsigned int value)
        throw(Exception::InvalidRange);

      ColorUnit(const long value)
        throw(Exception::InvalidRange);

      ColorUnit(const unsigned long value)
        throw(Exception::InvalidRange);
    
      ColorUnit(const float value)
        throw(Exception::InvalidRange);
    
      ColorUnit(const double value)
        throw(Exception::InvalidRange);



      ~ColorUnit();

      void clear();



      operator String () const;

      operator char () const;

      operator unsigned char () const;

      operator short () const;
      
      operator unsigned short () const;
      
      operator int () const;

      operator unsigned int () const;

      operator long () const;

      operator unsigned long () const;

      operator float () const;

      operator double () const;
      

      
      void set(const ColorUnit& color_unit);

      const ColorUnit& operator = (const ColorUnit& color_unit);
    
      void swap(ColorUnit& color_unit);



      void set(const char* value)
        throw(Exception::InvalidRange, NotInHexFormat);

      const ColorUnit& operator = (const char* value)
        throw(Exception::InvalidRange, NotInHexFormat);
    
      void get(char* value) const;

      void set(const String& value)
        throw(Exception::InvalidRange, NotInHexFormat);

      const ColorUnit& operator = (const String& value)
        throw(Exception::InvalidRange, NotInHexFormat);
    
      void get(String& value) const;

      void set(const unsigned char value);

      const ColorUnit& operator = (const unsigned char value);

      void get(unsigned char& value) const;

      void set(const short value)
        throw(Exception::InvalidRange);

      const ColorUnit& operator = (const short value)
        throw(Exception::InvalidRange);

      void get(short& value) const;

      void set(const unsigned short value)
        throw(Exception::InvalidRange);

      const ColorUnit& operator = (const unsigned short value)
        throw(Exception::InvalidRange);

      void get(unsigned short& value) const;

      void set(const int value)
        throw(Exception::InvalidRange);

      const ColorUnit& operator = (const int value)
        throw(Exception::InvalidRange);

      void get(int& value) const;

      void set(const unsigned int value)
        throw(Exception::InvalidRange);

      const ColorUnit& operator = (const unsigned int value)
        throw(Exception::InvalidRange);

      void get(unsigned int& value) const;

      void set(const long value)
        throw(Exception::InvalidRange);

      const ColorUnit& operator = (const long value)
        throw(Exception::InvalidRange);

      void get(long& value) const;

      void set(const unsigned long value)
        throw(Exception::InvalidRange);

      const ColorUnit& operator = (const unsigned long value)
        throw(Exception::InvalidRange);

      void get(unsigned long& value) const;

      void set(const float value)
        throw(Exception::InvalidRange);

      const ColorUnit& operator = (const float value)
        throw(Exception::InvalidRange);

      void get(float& value) const;

      void set(const double value)
        throw(Exception::InvalidRange);

      const ColorUnit& operator = (const double value)
        throw(Exception::InvalidRange);

      void get(double& value) const;



      bool operator == (const ColorUnit& color_unit) const;

      bool operator != (const ColorUnit& color_unit) const;
      
      bool operator < (const ColorUnit& color_unit) const;
      
      bool operator <= (const ColorUnit& color_unit) const;
      
      bool operator > (const ColorUnit& color_unit) const;

      bool operator >= (const ColorUnit& color_unit) const;
      


      void dump(std::ostream& s = std::cout, Size depth = 0) const;



      friend std::istream& operator >> (std::istream& s, ColorUnit& color_unit);

      friend std::ostream& operator << (std::ostream& s, const ColorUnit& color_unit);

      private:
    
      float hexToFloat_(const char* value)
        throw(Exception::InvalidRange, NotInHexFormat);
      
      float value_;
    
    };

#   ifndef BALL_NO_INLINE_FUNCTIONS
#     include <BALL/VIEW/DATATYPE/colorUnit.iC>
#   endif
  
  } // namespace VIEW
} // namespace BALL

#endif // BALL_VIEW_DATATYPE_COLORUNIT_H