variable.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES   *
 *   {prenom.nom}_at_lip6.fr                                                  *
 *                                                                         *
 *   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.             *
 ***************************************************************************/
#ifndef GUM_VARIABLE_H
#define GUM_VARIABLE_H

#include <iostream>
#include <string>

#include <agrum/agrum.h>

namespace gum {

  enum class VarType : char { Discretized, Labelized, Range, Continuous };

  class Variable;


  std::ostream& operator<<(std::ostream& s, const Variable& LDRV);

  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===                            GUM_VARIABLE                             ===
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */

  class Variable {
    public:
    // ############################################################################
    // ############################################################################


    virtual ~Variable();


    virtual Variable* clone() const = 0;


    // ############################################################################
    // ############################################################################


    Variable& operator=(const Variable& aRV);


    virtual bool operator==(const Variable& aRV) const;


    virtual bool operator!=(const Variable& aRV) const;


    // ############################################################################
    // ############################################################################


    void setName(const std::string& theValue);


    const std::string& name() const;


    void setDescription(const std::string& theValue) const;


    const std::string& description() const;


    virtual VarType varType() const = 0;

    virtual const std::string domain() const = 0;


    protected:
    Variable() { GUM_CONSTRUCTOR(Variable); };


    void _copy(const Variable& aRV);


    Variable(const std::string& aName, const std::string& aDesc);


    Variable(const Variable& aRV);

    private:
    std::string __name;

    mutable std::string __description;
  };

} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/variables/variable_inl.h>
#endif /* GUM_NO_INLINE */

#endif /* GUM_VARIABLE_H */