Teuchos::any Class Reference

Modified boost::any class, which is a container for a templated value. More...

#include <Teuchos_any.hpp>

List of all members.

Public Member Functions
	any ()
	Empty constructor.
template<typename ValueType>
	any (const ValueType &value)
	Templated constructor.
	any (const any &other)
	Copy constructor.
	~any ()
	Destructor.
any &	swap (any &rhs)
	Method for swapping the contents of two any classes.
template<typename ValueType>
any &	operator= (const ValueType &rhs)
	Copy the value rhs.
any &	operator= (const any &rhs)
	Copy the value held in rhs.
bool	empty () const
	Return true if nothing is being stored.
const std::type_info &	type () const
	Return the type of value being stored.
std::string	typeName () const
	Return the name of the type.
bool	same (const any &other) const
	Return if two any objects are the same or not.
void	print (std::ostream &os) const
	Print this value to the output stream os.
Related Functions
(Note that these are not member functions.)
template<typename ValueType>
ValueType &	any_cast (any &operand)
	Used to extract the templated value held in Teuchos::any to a given value type.
template<typename ValueType>
const ValueType &	any_cast (const any &operand)
	Used to extract the const templated value held in Teuchos::any to a given const value type.
std::string	toString (const any &rhs)
	Converts the value in any to a std::string.
bool	operator== (const any &a, const any &b)
	Returns true if two any objects have the same value.
bool	operator!= (const any &a, const any &b)
	Returns true if two any objects do not have the same value.
std::ostream &	operator<< (std::ostream &os, const any &rhs)
	Writes "any" input rhs to the output stream os.

---

Detailed Description

Modified boost::any class, which is a container for a templated value.

---

Constructor & Destructor Documentation

Teuchos::any::any (   )  [inline]

Empty constructor.

template<typename ValueType> Teuchos::any::any (  const ValueType &  value  )  [inline, explicit]

Templated constructor.

Teuchos::any::any (  const any &  other  )  [inline]

Copy constructor.

Teuchos::any::~any (   )  [inline]

Destructor.

---

Member Function Documentation

any& Teuchos::any::swap (  any &  rhs  )  [inline]

Method for swapping the contents of two any classes.

template<typename ValueType> any& Teuchos::any::operator= (  const ValueType &  rhs  )  [inline]

Copy the value rhs.

any& Teuchos::any::operator= (  const any &  rhs  )  [inline]

Copy the value held in rhs.

bool Teuchos::any::empty (   )  const [inline]

Return true if nothing is being stored.

const std::type_info& Teuchos::any::type (   )  const [inline]

Return the type of value being stored.

std::string Teuchos::any::typeName (   )  const [inline]

Return the name of the type.

bool Teuchos::any::same (  const any &  other  )  const [inline]

Return if two any objects are the same or not.

void Teuchos::any::print (  std::ostream &  os  )  const [inline]

Print this value to the output stream os.

---

Friends And Related Function Documentation

template<typename ValueType> ValueType & any_cast (  any &  operand  )  [related]

Used to extract the templated value held in Teuchos::any to a given value type. Note: If the templated value type and templated type are not the same then a bad_any_cast is thrown. If the dynamic cast fails, then a Teuchos::bad_any_cast std::exception is thrown.

template<typename ValueType> const ValueType & any_cast (  const any &  operand  )  [related]

Used to extract the const templated value held in Teuchos::any to a given const value type. Note: If the templated value type and templated type are not the same then a bad_any_cast is thrown. If the dynamic cast fails, then a logic_error is thrown.

std::string toString (  const any &  rhs  )  [related]

Converts the value in any to a std::string.

bool operator== (  const any &  a, const any &  b )  [related]

Returns true if two any objects have the same value.

bool operator!= (  const any &  a, const any &  b )  [related]

Returns true if two any objects do not have the same value.

std::ostream & operator<< (  std::ostream &  os, const any &  rhs )  [related]

Writes "any" input rhs to the output stream os.

---

The documentation for this class was generated from the following file:

• Teuchos_any.hpp

---