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

Inheritance diagram for AnyData:

Public Member Functions
	AnyData ()=default
	Default constructor for empty object. More...

unsigned int	size () const
	Number of stored data objects. More...

template<typename type >
void	add (type entry, const std::string &name)
	Add a new data object. More...

void	merge (const AnyData &other)
	Merge the data of another AnyData to the end of this object. More...

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. More...

template<typename type >
const type	read (const unsigned int i) const
	Dedicated read only access. More...

template<typename type >
const type *	read_ptr (const unsigned int i) const
	Dedicated read only access to pointer object. More...

template<typename type >
const type *	try_read_ptr (const unsigned int i) const
	Dedicated read only access to pointer object without exception. More...

template<typename type >
const type *	try_read (const unsigned int i) const
	Dedicated read only access without exception. More...

const std::string &	name (const unsigned int i) const
	Name of object at index. More...

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. More...

template<class StreamType >
void	list (StreamType &os) const
	List the contents to a stream. More...

Public Member Functions inherited from Subscriptor
	Subscriptor ()

	Subscriptor (const Subscriptor &)

	Subscriptor (Subscriptor &&) noexcept

virtual	~Subscriptor ()

Subscriptor &	operator= (const Subscriptor &)

Subscriptor &	operator= (Subscriptor &&) noexcept

void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

unsigned int	n_subscriptions () const

template<typename StreamType >
void	list_subscribers (StreamType &stream) 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 (std::string arg1, std::string 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, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Private Attributes
std::vector< boost::any >	data
	The stored data. More...

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

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 37 of file any_data.h.

Constructor & Destructor Documentation

◆ AnyData()

AnyData::AnyData ( )

default

Default constructor for empty object.

Member Function Documentation

◆ size()

unsigned int AnyData::size ( ) const

inline

Number of stored data objects.

Definition at line 223 of file any_data.h.

◆ add()

template<typename type >

void AnyData::add	(	type	entry,
		const std::string &	name
	)

inline

Add a new data object.

Definition at line 432 of file any_data.h.

◆ merge()

void AnyData::merge ( const AnyData & other )

inline

Merge the data of another AnyData to the end of this object.

Definition at line 441 of file any_data.h.

◆ entry() [1/4]

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 351 of file any_data.h.

◆ entry() [2/4]

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 362 of file any_data.h.

◆ read() [1/2]

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 374 of file any_data.h.

◆ read_ptr() [1/2]

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 385 of file any_data.h.

◆ try_read_ptr() [1/2]

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 399 of file any_data.h.

◆ try_read() [1/2]

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 414 of file any_data.h.

◆ entry() [3/4]

template<typename type >

type AnyData::entry ( const unsigned int i )

inline

Access to stored data object by index.

Definition at line 232 of file any_data.h.

◆ entry() [4/4]

template<typename type >

const type AnyData::entry ( const unsigned int i ) const

inline

Read-only access to stored data object by index.

Definition at line 244 of file any_data.h.

◆ read() [2/2]

template<typename type >

const type AnyData::read ( const unsigned int i ) const

inline

Dedicated read only access.

Definition at line 258 of file any_data.h.

◆ read_ptr() [2/2]

template<typename type >

const type * AnyData::read_ptr ( const unsigned int i ) const

inline

Dedicated read only access to pointer object.

Definition at line 272 of file any_data.h.

◆ try_read_ptr() [2/2]

template<typename type >

const type * AnyData::try_read_ptr ( const unsigned int i ) const

inline

Dedicated read only access to pointer object without exception.

Definition at line 286 of file any_data.h.

◆ try_read() [2/2]

template<typename type >

const type * AnyData::try_read ( const unsigned int i ) const

inline

Dedicated read only access without exception.

Definition at line 300 of file any_data.h.

◆ name()

const std::string & AnyData::name ( const unsigned int i ) const

inline

Name of object at index.

Definition at line 311 of file any_data.h.

◆ find()

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 332 of file any_data.h.

◆ try_find()

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 319 of file any_data.h.

◆ is_type()

template<typename type >

bool AnyData::is_type ( const unsigned int i ) const

inline

Find out if object is of a certain type.

Definition at line 343 of file any_data.h.

◆ list()

template<class StreamType >

void AnyData::list ( StreamType & os ) const

inline

List the contents to a stream.

Definition at line 453 of file any_data.h.

Member Data Documentation

◆ data

std::vector<boost::any> AnyData::data

private

The stored data.

Definition at line 217 of file any_data.h.

◆ names

std::vector<std::string> AnyData::names

private

The names of the stored data.

Definition at line 219 of file any_data.h.

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

include/deal.II/algorithms/any_data.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AnyData()

Member Function Documentation

◆ size()

◆ add()

◆ merge()

◆ entry() [1/4]

◆ entry() [2/4]

◆ read() [1/2]

◆ read_ptr() [1/2]

◆ try_read_ptr() [1/2]

◆ try_read() [1/2]

◆ entry() [3/4]

◆ entry() [4/4]

◆ read() [2/2]

◆ read_ptr() [2/2]

◆ try_read_ptr() [2/2]

◆ try_read() [2/2]

◆ name()

◆ find()

◆ try_find()

◆ is_type()

◆ list()

Member Data Documentation

◆ data

◆ names