ttg::OutTerminalBase< keyT > Class Template Reference
Inheritance diagram for ttg::OutTerminalBase< keyT >:
Documentation
template<typename keyT = void>
class ttg::OutTerminalBase< keyT >
A base type for output terminals that send messages annotated by task IDs of type KeyT
- Template Parameters
-
<keyT> a task ID type (can be void
)
Definition at line 373 of file terminal.h.
Public Types | |
using | key_type = keyT |
Public Types inherited from ttg::TerminalBase | |
enum class | Type { Write , Read , Consume } |
describes the terminal type More... | |
Public Member Functions | |
OutTerminalBase () | |
auto | nsuccessors () const |
const auto & | successors () const |
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_output_terminal = true |
Static Public Attributes inherited from ttg::TerminalBase | |
static constexpr bool | is_a_terminal = true |
Additional Inherited Members | |
Public Attributes inherited from ttg::TerminalBase | |
bool | is_pull_terminal = false |
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) |
Member Typedef Documentation
◆ key_type
template<typename keyT = void>
using ttg::OutTerminalBase< keyT >::key_type = keyT |
Definition at line 375 of file terminal.h.
Constructor & Destructor Documentation
◆ OutTerminalBase()
template<typename keyT = void>
|
inline |
Definition at line 387 of file terminal.h.
Member Function Documentation
◆ finalize() [1/2]
template<typename keyT = void>
template<typename Key = keyT>
|
inline |
Definition at line 417 of file terminal.h.
◆ finalize() [2/2]
template<typename keyT = void>
template<typename Key = keyT>
|
inline |
Definition at line 409 of file terminal.h.
◆ nsuccessors()
template<typename keyT = void>
|
inline |
Definition at line 389 of file terminal.h.
◆ set_size() [1/2]
template<typename keyT = void>
template<typename Key = keyT>
|
inline |
Definition at line 393 of file terminal.h.
◆ set_size() [2/2]
template<typename keyT = void>
template<typename Key = keyT>
|
inline |
Definition at line 401 of file terminal.h.
◆ successors()
template<typename keyT = void>
|
inline |
Definition at line 390 of file terminal.h.
Member Data Documentation
◆ is_an_output_terminal
template<typename keyT = void>
|
staticconstexpr |
Definition at line 377 of file terminal.h.
The documentation for this class was generated from the following file:
- ttg/ttg/terminal.h