Reference documentation for deal.II version Git 4a2ac69 2017-09-19 13:41:17 -0400
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
AnyData Class Reference

#include <deal.II/algorithms/any_data.h>

Inheritance diagram for AnyData:
[legend]

Public Member Functions

 AnyData ()=default
 Default constructor for empty object.
 
unsigned int size () const
 Number of stored data objects.
 
template<typename type >
void add (type entry, const std::string &name)
 Add a new data object.
 
void merge (const AnyData &other)
 Merge the data of another AnyData to the end of this object.
 
template<typename type >
type entry (const std::string &name)
 Access to stored data object by name. More...
 
template<typename type >
const type entry (const std::string &name) const
 Read-only access to stored data object by name. More...
 
template<typename type >
const type read (const std::string &name) const
 Dedicated read only access by name. More...
 
template<typename type >
const type * read_ptr (const std::string &name) const
 Dedicated read only access by name for pointer data. More...
 
template<typename type >
const type * try_read_ptr (const std::string &name) const
 
template<typename type >
const type * try_read (const std::string &name) const
 Dedicated read only access by name without exceptions. More...
 
template<typename type >
type entry (const unsigned int i)
 
template<typename type >
const type entry (const unsigned int i) const
 Read-only access to stored data object by index.
 
template<typename type >
const type read (const unsigned int i) const
 Dedicated read only access.
 
template<typename type >
const type * read_ptr (const unsigned int i) const
 Dedicated read only access to pointer object.
 
template<typename type >
const type * try_read_ptr (const unsigned int i) const
 Dedicated read only access to pointer object without exception.
 
template<typename type >
const type * try_read (const unsigned int i) const
 Dedicated read only access without exception.
 
const std::string & name (const unsigned int i) const
 Name of object at index.
 
unsigned int find (const std::string &name) const
 Find index of a named object. More...
 
unsigned int try_find (const std::string &name) const
 Try to find index of a named object. More...
 
template<typename type >
bool is_type (const unsigned int i) const
 Find out if object is of a certain type.
 
template<class StreamType >
void list (StreamType &os) const
 List the contents to a stream.
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&)
 
void subscribe (const char *identifier=nullptr) const
 
void unsubscribe (const char *identifier=nullptr) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Static Public Member Functions

static::ExceptionBase & ExcNameNotFound (std::string arg1)
 An entry with this name does not exist in the AnyData object. More...
 
static::ExceptionBase & ExcTypeMismatch (char *arg1, char *arg2)
 The requested type and the stored type are different. More...
 
static::ExceptionBase & ExcNameMismatch (int arg1, std::string arg2)
 
- Static Public Member Functions inherited from Subscriptor
static::ExceptionBase & ExcInUse (int arg1, char *arg2, std::string &arg3)
 
static::ExceptionBase & ExcNoSubscriber (char *arg1, char *arg2)
 

Private Attributes

std::vector< boost::any > data
 The stored data.
 
std::vector< std::string > names
 The names of the stored data.
 

Detailed Description

Store any amount of any type of data accessible by an identifier string.

Todo:
GK: Deprecate access to AnyData by index and change to a map.

Definition at line 35 of file any_data.h.

Member Function Documentation

template<typename type >
type AnyData::entry ( const std::string &  name)
inline

Access to stored data object by name.

Find the object with given name, try to convert it to type and return it. This function throws an exception if either the name does not exist or if the conversion fails. If such an exception is not desired, use try_read() instead.

Definition at line 338 of file any_data.h.

template<typename type >
const type AnyData::entry ( const std::string &  name) const
inline

Read-only access to stored data object by name.

Find the object with given name, try to convert it to type and return it. This function throws an exception if either the name does not exist or if the conversion fails. If such an exception is not desired, use try_read() instead.

Definition at line 351 of file any_data.h.

template<typename type >
const type AnyData::read ( const std::string &  name) const
inline

Dedicated read only access by name.

For a constant object, this function equals entry(). For a non-const object, it forces read only access to the data. In particular, it throws an exception if the object is not found or cannot be converted to type. If such an exception is not desired, use try_read() instead.

Warning
Do not use this function for stored objects which are pointers. Use read_ptr() instead!

Definition at line 364 of file any_data.h.

template<typename type >
const type * AnyData::read_ptr ( const std::string &  name) const
inline

Dedicated read only access by name for pointer data.

If the stored data object is a pointer to a constant object, the logic of access becomes fairly complicated. Namely, the standard read function may fail, depending on whether it was a const pointer or a regular pointer. This function fixes the logic and ascertains that the object does not become mutable by accident.

Definition at line 377 of file any_data.h.

template<typename type >
const type * AnyData::try_read_ptr ( const std::string &  name) const
inline

Perform the same action as read_ptr(), but do not throw an exception if the pointer does not exist. Return a null pointer instead.

Definition at line 392 of file any_data.h.

template<typename type >
const type * AnyData::try_read ( const std::string &  name) const
inline

Dedicated read only access by name without exceptions.

This function tries to find the name in the list and return a pointer to the associated object. If either the name is not found or the object cannot be converted to the return type, a null pointer is returned.

Definition at line 408 of file any_data.h.

template<typename type >
type AnyData::entry ( const unsigned int  i)
inline

Access to stored data object by index.

Definition at line 209 of file any_data.h.

unsigned int AnyData::find ( const std::string &  name) const
inline

Find index of a named object.

Try to find the object and return its index in the list. Throw an exception if the object has not been found.

Definition at line 317 of file any_data.h.

unsigned int AnyData::try_find ( const std::string &  name) const
inline

Try to find index of a named object.

Try to find the object and return its index in the list. returns numbers::invalid_unsigned_int if the name was not found.

Definition at line 303 of file any_data.h.


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