OptionsFromStreamPack_CommandLineOptionsFromStreamProcessor.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library 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.1 of the
// License, or (at your option) any later version.
//  
// This library 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 library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef OPTIONS_FORM_STEAM_PACK_COMMANDLINE_OPTIONS_FROM_STREAM_PROCESSOR_HPP
#define OPTIONS_FORM_STEAM_PACK_COMMANDLINE_OPTIONS_FROM_STREAM_PROCESSOR_HPP

#include "OptionsFromStreamPack_OptionsFromStream.hpp"
#include "Teuchos_CommandLineProcessor.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace OptionsFromStreamPack {

class CommandLineOptionsFromStreamProcessor {
public:

  CommandLineOptionsFromStreamProcessor(
    const std::string  &options_file_name_opt_name   = "ofs-options-file"
    ,const std::string  &options_file_name_opt_doc   = "The name of the file containing input options for OptionsFromStream object."
    ,const std::string &options_file_name            = ""
    ,const std::string &extra_options_str_opt_name   = "ofs-extra-options"
    ,const std::string &extra_options_str_opt_doc    = "Extra options in format \"OptGrp1{name1=val1,...,namen=valn}:OptGr2{name1=val1,...,namen=valn}:...\""
    ,const std::string &extra_options_str            = ""
    );
  // RAB: 2006/01/27: Note, this value contains no semi-columns since this
  // conflicts with Trilinos' runtests script.  Therefore, I have to replace
  // the ',' separators with ';' below!
  // Note: we can leave off the last ',' since it turns out that the
  // way the new OptionsFromStream::parse_options(...) is written that
  // the last semicolon in an options group is not necessary!

  void set_options(
    Teuchos::RCP<OptionsFromStream> const& options
    );

  Teuchos::RCP<OptionsFromStream> get_options() const;

  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,options_file_name_opt_name);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,options_file_name_opt_doc);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,options_file_name);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,extra_options_str_opt_name);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,extra_options_str_opt_doc);

  STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,extra_options_str);

  void setup_commandline_processor(
    Teuchos::CommandLineProcessor *clp
    );

  void process_options();

  Teuchos::RCP<OptionsFromStream> process_and_get_options();

private:

  Teuchos::RCP<OptionsFromStream>     options_;

};

} // end namespace OptionsFromStreamPack

#endif  // OPTIONS_FORM_STEAM_PACK_COMMANDLINE_OPTIONS_FROM_STREAM_PROCESSOR_HPP