STK_IPage.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
 * created on: 22 avr. 2010
 * Purpose:  Public interface of the IPage class.
 * Author:   iovleff, serge.iovleff@stkpp.org
 *
 **/

#ifndef STK_IPAGE_H
#define STK_IPAGE_H

// C++ headers
#include <vector>
#include <string>

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

#include "STK_Option.h"

namespace STK
{
class IPage
{
  public:
    typedef std::vector<Option> ContOption;

    IPage( String const& name, Integer 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_;};

    Option& option( String const& name);

    Option const& option( String const& name) const;

    inline Option const& option(Integer const& pos) const
    { return options_.at(ContOption::size_type(pos));}

    inline Option& option(Integer const& pos)
    { return options_.at(ContOption::size_type(pos));}

    inline Option const& operator[](Integer const& pos) const
    { return options_.at(ContOption::size_type(pos));}

    inline Option& operator[](Integer 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 Integer level_;
    mutable String keyword_;
    bool findKeyword( istream& is) const;
    bool processLine( String const& line);
};

} // namespace STK

#endif /* STK_IPAGE_H */