IValue.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2009 by Robot Group Leipzig                        *
 *    martius@informatik.uni-leipzig.de                                    *
 *    fhesse@informatik.uni-leipzig.de                                     *
 *    der@informatik.uni-leipzig.de                                        *
 *    guettler@informatik.uni-leipzig.de                                   *
 *    jhoffmann@informatik.uni-leipzig.de                                  *
 *    joergweide84@aol.com (robot12)                                       *
 *                                                                         *
 *   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 program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************
 *                                                                         *
 *   This interface is only to describe a value for a Gen. It gives some   *
 *   conditions for the values. The operators add and mul must be declared.*
 *   They must have a name and it must be possible to change the value in a*
 *   string for log or debug outputs.                                      *
 *                                                                         *
 *   $Log: IValue.h,v $
 *   Revision 1.6  2009/10/21 14:08:19  robot12
 *   add restore and store functions to the ga package
 *
 *   Revision 1.5  2009/07/21 08:37:59  robot12
 *   add some comments
 *
 *   Revision 1.4  2009/06/26 13:08:25  robot12
 *   finishing Values and add some comments
 *
 *   Revision 1.3  2009/05/12 13:29:25  robot12
 *   some new function
 *   -> toString methodes
 *
 *   Revision 1.2  2009/05/06 13:28:22  robot12
 *   some implements... Finish
 *
 *   Revision 1.1  2009/05/04 15:27:57  robot12
 *   rename of some files and moving files to other positions
 *    - SingletonGenAlgAPI has one error!!! --> is not ready now
 *
 *   Revision 1.6  2009/05/04 09:20:52  robot12
 *   some implements.. Finish --> first compile
 *
 *   Revision 1.5  2009/04/29 14:32:28  robot12
 *   some implements... Part4
 *
 *   Revision 1.4  2009/04/24 11:26:07  robot12
 *   some implements
 *
 *   Revision 1.3  2009/04/23 15:17:42  jhoffmann
 *   inserted copyright-template, corrected includes, doxygen style templated
 *
 ***************************************************************************/
#ifndef IVALUE_H_
#define IVALUE_H_

//includes
#include <string>
#include <selforg/inspectable.h>
#include <selforg/storeable.h>

/**
 * This class is a interface for a value which is part of a gen. Over this concept is it paissible
 * to make the Gen and the GenFactory independent from his saved type.
 */
class IValue : public Inspectable
{
public:

  /**
   * constructor
   * Needs a string for the name of the value. In the normal way it is the Type of the Value. For example "templateValue".
   * @param name (string) the name
   */
  IValue(std::string name);


  /**
   * default destructor
   */
  virtual ~IValue();

  /**
   * the mul. operator. Dosn't change this class!!!
   * @param (const IValue&) the other part of the operation
   * @return (IValue*) the result
   */
  virtual IValue* operator*(const IValue&)const = 0;

   /**
        * the add operator. Dosn't change this class!!!
        * @param (const IValue&) the other part of the operation
        * @return (IValue*) the result
        */
  virtual IValue* operator+(const IValue&)const = 0;

  /**
   * the cast operator for a cast in type string
   * @return (string) the value as string
   */
  virtual operator std::string(void)const;

  /**
   * store the value in a file
   * @param f (FILE*) the file to store
   * @return (bool) true if all ok.
   */
  virtual bool store(FILE* f) const;

  /**
   * restore the value from a file
   * @param f (FILE*) the file where the value inside
   * @return (bool) true if all ok.
   */
  virtual bool restore(FILE* f);

protected:
        /**
         * the name of this class.
         */
        std::string m_name;
};

#endif /* IVALUE_H_ */

---