STK_IVariable.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2007  Serge Iovleff

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser 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

    Contact : Serge.Iovleff@stkpp.org
*/

/*
 * Project:  stkpp::DManager
 * Purpose:  Define the Abstract Variable class
 * Author:   Serge Iovleff, serge.iovleff@stkpp.org
 *
 **/

#ifndef STK_IVARIABLE_H
#define STK_IVARIABLE_H

#include "STK_DManager_Util.h"

#include "../../STKernel/include/STK_String.h"
#include "../../STKernel/include/STK_String_Util.h"
#include "../../Sdk/include/STK_IContainer1D.h"

namespace STK
{
// forward definition
template <class TYPE>
class Variable;

class IVariable : virtual public IContainer1D
{
  protected:
    const IdType type_;

    String name_;

  protected:
    IVariable( const IdType &type, String const& name)
             : type_(type)
             , name_(name)
    { ;}

    IVariable( const IVariable& V)
             : type_(V.type_)
             , name_(V.name_)
    { ;}

  public:
    typedef Variable<String> _VarStringType;

    virtual ~IVariable() { ;}

    IVariable& operator=(const IVariable &V)
    {
      name_ = V.name_;  // copy name_ of the variable
      return *this;
    }

    static inline String giveName( Integer const& num    = 0
                                 , const String  &prefix = STRING_VAR
                                 )
   { return (prefix+typeToString<Integer> (num));}

    inline const IdType& getType() const
    { return type_;}

    inline String const& name() const
    { return name_;}

    inline void setName( Integer const& num     = 0
                       , const String  &prefix  = STRING_VAR
                )
    { name_ = (prefix+typeToString<Integer> (num));}

    inline void setName( String const& name)
    { name_ = name;}

    virtual void pushBackNAValues(Integer const& n=1) = 0;

    virtual Integer importString( const _VarStringType& V
                                , std::ios_base& (*f)(std::ios_base&) = std::dec
                                ) = 0;

    virtual const IVariable& exportString( _VarStringType& V
                                         , std::ios_base& (*f)(std::ios_base&)
                                           = std::dec
                                         ) const =0;

    virtual IVariable& operator<<( const _VarStringType& V) =0;

    virtual const IVariable& operator>>( _VarStringType& V) const =0;

    virtual IVariable* clone( bool ref = false) const = 0;
};

} // Namespace STK

#endif //STK_IVARIABLE_H