STK_Option.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2010  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
 * created on: 18 oct. 2010
 * Purpose:  Declaration of the Optio class.
 * Author:   iovleff, serge.iovleff@stkpp.org
 *
 **/

#ifndef STK_OPTION_H
#define STK_OPTION_H

// C++ headers
#include <list>

// STK+ headers
#include "../../STKernel/include/STK_String.h"
#include "../../STKernel/include/STK_Integer.h"
#include "../../STKernel/include/STK_Real.h"
#include "../../STKernel/include/STK_Range.h"
#include "../../STKernel/include/STK_Stream.h"

#include "../include/STK_DManager_Util.h"

namespace STK
{

// forward declaration of the IPage class
class IPage;

class Option
{
  public:
    enum TypeOption
    {
      unknown_ =0,
      string_,      
      real_,        
      integer_,     
      range_,       
      lstring_,     
      lreal_,       
      linteger_,    
      lrange_,       
      page_         
    };

    Option( String const& name, TypeOption type = string_, bool isOptional = true);
    Option( IPage const& page);
    Option( Option const& opt);
    ~Option();

    Option& operator=(const Option &opt);

    inline String const& name() const { return name_;}
    inline TypeOption type() const { return type_;}
    inline bool isOptional() const { return isOptional_;}

    inline void  setListSeparator( Char const& sep  )
    { sep_ = sep;}

    void write( ostream& os) const;

    void read( istream& is);

    bool setValue( String const& str );

    void setPage( IPage const& value );

    inline String const& get( String const& value ) const
    { return *p_String_;}
    inline Real const& get( Real const& value) const
    { return *p_Real_;}
    inline Integer const& get( Integer const& value) const
    { return *p_Integer_;}
    inline Range const& get( Range const& value) const
    { return *p_Range_;}
    inline std::list<String> const& get( std::list<String> const& value) const
    { return *p_lString_;}
    inline std::list<Real> const& get( std::list<Real> const& value) const
    { return *p_lReal_;}
    inline std::list<Integer> const& get( std::list<Integer> const& value) const
    { return *p_lInteger_;}
    inline std::list<Range> const& get( std::list<Range> const& value) const
    { return *p_lRange_;}
    inline IPage const& get( IPage const& value) const
    { return *p_Page_;}

  protected:
    void set( String const& value );
    void set( Real const& value );
    void set( Integer const& value );
    void set( Range const& value );
    void set( std::list<String> const& value );
    void set(std::list<Real> const& value );
    void set(std::list<Integer> const& value );
    void set(std::list<Range> const& value );

  private:
    String name_;
    Char sep_;
    TypeOption type_;
    bool isOptional_;
    bool isValued_;
    union
    {
      String*  p_String_;
      Real*    p_Real_;
      Integer* p_Integer_;
      Range* p_Range_;
      std::list<String>*  p_lString_;
      std::list<Real>*    p_lReal_;
      std::list<Integer>* p_lInteger_;
      std::list<Range>*   p_lRange_;
      IPage* p_Page_;
    };
    void deleteValue();
    void setDefaultValue();
};

}

#endif /* STK_OPTION_H */