STK_IPage.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
 * created on: 22 avr. 2010
 * Purpose:  Public interface of the IPage class.
 * Author:   iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 *
 **/
 
#ifndef STK_IPAGE_H
#define STK_IPAGE_H
 
#include <vector>
#include "STK_Option.h"
 
namespace STK
{
class IPage
{
  public:
    typedef std::vector<Option> ContOption;
 
    IPage( String const& name, int const& level, bool isOptional);
 
    IPage( IPage const& page);
 
    virtual ~IPage();
 
    inline String const& name() const { return name_;}
    inline bool isOptional() const { return isOptional_;}
    inline ContOption const& options() const { return options_;};
    inline String const& msg_error() const { return msg_error_;}
 
    Option& option( String const& name);
 
    Option const& option( String const& name) const;
 
    inline Option const& option(int const& pos) const
    { return options_.at(ContOption::size_type(pos));}
 
    inline Option& option(int const& pos)
    { return options_.at(ContOption::size_type(pos));}
 
    inline Option const& operator[](int const& pos) const
    { return options_.at(ContOption::size_type(pos));}
 
    inline Option& operator[](int const& pos)
    { return options_.at(ContOption::size_type(pos));}
 
    inline void addOption(Option const& opt)
    { return options_.push_back(opt);}
 
    void addPage(IPage const& page);
    void read( istream& is);
    void write( ostream& os) const;
    inline virtual bool validate() { return true; }
    inline virtual IPage* clone() const { return new IPage(*this); }
 
  protected:
    bool isOptional_;
    ContOption options_;
 
    mutable String msg_error_;
 
  private:
    String name_;
    mutable int level_;
    mutable String keyword_;
    bool findKeyword( istream& is) const;
    bool processLine( String const& line);
};
 
} // namespace STK
 
#endif /* STK_IPAGE_H */