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,2009,2010,2011,2012,2013 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 <queso/Environment.h>

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

#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.

namespace QUESO {

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:
  void   defineMyOptions  (po::options_description& optionsDesc) const;
  
  void   getMyOptionValues(po::options_description& optionsDesc);

  const BaseEnvironment& m_env;
  
  std::string              m_prefix;
  

  po::options_description* m_optionsDesc;

  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