ttg::InTerminalBase< keyT > Class Template Reference

Base type for input terminals receiving messages annotated by task IDs of type keyT More...

#include <terminal.h>

Inheritance diagram for ttg::InTerminalBase< keyT >:

Collaboration diagram for ttg::InTerminalBase< keyT >:

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.
size_t	get_index () const
	Returns index of terminal.
const std::string &	get_name () const
	Returns name of terminal.
const std::string &	get_key_type_str () const
	Returns string representation of key type.
const std::string &	get_value_type_str () const
	Returns string representation of value type.
Type	get_type () const
	Returns the terminal type.
const std::vector< TerminalBase * > &	get_connections () const
	Get connections to successors.
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.
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

Detailed Description

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 83 of file terminal.h.

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 89 of file terminal.h.

key_type

template<typename keyT = void>

typedef keyT ttg::InTerminalBase< keyT >::key_type

Definition at line 85 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 88 of file terminal.h.

Constructor & Destructor Documentation

InTerminalBase()

template<typename keyT = void>

ttg::InTerminalBase< keyT >::InTerminalBase ( TerminalBase::Type  t )

inlineprotected

Definition at line 93 of file terminal.h.

Member Function Documentation

finalize() [1/2]

template<typename keyT = void>

template<typename Key = keyT>

std::enable_if_t< meta::is_void_v< Key >, void > ttg::InTerminalBase< keyT >::finalize ( )

inline

Definition at line 132 of file terminal.h.

finalize() [2/2]

template<typename keyT = void>

template<typename Key = keyT>

std::enable_if_t<!meta::is_void_v< Key >, void > ttg::InTerminalBase< keyT >::finalize ( const Key &  key )

inline

Definition at line 125 of file terminal.h.

set_callback()

template<typename keyT = void>

void ttg::InTerminalBase< keyT >::set_callback ( const setsize_callback_type &  setsize_callback = setsize_callback_type{}, const finalize_callback_type &  finalize_callback = finalize_callback_type{}  )

inlineprotected

Definition at line 98 of file terminal.h.

set_size() [1/2]

template<typename keyT = void>

template<typename Key = keyT>

std::enable_if_t<!meta::is_void_v< Key >, void > ttg::InTerminalBase< keyT >::set_size ( const Key &  key, std::size_t  size  )

inline

Definition at line 113 of file terminal.h.

Here is the call graph for this function:

set_size() [2/2]

template<typename keyT = void>

template<typename Key = keyT>

std::enable_if_t< meta::is_void_v< Key >, void > ttg::InTerminalBase< keyT >::set_size ( std::size_t  size )

inline

Definition at line 119 of file terminal.h.

Here is the call graph for this function:

Member Data Documentation

finalize_callback

template<typename keyT = void>

finalize_callback_type ttg::InTerminalBase< keyT >::finalize_callback

protected

Definition at line 96 of file terminal.h.

is_an_input_terminal

template<typename keyT = void>

constexpr bool ttg::InTerminalBase< keyT >::is_an_input_terminal = true

staticconstexpr

Definition at line 90 of file terminal.h.

setsize_callback

template<typename keyT = void>

setsize_callback_type ttg::InTerminalBase< keyT >::setsize_callback

protected

Definition at line 95 of file terminal.h.

---

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

• ttg/ttg/terminal.h