10 #include "Teuchos_StandardParameterEntryValidators.hpp"
14 std::string Teuchos::getVerbosityLevelParameterValueName(
33 true, std::invalid_argument,
"Teuchos::getVerbosityLevelParameterValue"
34 "Name(const Teuchos::EVerbosityLevel): Input argument " << verbLevel <<
35 " has an invalid value. Valid values are VERB_DEFAULT=" <<
VERB_DEFAULT
56 Teuchos::verbosityLevelParameterEntryValidator(
57 std::string
const& defaultParameterName
61 new StringToIntegralParameterEntryValidator<EVerbosityLevel>(
64 getVerbosityLevelParameterValueName(
VERB_NONE),
65 getVerbosityLevelParameterValueName(
VERB_LOW),
67 getVerbosityLevelParameterValueName(
VERB_HIGH),
71 "Use level set in code",
73 "Produce minimal output",
74 "Produce a little more output",
75 "Produce a higher level of output",
76 "Produce the highest level of output"
78 tuple<EVerbosityLevel>(
103 BoolParameterEntryValidator::BoolParameterEntryValidator()
105 finishInitialization();
114 const std::string &sublistName,
const bool activeQuery
117 const any &anyValue = entry.
getAny(activeQuery);
118 if( anyValue.
type() ==
typeid(bool) )
119 return any_cast<
bool>(anyValue);
120 if( anyValue.
type() ==
typeid(std::string) ) {
121 std::string str = any_cast<std::string>(anyValue);
124 if( str ==
"false" ) {
127 else if( str ==
"true" ) {
132 throwTypeError(entry,paramName,sublistName);
138 const int defaultValue
142 if(entry)
return getBool(*entry,paramName,paramList.
name(),
true);
143 return paramList.
get(paramName,defaultValue);
150 return "boolValidator";
154 std::string
const & docString,
159 out <<
"# Accepted types: " << acceptedTypesString_ <<
".\n";
172 std::string
const& paramName,
173 std::string
const& sublistName
177 getBool(entry, paramName, sublistName,
false);
182 std::string
const& paramName,
183 std::string
const& sublistName,
195 void BoolParameterEntryValidator::finishInitialization()
197 std::ostringstream oss;
199 acceptedTypesString_ = oss.str();
201 acceptedTypesString_ = oss.str();
205 void BoolParameterEntryValidator::throwTypeError(
206 ParameterEntry
const& entry,
207 std::string
const& paramName,
208 std::string
const& sublistName
211 const std::string &entryName = entry.getAny(
false).typeName();
213 true, Exceptions::InvalidParameterType
214 ,
"Error, the parameter {paramName=\""<<paramName<<
"\""
215 ",type=\""<<entryName<<
"\"}"
216 <<
"\nin the sublist \"" << sublistName <<
"\""
217 <<
"\nhas the wrong type."
218 <<
"\n\nThe accepted types are: " << acceptedTypesString_ <<
"!";
231 : preferredType_(PREFER_DOUBLE), acceptedTypes_(
AcceptedTypes())
233 finishInitialization();
240 : preferredType_(preferredType), acceptedTypes_(acceptedTypes)
242 finishInitialization();
251 const std::string &sublistName,
const bool activeQuery
254 const any &anyValue = entry.
getAny(activeQuery);
255 if( acceptedTypes_.
allowInt() && anyValue.
type() ==
typeid(int) )
256 return any_cast<
int>(anyValue);
258 return as<int>(any_cast<
long long>(anyValue));
259 if( acceptedTypes_.
allowDouble() && anyValue.
type() ==
typeid(double) )
260 return as<int>(any_cast<
double>(anyValue));
261 if( acceptedTypes_.
allowString() && anyValue.
type() ==
typeid(std::string) )
262 return convertStringToInt(any_cast<std::string>(anyValue));
263 throwTypeError(entry,paramName,sublistName);
269 const std::string &sublistName,
const bool activeQuery
272 const any &anyValue = entry.
getAny(activeQuery);
273 if( acceptedTypes_.
allowInt() && anyValue.
type() ==
typeid(int) )
274 return as<long long>(any_cast<
int>(anyValue));
276 return any_cast<
long long>(anyValue);
277 if( acceptedTypes_.
allowDouble() && anyValue.
type() ==
typeid(double) )
278 return as<long long>(any_cast<
double>(anyValue));
279 if( acceptedTypes_.
allowString() && anyValue.
type() ==
typeid(std::string) )
280 return convertStringToLongLong(any_cast<std::string>(anyValue));
281 throwTypeError(entry,paramName,sublistName);
287 const std::string &sublistName,
const bool activeQuery
290 const any &anyValue = entry.
getAny(activeQuery);
291 if( acceptedTypes_.
allowInt() && anyValue.
type() ==
typeid(int) )
292 return as<double>(any_cast<
int>(anyValue));
294 return as<double>(any_cast<
long long>(anyValue));
295 if( acceptedTypes_.
allowDouble() && anyValue.
type() ==
typeid(double) )
296 return any_cast<
double>(anyValue);
297 if( acceptedTypes_.
allowString() && anyValue.
type() ==
typeid(std::string) )
298 return convertStringToDouble(any_cast<std::string>(anyValue));
299 throwTypeError(entry,paramName,sublistName);
306 const std::string &sublistName,
const bool activeQuery
309 const any &anyValue = entry.
getAny(activeQuery);
310 if( acceptedTypes_.
allowInt() && anyValue.
type() ==
typeid(int) )
314 if( acceptedTypes_.
allowDouble() && anyValue.
type() ==
typeid(double) )
316 if( acceptedTypes_.
allowString() && anyValue.
type() ==
typeid(std::string) )
317 return any_cast<std::string>(anyValue);
318 throwTypeError(entry,paramName,sublistName);
325 const int defaultValue
329 if(entry)
return getInt(*entry,paramName,paramList.
name(),
true);
330 return paramList.
get(paramName,defaultValue);
335 const long long defaultValue
340 return paramList.
get(paramName,defaultValue);
345 const double defaultValue
349 if(entry)
return getDouble(*entry,paramName,paramList.
name(),
true);
350 return paramList.
get(paramName,defaultValue);
356 const std::string &defaultValue
360 if(entry)
return getString(*entry,paramName,paramList.
name(),
true);
361 return paramList.
get(paramName,defaultValue);
388 return preferredType_;
397 return "anynumberValidator";
402 std::string
const & docString,
407 out <<
"# Accepted types: " << acceptedTypesString_ <<
".\n";
420 std::string
const& paramName,
421 std::string
const& sublistName
429 getDouble(entry, paramName, sublistName,
false);
434 std::string
const& paramName,
435 std::string
const& sublistName,
440 switch(preferredType_) {
443 getInt(*entry,paramName,sublistName,
false),
447 case PREFER_LONG_LONG:
455 getDouble(*entry,paramName,sublistName,
false),
461 getString(*entry,paramName,sublistName,
false),
474 void AnyNumberParameterEntryValidator::finishInitialization()
477 std::ostringstream oss;
478 bool addedType =
false;
484 oss <<
"\"long long\"";
488 if(addedType) oss <<
", ";
493 if(addedType) oss <<
", ";
497 acceptedTypesString_ = oss.str();
501 void AnyNumberParameterEntryValidator::throwTypeError(
502 ParameterEntry
const& entry,
503 std::string
const& paramName,
504 std::string
const& sublistName
507 const std::string &entryName = entry.getAny(
false).typeName();
509 true, Exceptions::InvalidParameterType
510 ,
"Error, the parameter {paramName=\""<<paramName<<
"\""
511 ",type=\""<<entryName<<
"\"}"
512 <<
"\nin the sublist \"" << sublistName <<
"\""
513 <<
"\nhas the wrong type."
514 <<
"\n\nThe accepted types are: " << acceptedTypesString_ <<
"!";
519 RCP<AnyNumberParameterEntryValidator>
522 return anyNumberParameterEntryValidator(
523 AnyNumberParameterEntryValidator::PREFER_INT,
536 return mustAlreadyExist_;
546 this->mustAlreadyExist_ = shouldFileExist;
547 return mustAlreadyExist_;
552 this->EmptyNameOK_ = isEmptyNameOK;
564 std::string
const &sublistName)
const
570 "The \"" << paramName <<
"\"" <<
571 " parameter in the \"" << sublistName <<
572 "\" sublist is has an error." << std::endl << std::endl <<
573 "Error: The value that you entered was the wrong type." << std::endl <<
574 "Parameter: " << paramName << std::endl <<
575 "Type specified: " << entryName << std::endl <<
576 "Type accepted: " <<
typeid(std::string).name() <<
577 std::endl << std::endl);
578 if(mustAlreadyExist_ && !EmptyNameOK_){
579 std::string fileName = getValue<std::string>(entry);
582 "The \"" << paramName <<
"\"" <<
583 " parameter in the \"" << sublistName <<
584 "\" sublist is has an error." << std::endl << std::endl <<
585 "Error: The file must already exists. The value you entered does " <<
586 "not corresspond to an existing file name." << std::endl <<
587 "Parameter: " << paramName << std::endl <<
588 "File name specified: " << fileName << std::endl << std::endl);
595 return "FilenameValidator";
600 std::string
const &docString, std::ostream &out)
const
603 out <<
"# Validator Used: " << std::endl;
604 out <<
"# FileName Validator" << std::endl;
620 validStrings_(
rcp(new
Array<std::string>(validStrings)))
628 return validStrings_;
635 return validStrings_;
641 std::string
const &sublistName)
const
647 "The \"" << paramName <<
"\"" <<
648 " parameter in the \"" << sublistName <<
649 "\" sublist is has an error." << std::endl << std::endl <<
650 "Error: The value that you entered was the wrong type." <<
651 "Parameter: " << paramName << std::endl <<
652 "Type specified: " << entryName << std::endl <<
657 it = std::find(validStrings_->begin(),
658 validStrings_->end(), getValue<std::string>(entry));
661 "The \"" << paramName <<
"\"" <<
662 " parameter in the \"" << sublistName <<
663 "\" sublist is has an error." << std::endl << std::endl <<
664 "Error: The value that was entered doesn't fall with in "
665 "the range set by the validator." <<
666 "Parameter: " << paramName << std::endl <<
667 "Acceptable Values: " << *validStrings_ << std::endl <<
668 "Value entered: " << getValue<std::string>(entry) << std::endl <<
676 return "StringValidator";
681 std::ostream &out)
const
684 out <<
"# Validator Used: " << std::endl;
685 out <<
"# String Validator" << std::endl;
686 if (validStrings_.
get() && validStrings_->size()){
687 out <<
"# Acceptable Values: " << *validStrings_ << std::endl;
703 Teuchos::boolParameterEntryValidator()
705 return rcp(
new BoolParameterEntryValidator());
709 Teuchos::anyNumberParameterEntryValidator()
711 return rcp(
new AnyNumberParameterEntryValidator());
716 Teuchos::anyNumberParameterEntryValidator(
717 AnyNumberParameterEntryValidator::EPreferredType
const preferredType,
718 AnyNumberParameterEntryValidator::AcceptedTypes
const& acceptedTypes
722 new AnyNumberParameterEntryValidator(
723 preferredType, acceptedTypes
728 void Teuchos::setIntParameter(
729 std::string
const& paramName,
730 int const value, std::string
const& docString,
731 ParameterList *paramList,
732 AnyNumberParameterEntryValidator::AcceptedTypes
const& acceptedTypes
736 const RCP<const ParameterEntryValidator> paramEntryValidator =
738 AnyNumberParameterEntryValidator::PREFER_INT, acceptedTypes
740 paramList->set(paramName, value, docString, paramEntryValidator);
744 void Teuchos::setLongLongParameter(
745 std::string
const& paramName,
746 long long const value, std::string
const& docString,
747 ParameterList *paramList,
748 AnyNumberParameterEntryValidator::AcceptedTypes
const& acceptedTypes
752 const RCP<const ParameterEntryValidator> paramEntryValidator =
754 AnyNumberParameterEntryValidator::PREFER_LONG_LONG, acceptedTypes
756 paramList->set(paramName, value, docString, paramEntryValidator);
760 void Teuchos::setDoubleParameter(
761 std::string
const& paramName,
762 double const& value, std::string
const& docString,
763 ParameterList *paramList,
764 AnyNumberParameterEntryValidator::AcceptedTypes
const& acceptedTypes
768 const RCP<const ParameterEntryValidator> paramEntryValidator =
770 AnyNumberParameterEntryValidator::PREFER_DOUBLE, acceptedTypes
772 paramList->set(paramName, value, docString, paramEntryValidator);
776 void Teuchos::setNumericStringParameter(
777 std::string
const& paramName,
778 std::string
const& value, std::string
const& docString,
779 ParameterList *paramList,
780 AnyNumberParameterEntryValidator::AcceptedTypes
const& acceptedTypes
784 const RCP<const ParameterEntryValidator> paramEntryValidator =
786 AnyNumberParameterEntryValidator::PREFER_STRING, acceptedTypes
788 paramList->set(paramName, value, docString, paramEntryValidator);
792 int Teuchos::getIntParameter(
793 ParameterList
const& paramList,
794 std::string
const& paramName
797 const ParameterEntry &entry = paramList.getEntry(paramName);
798 RCP<const AnyNumberParameterEntryValidator>
802 if ( !
is_null(anyNumValidator) )
803 return anyNumValidator->getInt(entry,paramName,paramList.name());
804 if (
typeid(
int) == entry.getAny().type() )
805 return any_cast<int>(entry.getAny());
807 const AnyNumberParameterEntryValidator myAnyNumValidator;
808 return myAnyNumValidator.getInt(entry,paramName,paramList.name());
812 long long Teuchos::getLongLongParameter(
813 ParameterList
const& paramList,
814 std::string
const& paramName
817 const ParameterEntry &entry = paramList.getEntry(paramName);
818 RCP<const AnyNumberParameterEntryValidator>
822 if ( !
is_null(anyNumValidator) )
823 return anyNumValidator->getLongLong(entry,paramName,paramList.name());
824 if (
typeid(
long long) == entry.getAny().type() )
825 return any_cast<long long>(entry.getAny());
827 const AnyNumberParameterEntryValidator myAnyNumValidator;
828 return myAnyNumValidator.getLongLong(entry,paramName,paramList.name());
832 double Teuchos::getDoubleParameter(
833 ParameterList
const& paramList,
834 std::string
const& paramName
837 const ParameterEntry &entry = paramList.getEntry(paramName);
838 RCP<const AnyNumberParameterEntryValidator>
842 if ( !
is_null(anyNumValidator) )
843 return anyNumValidator->getDouble(entry,paramName,paramList.name());
844 if (
typeid(
double) == entry.getAny().type() )
845 return any_cast<double>(entry.getAny());
847 const AnyNumberParameterEntryValidator myAnyNumValidator;
848 return myAnyNumValidator.getDouble(entry,paramName,paramList.name());
852 std::string Teuchos::getNumericStringParameter(
853 ParameterList
const& paramList,
854 std::string
const& paramName
857 const ParameterEntry &entry = paramList.getEntry(paramName);
858 RCP<const AnyNumberParameterEntryValidator>
862 if ( !
is_null(anyNumValidator) )
863 return anyNumValidator->getString(entry,paramName,paramList.name());
864 if (
typeid(std::string) == entry.getAny().type() )
865 return any_cast<std::string>(entry.getAny());
867 const AnyNumberParameterEntryValidator myAnyNumValidator;
868 return myAnyNumValidator.getString(entry,paramName,paramList.name());
ValidStringsList setValidStrings(const Teuchos::Array< std::string > &validStrings)
Sets the Array of valid strings and returns what the current array of valid string now is...
RCP< T > rcp(const boost::shared_ptr< T > &sptr)
Conversion function that takes in a boost::shared_ptr object and spits out a Teuchos::RCP object...
void printDoc(std::string const &docString, std::ostream &out) const
const std::string & name() const
The name of this ParameterList.
ValidStringsList validStringValues() const
ValidStringsList validStringValues() const
void validate(ParameterEntry const &entry, std::string const ¶mName, std::string const &sublistName) const
Generate output as defined by the object.
static RCP< T > getDummyObject()
Retrieves a dummy object of type T.
bool setFileMustExist(bool shouldFileExist)
Sets whether or not the validator requires the file to already exist.
ValidStringsList validStringValues() const
void setValue(T value, bool isDefault=false, const std::string &docString="", RCP< const ParameterEntryValidator > const &validator=null)
Templated set method that uses the input value type to determine the type of parameter.
FileNameValidator(bool mustAlreadyExist=mustAlreadyExistDefault())
Constructs a FileNameValidator.
Generate only a minimal amount of output.
RCP< T2 > rcp_dynamic_cast(const RCP< T1 > &p1, bool throw_on_fail=false)
Dynamic cast of underlying RCP type from T1* to T2*.
EPreferredType
Determines what type is the preferred type.
T & get(const std::string &name, T def_value)
Return the parameter's value, or the default value if it is not there.
This object is held as the "value" in the Teuchos::ParameterList std::map.
void validateAndModify(std::string const ¶mName, std::string const &sublistName, ParameterEntry *entry) const
void printDoc(std::string const &docString, std::ostream &out) const
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
const std::string getXMLTypeName() const
bool fileEmptyNameOK() const
Gets the variable describing whether or not this validator is OK with file name being empty (even if ...
Generate the most output possible.
Standard implementation of a ParameterEntryValidator that maps from a list of strings to an enum or i...
AcceptedTypes & allowString(bool _allowString)
Set allow an std::string value or not.
std::string getString(const ParameterEntry &entry, const std::string ¶mName="", const std::string &sublistName="", const bool activeQuery=true) const
Get a std::string value from a parameter entry.
T * get() const
Get the raw C++ pointer to the underlying object.
static std::ostream & printLines(std::ostream &os, const std::string &linePrefix, const std::string &lines)
Print lines with prefix first.
EVerbosityLevel
Verbosity level.
Modified boost::any class, which is a container for a templated value.
void validate(ParameterEntry const &entry, std::string const ¶mName, std::string const &sublistName) const
bool is_null(const ArrayRCP< T > &p)
Returns true if p.get()==NULL.
AcceptedTypes & allowInt(bool _allowInt)
Set allow an int value or not.
static std::string toString(const double &x)
Write a double as a std::string.
ValidStringsList validStringValues() const
ParameterEntry * getEntryPtr(const std::string &name)
Retrieves the pointer for an entry with the name name if it exists.
Determines the types that are accepted.
EPreferredType getPreferredType() const
Lookup the preferred type.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Deprecated.
Generate a high level of output.
double getDouble(const ParameterEntry &entry, const std::string ¶mName="", const std::string &sublistName="", const bool activeQuery=true) const
Get a double value from a parameter entry. will call std::stod.
void validate(ParameterEntry const &entry, std::string const ¶mName, std::string const &sublistName) const
long long getLongLong(const ParameterEntry &entry, const std::string ¶mName="", const std::string &sublistName="", const bool activeQuery=true) const
Get a long long value from a parameter entry. will call std::stoll Note that std::stoll throws on bad...
bool setFileEmptyNameOK(bool isEmptyNameOK)
Sets whether or not the validator is OK with empty file name (even if fileMustExist() returns true) ...
Validate a file name entry.
const std::string getXMLTypeName() const
A list of parameters of arbitrary type.
StringValidator()
Constructs a StringValidator.
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< AnyNumberParameterEntryValidator > anyNumberParameterEntryValidator()
Nonmember constructor AnyNumberParameterEntryValidator.
AnyNumberParameterEntryValidator()
Construct with a preferrded type of double and accept all types.
A simple validator that only allows certain string values to be choosen or simply enforces that a par...
bool getBool(const ParameterEntry &entry, const std::string ¶mName="", const std::string &sublistName="", const bool activeQuery=true) const
Get bool value from a parameter entry.
Abstract interface for an object that can validate a ParameterEntry's value.
any & getAny(bool activeQry=true)
Direct access to the Teuchos::any data value underlying this object. The bool argument activeQry (def...
int getInt(const ParameterEntry &entry, const std::string ¶mName="", const std::string &sublistName="", const bool activeQuery=true) const
Get an integer value from a parameter entry. will call std::stoi Note that std::stoi throws on badly ...
void validate(ParameterEntry const &entry, std::string const ¶mName, std::string const &sublistName) const
bool isDoubleAllowed() const
Lookup whether or not doubles are allowed.
void printDoc(std::string const &docString, std::ostream &out) const
std::string typeName() const
Return the name of the type.
AcceptedTypes & allowDouble(bool _allowDouble)
Set allow a double value or not.
bool isLongLongAllowed() const
Lookup whether or not long longs are allowed.
Smart reference counting pointer class for automatic garbage collection.
bool fileMustExist() const
Gets the variable describing whether or not this validator wants the file that is specified to alread...
const std::type_info & type() const
Return the type of value being stored.
void validateAndModify(std::string const ¶mName, std::string const &sublistName, ParameterEntry *entry) const
bool isStringAllowed() const
Lookup whether or not strings are allowed.
void printDoc(std::string const &docString, std::ostream &out) const
bool isIntAllowed() const
Lookup whether or not ints are allowed.
AcceptedTypes & allowLongLong(bool _allowLongLong)
Set allow an long long value or not.
const std::string getXMLTypeName() const
Definition of Teuchos::as, for conversions between types.
const std::string getXMLTypeName() const
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)
This macro is designed to be a short version of TEUCHOS_TEST_FOR_EXCEPTION() that is easier to call...
static std::string name()
#define TEUCHOS_TEST_FOR_EXCEPTION_PURE_MSG(throw_exception_test, Exception, msg)
Macro for throwing an exception with breakpointing to ease debugging.
bool is_null() const
Returns true if the underlying pointer is null.