MoochoPack: Miscellaneous Utilities for MOOCHO  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
OptionsFromStreamPack_SetOptionsFromStreamNode.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef SET_OPTIONS_FROM_STREAM_NODE_H
43 #define SET_OPTIONS_FROM_STREAM_NODE_H
44 
45 #include "OptionsFromStreamPack_SetOptionsFromStream.hpp"
46 #include "OptionsFromStreamPack_StringToIntMap.hpp"
47 
48 namespace OptionsFromStreamPack {
49 
56 public:
57 
68  SetOptionsFromStreamNode( const std::string& options_group
69  , int num_options, const char* option_names[]
70  , bool exists_optional = true );
71 
78  void set_options( const OptionsFromStream& options );
79 
80 protected:
81 
88  virtual void setOption( int option_num, const std::string& option_value ) = 0;
89 
90 private:
91  StringToIntMap name_map_;
92  bool exists_optional_;
93 
94 }; // end class SetOptionsFromStreamNode
95 
96 } // end namespace OptionsFromStreamPack
97 
98 #endif // SET_OPTIONS_FROM_STREAM_NODE_H
Extracts options from a text stream and then allows convenient access to them.
void set_options(const OptionsFromStream &options)
Overridden from SetOptionsFromStream and calls setOption(...).
Abstact interface for objects that have options to be set that are contained in an OptionsFromStreamO...
SetOptionsFromStreamNode(const std::string &options_group, int num_options, const char *option_names[], bool exists_optional=true)
Constructs with the name of the options group and the names of the options.
virtual void setOption(int option_num, const std::string &option_value)=0
To be overridden by the subclass to set an option given its integer position and the option value...