- Aldebaran documentation |
- C++ Libraries |
- index

libqi-api 2.8.7.4

- Main Page
- Related Pages
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Friends | List of all members
qi::SrcFuture Struct Reference

`#include <future_fwd.hpp>`

## Public Types
using | retract_type = UnitFuture

## Public Member Functions
template<typename T >
auto | operator() (const Future< T > &x) const QI_NOEXCEPT_EXPR(*x) -> decltype(*x)

## Friends
UnitFuture | retract (SrcFuture)

## Detailed Description

Polymorphic function that gets (sources) the value of a `Future`.

This function has an inverse: `UnitFuture` (i.e. composing with it in any order will produce a function doing nothing).

See the concept `Isomorphism` in `concept.hpp` for a more formal explanation.

Definition at line 1153 of file future_fwd.hpp.

## Member Typedef Documentation

using qi::SrcFuture::retract_type = UnitFuture

Definition at line 1169 of file future_fwd.hpp.

## Member Function Documentation

template<typename T >

auto qi::SrcFuture::operator() | ( | const Future< T > & | x | ) | const -> decltype(*x)
| inline

Note: The return type will be `void*` if `T` is `void`... There is no constraint on T.

Definition at line 1162 of file future_fwd.hpp.

## Friends And Related Function Documentation

UnitFuture retract | ( | SrcFuture |  | ) |
| friend

Returns the retraction function, i.e. a function that undoes `SrcFuture`. As we model here the concept `Isomorphism`, it is also true that `SrcFuture` undoes `UnitFuture`.

See the `Isomorphism` concept definition for more information.

Definition at line 1176 of file future_fwd.hpp.

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

- /home/opennao/work/release-2.8/sdk/libqi/qi/detail/future_fwd.hpp