Dune Core Modules (2.8.0)
Dune::Future< T > Class Template Reference
Type-erasure for future-like objects. A future-like object is a object satisfying the interface of FutureBase. More...
#include <dune/common/parallel/future.hh>
Public Member Functions | |
void | wait () |
wait until the future is ready More... | |
T | get () |
Waits until the future is ready and returns the resulting value. More... | |
bool | ready () const |
bool | valid () const |
Checks whether the future is valid. I.e. ‘get()’ was not called on that future and when it was not default-constructed and not moved from. More... | |
Detailed Description
template<class T>
class Dune::Future< T >
class Dune::Future< T >
Type-erasure for future-like objects. A future-like object is a object satisfying the interface of FutureBase.
Member Function Documentation
◆ get()
template<class T >
|
inline |
Waits until the future is ready and returns the resulting value.
- Returns
- The contained value
- Exceptions
-
InvalidFutureException
◆ ready()
template<class T >
|
inline |
- Returns
- true is the future is ready, otherwise false
- Exceptions
-
InvalidFutureException
◆ valid()
template<class T >
|
inline |
Checks whether the future is valid. I.e. ‘get()’ was not called on that future and when it was not default-constructed and not moved from.
- Returns
- true is the future is valid, otherwise false
◆ wait()
template<class T >
|
inline |
wait until the future is ready
- Exceptions
-
InvalidFutureException
The documentation for this class was generated from the following file:
- dune/common/parallel/future.hh
|
Legal Statements / Impressum |
Hosted by TU Dresden |
generated with Hugo v0.111.3
(Nov 12, 23:30, 2024)