List of all members |
Public Types |
Public Member Functions |
Static Public Attributes |
Protected Member Functions |
Protected Attributes
ttg::InTerminalBase< keyT > Class Template Reference
Inheritance diagram for ttg::InTerminalBase< keyT >:
Documentation
template<typename keyT = void>
class ttg::InTerminalBase< keyT >
Base type for input terminals receiving messages annotated by task IDs of type keyT
- Template Parameters
-
<keyT> a task ID type (can be void)
Definition at line 82 of file terminal.h.
Public Types | |
| typedef keyT | key_type |
| using | setsize_callback_type = meta::detail::setsize_callback_t< keyT > |
| using | finalize_callback_type = meta::detail::finalize_callback_t< keyT > |
 Public Types inherited from ttg::TerminalBase | |
| enum class | Type { Write , Read , Consume } |
| describes the terminal type More... | |
Public Member Functions | |
| template<typename Key = keyT> | |
| std::enable_if_t<!meta::is_void_v< Key >, void > | set_size (const Key &key, std::size_t size) |
| template<typename Key = keyT> | |
| std::enable_if_t< meta::is_void_v< Key >, void > | set_size (std::size_t size) |
| template<typename Key = keyT> | |
| std::enable_if_t<!meta::is_void_v< Key >, void > | finalize (const Key &key) |
| template<typename Key = keyT> | |
| std::enable_if_t< meta::is_void_v< Key >, void > | finalize () |
| Public Member Functions inherited from ttg::TerminalBase | |
| TTBase * | get_tt () const |
| Return ptr to containing tt. More... | |
| size_t | get_index () const |
| Returns index of terminal. More... | |
| const std::string & | get_name () const |
| Returns name of terminal. More... | |
| const std::string & | get_key_type_str () const |
| Returns string representation of key type. More... | |
| const std::string & | get_value_type_str () const |
| Returns string representation of value type. More... | |
| Type | get_type () const |
| Returns the terminal type. More... | |
| const std::vector< TerminalBase * > & | get_connections () const |
| Get connections to successors. More... | |
| const std::vector< TerminalBase * > & | get_predecessors () const |
| void | connect_pull_nopred (TerminalBase *p) |
| bool | is_connected () const |
| Returns true if this terminal (input or output) is connected. More... | |
| virtual void | connect (TerminalBase *in)=0 |
| virtual | ~TerminalBase ()=default |
Static Public Attributes | |
| static constexpr bool | is_an_input_terminal = true |
| Static Public Attributes inherited from ttg::TerminalBase | |
| static constexpr bool | is_a_terminal = true |
Protected Member Functions | |
| InTerminalBase (TerminalBase::Type t) | |
| void | set_callback (const setsize_callback_type &setsize_callback=setsize_callback_type{}, const finalize_callback_type &finalize_callback=finalize_callback_type{}) |
| Protected Member Functions inherited from ttg::TerminalBase | |
| TerminalBase (Type type) | |
| void | set (TTBase *tt, size_t index, const std::string &name, const std::string &key_type_str, const std::string &value_type_str, Type type) |
| void | connect_base (TerminalBase *successor) |
| void | connect_pull (TerminalBase *predecessor) |
Protected Attributes | |
| setsize_callback_type | setsize_callback |
| finalize_callback_type | finalize_callback |
Additional Inherited Members | |
| Public Attributes inherited from ttg::TerminalBase | |
| bool | is_pull_terminal = false |
Member Typedef Documentation
◆ finalize_callback_type
template<typename keyT = void>
| using ttg::InTerminalBase< keyT >::finalize_callback_type = meta::detail::finalize_callback_t<keyT> |
Definition at line 88 of file terminal.h.
◆ key_type
template<typename keyT = void>
| typedef keyT ttg::InTerminalBase< keyT >::key_type |
Definition at line 84 of file terminal.h.
◆ setsize_callback_type
template<typename keyT = void>
| using ttg::InTerminalBase< keyT >::setsize_callback_type = meta::detail::setsize_callback_t<keyT> |
Definition at line 87 of file terminal.h.
Constructor & Destructor Documentation
◆ InTerminalBase()
template<typename keyT = void>
|
inlineprotected |
Definition at line 92 of file terminal.h.
Member Function Documentation
◆ finalize() [1/2]
template<typename keyT = void>
template<typename Key = keyT>
|
inline |
Definition at line 131 of file terminal.h.
◆ finalize() [2/2]
template<typename keyT = void>
template<typename Key = keyT>
|
inline |
Definition at line 124 of file terminal.h.
◆ set_callback()
template<typename keyT = void>
|
inlineprotected |
Definition at line 97 of file terminal.h.
◆ set_size() [1/2]
template<typename keyT = void>
template<typename Key = keyT>
|
inline |
Definition at line 112 of file terminal.h.
◆ set_size() [2/2]
template<typename keyT = void>
template<typename Key = keyT>
|
inline |
Definition at line 118 of file terminal.h.
Member Data Documentation
◆ finalize_callback
template<typename keyT = void>
|
protected |
Definition at line 95 of file terminal.h.
◆ is_an_input_terminal
template<typename keyT = void>
|
staticconstexpr |
Definition at line 89 of file terminal.h.
◆ setsize_callback
template<typename keyT = void>
|
protected |
Definition at line 94 of file terminal.h.
The documentation for this class was generated from the following file:
- ttg/ttg/terminal.h
