MOOCHO (Single Doxygen Collection) Version of the Day
OptionsFromStreamPack_CommandLineOptionsFromStreamProcessor.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef OPTIONS_FORM_STEAM_PACK_COMMANDLINE_OPTIONS_FROM_STREAM_PROCESSOR_HPP
00043 #define OPTIONS_FORM_STEAM_PACK_COMMANDLINE_OPTIONS_FROM_STREAM_PROCESSOR_HPP
00044 
00045 #include "OptionsFromStreamPack_OptionsFromStream.hpp"
00046 #include "Teuchos_CommandLineProcessor.hpp"
00047 #include "Teuchos_RCP.hpp"
00048 #include "Teuchos_StandardMemberCompositionMacros.hpp"
00049 
00050 namespace OptionsFromStreamPack {
00051 
00057 class CommandLineOptionsFromStreamProcessor {
00058 public:
00059 
00071   CommandLineOptionsFromStreamProcessor(
00072     const std::string  &options_file_name_opt_name   = "ofs-options-file"
00073     ,const std::string  &options_file_name_opt_doc   = "The name of the file containing input options for OptionsFromStream object."
00074     ,const std::string &options_file_name            = ""
00075     ,const std::string &extra_options_str_opt_name   = "ofs-extra-options"
00076     ,const std::string &extra_options_str_opt_doc    = "Extra options in format \"OptGrp1{name1=val1,...,namen=valn}:OptGr2{name1=val1,...,namen=valn}:...\""
00077     ,const std::string &extra_options_str            = ""
00078     );
00079   // RAB: 2006/01/27: Note, this value contains no semi-columns since this
00080   // conflicts with Trilinos' runtests script.  Therefore, I have to replace
00081   // the ',' separators with ';' below!
00082   // Note: we can leave off the last ',' since it turns out that the
00083   // way the new OptionsFromStream::parse_options(...) is written that
00084   // the last semicolon in an options group is not necessary!
00085 
00093   void set_options(
00094     Teuchos::RCP<OptionsFromStream> const& options
00095     );
00096 
00102   Teuchos::RCP<OptionsFromStream> get_options() const;
00103 
00111   STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,options_file_name_opt_name);
00112 
00120   STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,options_file_name_opt_doc);
00121 
00129   STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,options_file_name);
00130 
00138   STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,extra_options_str_opt_name);
00139 
00147   STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,extra_options_str_opt_doc);
00148 
00156   STANDARD_MEMBER_COMPOSITION_MEMBERS(std::string,extra_options_str);
00157 
00166   void setup_commandline_processor(
00167     Teuchos::CommandLineProcessor *clp
00168     );
00169 
00186   void process_options();
00187 
00191   Teuchos::RCP<OptionsFromStream> process_and_get_options();
00192 
00193 private:
00194 
00195   Teuchos::RCP<OptionsFromStream>     options_;
00196 
00197 };
00198 
00199 } // end namespace OptionsFromStreamPack
00200 
00201 #endif  // OPTIONS_FORM_STEAM_PACK_COMMANDLINE_OPTIONS_FROM_STREAM_PROCESSOR_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines