OhmmsParameter.h File Reference

Include dependency graph for OhmmsParameter.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	OhmmsParameter< T >
class	OhmmsParameter< bool >
	A specialization of OhmmsParameter<T> for T = boolean. More...

Enumerations
enum	TagStatus {   OPTIONAL, REQUIRED, DEPRECATED, DELETED,   UNSUPPORTED }
	generic class for parameter xmlNode More...

Functions
void	checkTagStatus (const std::string &tagname, TagStatus status)

Enumeration Type Documentation

TagStatus

enum TagStatus

strong

generic class for parameter xmlNode

<parameter> node is used to generically add a named parameter whose value is the content of an xmlNode. The definition confirms docbook::parameter Usage is: <parameter name="aname" > value </parameter>
Example is: <parameter name="temperature" > 200 </parameter>

• name is the name of the parameter.
• value is the content of the parameter of type T.

Two kinds of template parameter T are valid:
• intrinsic C/C variables, such as int,double
• Ohmms basic data types in OhmmsPETE, such as TinyVector<T,D> and Tensor<T,D>

Using other types are valid, as far as the operators << and >> can handle the xmlChar*.

Enumerator
OPTIONAL
REQUIRED
DEPRECATED
DELETED
UNSUPPORTED

Definition at line 48 of file OhmmsParameter.h.

{
  OPTIONAL,   // there is a default value
  REQUIRED,   // no default value, input required.
  DEPRECATED, // deprecated input tag. Input becomes optional
  DELETED,    // deleted input tag. Hard stop if detected.
  UNSUPPORTED // not supported input tags due to incompatible changes. Hard stop if detected.
};

Function Documentation

checkTagStatus()

void checkTagStatus ( const std::string &  tagname, TagStatus  status  )

inline

Definition at line 57 of file OhmmsParameter.h.

References qmcplusplus::app_warning(), DELETED, DEPRECATED, and UNSUPPORTED.

Referenced by OhmmsParameter< T >::put(), and OhmmsParameter< bool >::put().

{
  if (status == TagStatus::DELETED)
  {
    std::ostringstream msg;
    msg << "Input tag \"" << tagname << "\" has been deleted. Please remove it from the input file!" << std::endl;
    throw std::runtime_error(msg.str());
  }
  else if (status == TagStatus::UNSUPPORTED)
  {
    std::ostringstream msg;
    msg << "Input tag \"" << tagname << "\" is not supported. Please remove it from the input file!" << std::endl;
    throw std::runtime_error(msg.str());
  }
  else if (status == TagStatus::DEPRECATED)
    qmcplusplus::app_warning() << "Input tag \"" << tagname
                               << "\" has been deprecated and will be deleted in the next release!" << std::endl;
}