Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Public Member Functions | Private Attributes | Related Functions
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.
anyswap (any &rhs)
 Method for swapping the contents of two any classes.
template<typename ValueType >
anyoperator= (const ValueType &rhs)
 Copy the value rhs
anyoperator= (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

Private Attributes

placeholder * content

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.

Definition at line 73 of file Teuchos_any.hpp.


Constructor & Destructor Documentation

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

Empty constructor.

Definition at line 77 of file Teuchos_any.hpp.

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

Templated constructor.

Definition at line 83 of file Teuchos_any.hpp.

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

Copy constructor.

Definition at line 88 of file Teuchos_any.hpp.

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

Destructor.

Definition at line 93 of file Teuchos_any.hpp.


Member Function Documentation

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

Method for swapping the contents of two any classes.

Definition at line 99 of file Teuchos_any.hpp.

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

Copy the value rhs

Definition at line 107 of file Teuchos_any.hpp.

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

Copy the value held in rhs

Definition at line 114 of file Teuchos_any.hpp.

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

Return true if nothing is being stored.

Definition at line 121 of file Teuchos_any.hpp.

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

Return the type of value being stored.

Definition at line 127 of file Teuchos_any.hpp.

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

Return the name of the type.

Definition at line 133 of file Teuchos_any.hpp.

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

Return if two any objects are the same or not.

Definition at line 139 of file Teuchos_any.hpp.

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

Print this value to the output stream os

Definition at line 152 of file Teuchos_any.hpp.


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.

Definition at line 252 of file Teuchos_any.hpp.

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.

Definition at line 288 of file Teuchos_any.hpp.

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

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

Definition at line 296 of file Teuchos_any.hpp.

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

Returns true if two any objects have the same value.

Definition at line 306 of file Teuchos_any.hpp.

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

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

Definition at line 314 of file Teuchos_any.hpp.

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

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

Definition at line 322 of file Teuchos_any.hpp.


Member Data Documentation

placeholder* Teuchos::any::content [private]

Definition at line 230 of file Teuchos_any.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines