Public Member Functions | Private Types | Private Attributes

internal::TableEntry Struct Reference

List of all members.

Public Member Functions

 TableEntry ()
template<typename T >
 TableEntry (const T &t)
template<typename T >
get () const
double get_numeric_value () const
TableEntry get_default_constructed_copy () const
template<class Archive >
void save (Archive &ar, const unsigned int version) const
template<class Archive >
void load (Archive &ar, const unsigned int version)

Private Types

typedef boost::variant< int,
unsigned int, double,
std::string > 
value_type

Private Attributes

value_type value

Detailed Description

A TableEntry stores the value of a table entry. It can either be of type int, unsigned int, double or std::string. In essence, this structure is the same as boost::variant<int,unsigned int,double,std::string> but we wrap this object in a structure for which we can write a function that can serialize it. This is also why the function is not in fact of type boost::any.

Definition at line 54 of file table_handler.h.


Member Typedef Documentation

typedef boost::variant<int,unsigned int,double,std::string> internal::TableEntry::value_type [private]

Abbreviation for the data type stored by this object.

Definition at line 115 of file table_handler.h.


Constructor & Destructor Documentation

internal::TableEntry::TableEntry ( )

Default constructor.

template<typename T >
internal::TableEntry::TableEntry ( const T &  t)

Constructor. Initialize this table element with the value t.

Definition at line 713 of file table_handler.h.


Member Function Documentation

template<typename T >
T internal::TableEntry::get ( ) const

Return the value stored by this object. The template type T must be one of int,unsigned int,double,std::string and it must match the data type of the object originally stored in this TableEntry object.

Definition at line 720 of file table_handler.h.

References Assert, StandardExceptions::ExcMessage(), and value.

double internal::TableEntry::get_numeric_value ( ) const

Return the numeric value of this object if data has been stored in it either as an integer, an unsigned integer, or a double.

Returns:
double
TableEntry internal::TableEntry::get_default_constructed_copy ( ) const

Return a TableEntry object that has the same data type of the stored value but with a value that is default constructed for this data type. This is used to pad columns below previously set ones.

template<class Archive >
void internal::TableEntry::save ( Archive &  ar,
const unsigned int  version 
) const

Write the data of this object to a stream for the purpose of serialization.

Definition at line 742 of file table_handler.h.

References Assert, StandardExceptions::ExcInternalError(), and value.

template<class Archive >
void internal::TableEntry::load ( Archive &  ar,
const unsigned int  version 
)

Read the data of this object from a stream for the purpose of serialization.

Definition at line 775 of file table_handler.h.

References Assert, StandardExceptions::ExcInternalError(), and value.


Member Data Documentation

Stored value.

Definition at line 120 of file table_handler.h.

Referenced by get(), load(), and save().


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

deal.II documentation generated on Wed May 23 2012 12:04:18 by doxygen 1.7.3