STK_IVariable.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2016  Serge Iovleff, Université Lille 1, Inria
 
    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 : S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
*/
 
/*
 * Project:  stkpp::DManager
 * Purpose:  Define the Abstract Variable class
 * Author:   Serge Iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 *
 **/
 
#ifndef STK_IVARIABLE_H
#define STK_IVARIABLE_H
 
#include "STK_DManager_Util.h"
//#include <Arrays/include/STK_Display.h>
 
namespace STK
{
// forward definition
template <class TYPE> class Variable;
 
typedef Variable<String> VariableString;
 
class IVariable
{
  protected:
    const Base::IdType type_;
    String name_;
    IVariable( Base::IdType const& type, String const& name)
             : type_(type), name_(name)
    {}
    IVariable( const IVariable& V)
             : type_(V.type_), name_(V.name_)
    {}
 
  public:
    virtual ~IVariable() {}
    IVariable& operator=(const IVariable &V)
    {
      name_ = V.name_;  // copy name_ of the variable
      return *this;
    }
    static inline String giveName( int num= 0, String const& prefix = STRING_VAR)
    { return (prefix+typeToString<int> (num));}
    inline const Base::IdType& getType() const { return type_;}
    inline String const& name() const { return name_;}
    inline void setName( int num= 0, String const& prefix  = STRING_VAR)
    { name_ = (prefix+typeToString<int> (num));}
    inline void setName( String const& name) { name_ = name;}
    template<class Type>
    inline String eltAsString(int pos) const
    { return typeToString<Type>(static_cast<Variable<Type> const&>(*this).elt(pos));}
    virtual void exportAsString( VariableString& V) const =0;
    virtual void pushBackNAValues(int n=1) = 0;
    virtual int size() const = 0;
    virtual void insertElt(int pos, int n =1) = 0;
    virtual void clear() = 0;
    virtual void erase(int pos, int n=1) = 0;
    virtual void shift(int beg) = 0;
    virtual void pushBack(int n =1) = 0;
    virtual void popBack(int n =1) = 0;
    virtual IVariable& operator<<( VariableString const& V) =0;
    virtual const IVariable& operator>>( VariableString& V) const =0;
    virtual IVariable* clone( bool ref = false) const = 0;
};
 
} // namespace STK
 
#endif //STK_IVARIABLE_H