Teuchos_ParameterEntryValidator.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H
#define TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H

#include "Teuchos_RCP.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_XMLObject.hpp"
#include "Teuchos_Describable.hpp"

namespace Teuchos {


#ifndef DOXYGEN_SHOULD_SKIP_THIS
class ParameterEntry;
#endif

class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT ParameterEntryValidator : public Describable
{
public:


  typedef unsigned int ValidatorID;

  typedef RCP<const Array<std::string> > ValidStringsList;


  ParameterEntryValidator() {}

  virtual const std::string getXMLTypeName() const=0;

  virtual void printDoc(
    std::string const& docString,
    std::ostream &out
    ) const = 0;

  virtual ValidStringsList validStringValues() const = 0;

  virtual void validate(
    ParameterEntry  const& entry,
    std::string const& paramName,
    std::string const& sublistName
    ) const = 0;

  virtual void validateAndModify(
    std::string const& paramName,
    std::string const& sublistName,
    ParameterEntry * entry
    ) const
    {
      TEUCHOS_TEST_FOR_EXCEPT(0==entry);
      this->validate(*entry,paramName,sublistName);
    }

  double convertStringToDouble(std::string str) const
  {
    #ifdef HAVE_TEUCHOSCORE_CXX11
      size_t idx = 0;
      double result = std::stod(str, &idx); // can throw std::invalid_argument
      if(idx != str.length()) { // check for extra bad format characters
        throw std::invalid_argument( "String: '" + str + "' had bad formatting for converting to a double." );
      }
      return result;
    #else
      return std::atof(str.c_str());
    #endif
  }

  int convertStringToInt(std::string str) const
  {
    #ifdef HAVE_TEUCHOSCORE_CXX11
      size_t idx = 0;
      int result = std::stoi(str, &idx); // can throw std::invalid_argument
      if(idx != str.length()) { // check for extra bad format characters
        throw std::invalid_argument( "String: '" + str + "' had bad formatting for converting to an int." );
      }
      return result;
    #else
      return std::atoi(str.c_str());
    #endif
  }

  int convertStringToLongLong(std::string str) const
  {
    size_t idx = 0;
    long long result = std::stoll(str, &idx); // can throw std::invalid_argument
    if(idx != str.length()) { // check for extra bad format characters
      throw std::invalid_argument( "String: '" + str + "' had bad formatting for converting to a long long." );
    }
    return result;
  }

};


} // namespace Teuchos


#endif // TEUCHOS_PARAMETER_ENTRY_VALIDATOR_H