EnvironmentOptions.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// QUESO - a library to support the Quantification of Uncertainty
// for Estimation, Simulation and Optimization
//
// Copyright (C) 2008-2017 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// 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. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

#ifndef UQ_ENVIRONMENT_OPTIONS_H
#define UQ_ENVIRONMENT_OPTIONS_H

#include <string>
#include <set>
#include <vector>

#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
#include <queso/BoostInputOptionsParser.h>
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS

#include <queso/ScopedPtr.h>

#define UQ_ENV_FILENAME_FOR_NO_OUTPUT_FILE "."
#define UQ_ENV_FILENAME_FOR_NO_INPUT_FILE  "."

#define UQ_ENV_HELP                         ""
#define UQ_ENV_NUM_SUB_ENVIRONMENTS_ODV     1
#define UQ_ENV_SUB_SCREEN_WRITE_ODV         0
#define UQ_ENV_SUB_DISPLAY_FILE_NAME_ODV    UQ_ENV_FILENAME_FOR_NO_OUTPUT_FILE
#define UQ_ENV_SUB_DISPLAY_ALLOW_ALL_ODV    0
#define UQ_ENV_SUB_DISPLAY_ALLOW_INTER0_ODV 0
#define UQ_ENV_SUB_DISPLAY_ALLOWED_SET_ODV  ""
#define UQ_ENV_DISPLAY_VERBOSITY_ODV        0
#define UQ_ENV_SYNC_VERBOSITY_ODV           0
#define UQ_ENV_CHECKING_LEVEL_ODV           0
#define UQ_ENV_RNG_TYPE_ODV                 "gsl"
#define UQ_ENV_SEED_ODV                     0
#define UQ_ENV_IDENTIFYING_STRING_ODV       ""
#define UQ_ENV_PLATFORM_NAME_ODV            ""
#define UQ_ENV_NUM_DEBUG_PARAMS_ODV         0
#define UQ_ENV_DEBUG_PARAM_ODV              0.

#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
// Forward declarations
namespace boost {
  namespace program_options {
    class options_description;
    }
}
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS

namespace QUESO {

// Forward declarations
class BaseEnvironment;

class EnvOptionsValues
{
public:

  EnvOptionsValues();
  EnvOptionsValues(const BaseEnvironment * env, const char * prefix);

  EnvOptionsValues(const EnvOptionsValues& src);

  virtual ~EnvOptionsValues();


  EnvOptionsValues & operator=(const EnvOptionsValues& rhs);

  std::string m_prefix;

  std::string m_help;

  unsigned int m_numSubEnvironments;

  std::string m_subDisplayFileName;


  bool m_subDisplayAllowAll;


  bool m_subDisplayAllowInter0;


  std::set<unsigned int> m_subDisplayAllowedSet;

  unsigned int m_displayVerbosity;

  unsigned int m_syncVerbosity;

  unsigned int m_checkingLevel;

  std::string m_rngType;


  int m_seed;

  std::string m_platformName;

  std::string m_identifyingString;

  unsigned int m_numDebugParams;

  std::vector<double> m_debugParams;

private:
  const BaseEnvironment * m_env;

#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  ScopedPtr<BoostInputOptionsParser>::Type m_parser;
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS

  std::string m_option_help;

  std::string m_option_numSubEnvironments;

  std::string m_option_subDisplayFileName;

  std::string m_option_subDisplayAllowAll;

  std::string m_option_subDisplayAllowInter0;

  std::string m_option_subDisplayAllowedSet;

  std::string m_option_displayVerbosity;

  std::string m_option_syncVerbosity;

  std::string m_option_checkingLevel;

  std::string m_option_rngType;

  std::string m_option_seed;

  std::string m_option_platformName;

  std::string m_option_identifyingString;

  void copy(const EnvOptionsValues& src);

  void checkOptions();

  friend std::ostream& operator<<(std::ostream& os,
      const EnvOptionsValues & obj);
};

class EnvironmentOptions
{
public:


  EnvironmentOptions(const BaseEnvironment& env, const char* prefix);

  EnvironmentOptions(const BaseEnvironment& env, const char* prefix, const EnvOptionsValues& alternativeOptionsValues);

 ~EnvironmentOptions();


  void scanOptionsValues();

  void print            (std::ostream& os) const;


  EnvOptionsValues  m_ov;

private:
#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  void   defineMyOptions  (boost::program_options::options_description& optionsDesc) const;

  void   getMyOptionValues(boost::program_options::options_description& optionsDesc);
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS

  const BaseEnvironment& m_env;

  std::string              m_prefix;


#ifndef DISABLE_BOOST_PROGRAM_OPTIONS
  ScopedPtr<boost::program_options::options_description>::Type m_optionsDesc;
#endif  // DISABLE_BOOST_PROGRAM_OPTIONS

  std::string              m_option_help;

  std::string              m_option_numSubEnvironments;

  std::string              m_option_subDisplayFileName;

  std::string              m_option_subDisplayAllowAll;

  std::string              m_option_subDisplayAllowInter0;

  std::string              m_option_subDisplayAllowedSet;

  std::string              m_option_displayVerbosity;

  std::string              m_option_syncVerbosity;

  std::string              m_option_checkingLevel;

  std::string              m_option_rngType;


  std::string              m_option_seed;

  std::string              m_option_platformName;

  std::string              m_option_identifyingString;
};

std::ostream& operator<<(std::ostream& os, const EnvironmentOptions& obj);

}  // End namespace QUESO

#endif // UQ_ENVIRONMENT_CLASS_H