#include <fifo.hh>

Inheritance diagram for tlm::tlm_fifo< T >:

Public Member Functions
	tlm_fifo (int size_=1)

	tlm_fifo (const char *name_, int size_=1)

virtual	~tlm_fifo ()

T	get (tlm_tag< T > *=nullptr)

bool	nb_get (T &)

bool	nb_can_get (tlm_tag< T > *=nullptr) const

const sc_core::sc_event &	ok_to_get (tlm_tag< T > *=nullptr) const

T	peek (tlm_tag< T > *=nullptr) const

bool	nb_peek (T &) const

bool	nb_can_peek (tlm_tag< T > *=nullptr) const

const sc_core::sc_event &	ok_to_peek (tlm_tag< T > *=nullptr) const

void	put (const T &)

bool	nb_put (const T &)

bool	nb_can_put (tlm_tag< T > *=nullptr) const

const sc_core::sc_event &	ok_to_put (tlm_tag< T > *=nullptr) const

void	nb_expand (unsigned int n=1)

void	nb_unbound (unsigned int n=16)

bool	nb_reduce (unsigned int n=1)

bool	nb_bound (unsigned int n)

bool	nb_peek (T &, int n) const

bool	nb_poke (const T &, int n=0)

int	used () const

int	size () const

void	debug () const

const char *	kind () const

Public Member Functions inherited from tlm::tlm_blocking_get_if< T >
virtual void	get (T &t)

Public Member Functions inherited from sc_core::sc_interface
virtual void	register_port (sc_port_base &, const char *)

virtual const sc_event &	default_event () const

virtual	~sc_interface ()

Public Member Functions inherited from tlm::tlm_blocking_peek_if< T >
virtual void	peek (T &t) const

Public Member Functions inherited from sc_core::sc_object
const char *	name () const

const char *	basename () const

virtual void	print (std::ostream &=std::cout) const

virtual void	dump (std::ostream &=std::cout) const

virtual const std::vector< sc_object * > &	get_child_objects () const

virtual const std::vector< sc_event * > &	get_child_events () const

sc_object *	get_parent_object () const

bool	add_attribute (sc_attr_base &)

sc_attr_base *	get_attribute (const std::string &)

sc_attr_base *	remove_attribute (const std::string &)

void	remove_all_attributes ()

int	num_attributes () const

sc_attr_cltn &	attr_cltn ()

const sc_attr_cltn &	attr_cltn () const

sc_simcontext *	simcontext () const

Static Public Attributes
static const char *const	kind_string

Protected Member Functions
sc_core::sc_event &	read_event (tlm_tag< T > *=nullptr)

void	update ()

void	init (int)

Protected Member Functions inherited from sc_core::sc_interface
	sc_interface ()

Protected Member Functions inherited from sc_core::sc_prim_channel
	sc_prim_channel ()

	sc_prim_channel (const char *)

virtual	~sc_prim_channel ()

void	request_update ()

void	async_request_update ()

void	next_trigger ()

void	next_trigger (const sc_event &)

void	next_trigger (const sc_event_or_list &)

void	next_trigger (const sc_event_and_list &)

void	next_trigger (const sc_time &)

void	next_trigger (double, sc_time_unit)

void	next_trigger (const sc_time &, const sc_event &)

void	next_trigger (double, sc_time_unit, const sc_event &)

void	next_trigger (const sc_time &, const sc_event_or_list &)

void	next_trigger (double, sc_time_unit, const sc_event_or_list &)

void	next_trigger (const sc_time &, const sc_event_and_list &)

void	next_trigger (double, sc_time_unit, const sc_event_and_list &)

bool	timed_out ()

void	wait ()

void	wait (int)

void	wait (const sc_event &)

void	wait (const sc_event_or_list &)

void	wait (const sc_event_and_list &)

void	wait (const sc_time &)

void	wait (double, sc_time_unit)

void	wait (const sc_time &, const sc_event &)

void	wait (double, sc_time_unit, const sc_event &)

void	wait (const sc_time &, const sc_event_or_list &)

void	wait (double, sc_time_unit, const sc_event_or_list &)

void	wait (const sc_time &, const sc_event_and_list &)

void	wait (double, sc_time_unit, const sc_event_and_list &)

virtual void	before_end_of_elaboration ()

virtual void	end_of_elaboration ()

virtual void	start_of_simulation ()

virtual void	end_of_simulation ()

Protected Member Functions inherited from sc_core::sc_object
	sc_object ()

	sc_object (const char *)

	sc_object (const sc_object &)

sc_object &	operator= (const sc_object &)

virtual	~sc_object ()

Protected Attributes
circular_buffer< T >	buffer

int	m_size

int	m_num_readable

int	m_num_read

int	m_num_written

bool	m_expand

int	m_num_read_no_notify

sc_core::sc_event	m_data_read_event

sc_core::sc_event	m_data_written_event

Private Member Functions
	tlm_fifo (const tlm_fifo< T > &)

tlm_fifo &	operator= (const tlm_fifo< T > &)

bool	is_empty () const

bool	is_full () const

Detailed Description

template<typename T>
class tlm::tlm_fifo< T >

Definition at line 44 of file fifo.hh.

Constructor & Destructor Documentation

◆ tlm_fifo() [1/3]

template<typename T>

tlm::tlm_fifo< T >::tlm_fifo ( int size_ = 1 )

inlineexplicit

Definition at line 49 of file fifo.hh.

References init(), sc_gen_unique_name(), and sc_core::sc_prim_channel::sc_prim_channel().

Referenced by operator=(), tlm::tlm_analysis_fifo< T >::tlm_analysis_fifo(), tlm::tlm_analysis_fifo< T >::tlm_analysis_fifo(), and tlm_fifo().

◆ tlm_fifo() [2/3]

template<typename T>

tlm::tlm_fifo< T >::tlm_fifo	(	const char *	name_,
		int	size_ = 1 )

inlineexplicit

Definition at line 55 of file fifo.hh.

References init(), and sc_core::sc_prim_channel::sc_prim_channel().

◆ ~tlm_fifo()

template<typename T>

virtual tlm::tlm_fifo< T >::~tlm_fifo ( )

inlinevirtual

Definition at line 62 of file fifo.hh.

◆ tlm_fifo() [3/3]

template<typename T>

tlm::tlm_fifo< T >::tlm_fifo ( const tlm_fifo< T > & )

private

References tlm_fifo().

Member Function Documentation

◆ debug()

template<typename T>

void tlm::tlm_fifo< T >::debug ( ) const

inlinevirtual

Implements tlm::tlm_fifo_debug_if< T >.

Definition at line 112 of file fifo.hh.

References is_empty(), is_full(), m_num_read, m_num_readable, m_num_written, size(), and used().

◆ get()

template<typename T>

T tlm::tlm_fifo< T >::get ( tlm_tag< T > * = nullptr )

inlinevirtual

Implements tlm::tlm_blocking_get_if< T >.

Definition at line 29 of file fifo_put_get.hh.

References buffer, is_empty(), m_data_written_event, m_num_read, sc_core::sc_prim_channel::request_update(), and wait().

◆ init()

template<typename T>

void tlm::tlm_fifo< T >::init ( int size_ )

inlineprotected

Definition at line 187 of file fifo.hh.

References buffer, m_expand, m_num_read, m_num_read_no_notify, m_num_readable, m_num_written, and m_size.

Referenced by tlm_fifo(), and tlm_fifo().

◆ is_empty()

template<typename T>

bool tlm::tlm_fifo< T >::is_empty ( ) const

inlineprivate

Definition at line 164 of file fifo.hh.

References used().

Referenced by debug(), get(), nb_can_get(), nb_can_peek(), nb_get(), and peek().

◆ is_full()

template<typename T>

bool tlm::tlm_fifo< T >::is_full ( ) const

inlineprivate

Definition at line 167 of file fifo.hh.

References m_num_readable, m_num_written, and size().

Referenced by debug(), nb_can_put(), and put().

◆ kind()

template<typename T>

const char * tlm::tlm_fifo< T >::kind ( ) const

inlinevirtual

Reimplemented from sc_core::sc_prim_channel.

Definition at line 128 of file fifo.hh.

References kind_string.

◆ nb_bound()

template<typename T>

bool tlm::tlm_fifo< T >::nb_bound ( unsigned int n )

inline

Definition at line 65 of file fifo_resize.hh.

References m_size, and used().

Referenced by nb_reduce().

◆ nb_can_get()

template<typename T>

bool tlm::tlm_fifo< T >::nb_can_get ( tlm_tag< T > * = nullptr ) const

inlinevirtual

Implements tlm::tlm_nonblocking_get_if< T >.

Definition at line 60 of file fifo_put_get.hh.

References is_empty().

◆ nb_can_peek()

template<typename T>

bool tlm::tlm_fifo< T >::nb_can_peek ( tlm_tag< T > * = nullptr ) const

inlinevirtual

Implements tlm::tlm_nonblocking_peek_if< T >.

Definition at line 68 of file fifo_peek.hh.

References is_empty().

◆ nb_can_put()

template<typename T>

bool tlm::tlm_fifo< T >::nb_can_put ( tlm_tag< T > * = nullptr ) const

inlinevirtual

Implements tlm::tlm_nonblocking_put_if< T >.

Definition at line 106 of file fifo_put_get.hh.

References is_full().

◆ nb_expand()

template<typename T>

void tlm::tlm_fifo< T >::nb_expand ( unsigned int n = 1 )

inline

Definition at line 29 of file fifo_resize.hh.

References m_expand, m_size, and sc_core::sc_prim_channel::request_update().

◆ nb_get()

template<typename T>

bool tlm::tlm_fifo< T >::nb_get ( T & val_ )

inlinevirtual

Implements tlm::tlm_nonblocking_get_if< T >.

Definition at line 44 of file fifo_put_get.hh.

References buffer, is_empty(), m_num_read, and sc_core::sc_prim_channel::request_update().

◆ nb_peek() [1/2]

template<typename T>

bool tlm::tlm_fifo< T >::nb_peek ( T & t ) const

inlinevirtual

Implements tlm::tlm_nonblocking_peek_if< T >.

Definition at line 40 of file fifo_peek.hh.

References buffer, and used().

◆ nb_peek() [2/2]

template<typename T>

bool tlm::tlm_fifo< T >::nb_peek	(	T &	t,
		int	n ) const

inlinevirtual

Implements tlm::tlm_fifo_debug_if< T >.

Definition at line 52 of file fifo_peek.hh.

References buffer, and used().

◆ nb_poke()

template<typename T>

bool tlm::tlm_fifo< T >::nb_poke	(	const T &	t,
		int	n = 0 )

inlinevirtual

Implements tlm::tlm_fifo_debug_if< T >.

Definition at line 75 of file fifo_peek.hh.

◆ nb_put()

template<typename T>

bool tlm::tlm_fifo< T >::nb_put ( const T & val_ )

inlinevirtual

Implements tlm::tlm_nonblocking_put_if< T >.

Definition at line 87 of file fifo_put_get.hh.

Referenced by tlm::tlm_analysis_fifo< T >::write(), and tlm::tlm_analysis_fifo< T >::write().

◆ nb_reduce()

template<typename T>

bool tlm::tlm_fifo< T >::nb_reduce ( unsigned int n = 1 )

inline

Definition at line 54 of file fifo_resize.hh.

References m_size, nb_bound(), and size().

◆ nb_unbound()

template<typename T>

void tlm::tlm_fifo< T >::nb_unbound ( unsigned int n = 16 )

inline

Definition at line 40 of file fifo_resize.hh.

References buffer, m_expand, m_size, and sc_core::sc_prim_channel::request_update().

◆ ok_to_get()

template<typename T>

const sc_core::sc_event & tlm::tlm_fifo< T >::ok_to_get ( tlm_tag< T > * = nullptr ) const

inlinevirtual

Implements tlm::tlm_nonblocking_get_if< T >.

Definition at line 70 of file fifo.hh.

References m_data_written_event.

◆ ok_to_peek()

template<typename T>

const sc_core::sc_event & tlm::tlm_fifo< T >::ok_to_peek ( tlm_tag< T > * = nullptr ) const

inlinevirtual

Implements tlm::tlm_nonblocking_peek_if< T >.

Definition at line 81 of file fifo.hh.

References m_data_written_event.

◆ ok_to_put()

template<typename T>

const sc_core::sc_event & tlm::tlm_fifo< T >::ok_to_put ( tlm_tag< T > * = nullptr ) const

inlinevirtual

Implements tlm::tlm_nonblocking_put_if< T >.

Definition at line 92 of file fifo.hh.

References m_data_read_event.

◆ operator=()

template<typename T>

tlm_fifo & tlm::tlm_fifo< T >::operator= ( const tlm_fifo< T > & )

private

References tlm_fifo().

◆ peek()

template<typename T>

T tlm::tlm_fifo< T >::peek ( tlm_tag< T > * = nullptr ) const

inlinevirtual

Implements tlm::tlm_blocking_peek_if< T >.

Definition at line 28 of file fifo_peek.hh.

References buffer, is_empty(), m_data_written_event, and sc_core::wait().

◆ put()

template<typename T>

void tlm::tlm_fifo< T >::put ( const T & val_ )

inlinevirtual

Implements tlm::tlm_blocking_put_if< T >.

Definition at line 69 of file fifo_put_get.hh.

References buffer, is_full(), m_data_read_event, m_num_written, sc_core::sc_prim_channel::request_update(), and wait().

◆ read_event()

template<typename T>

sc_core::sc_event & tlm::tlm_fifo< T >::read_event ( tlm_tag< T > * = nullptr )

inlineprotected

Definition at line 132 of file fifo.hh.

References m_data_read_event.

◆ size()

template<typename T>

int tlm::tlm_fifo< T >::size ( ) const

inlinevirtual

Implements tlm::tlm_fifo_debug_if< T >.

Definition at line 109 of file fifo.hh.

References m_size.

Referenced by debug(), is_full(), and nb_reduce().

◆ update()

template<typename T>

void tlm::tlm_fifo< T >::update ( )

inlineprotectedvirtual

Reimplemented from sc_core::sc_prim_channel.

Definition at line 207 of file fifo.hh.

References buffer, m_data_read_event, m_data_written_event, m_expand, m_num_read, m_num_read_no_notify, m_num_readable, m_num_written, and sc_core::SC_ZERO_TIME.

◆ used()

template<typename T>

int tlm::tlm_fifo< T >::used ( ) const

inlinevirtual

Implements tlm::tlm_fifo_debug_if< T >.

Definition at line 108 of file fifo.hh.

References m_num_read, and m_num_readable.

Referenced by debug(), is_empty(), nb_bound(), nb_peek(), and nb_peek().

Member Data Documentation

◆ buffer

template<typename T>

circular_buffer<T> tlm::tlm_fifo< T >::buffer

protected

Definition at line 140 of file fifo.hh.

Referenced by get(), init(), nb_get(), nb_peek(), nb_peek(), nb_unbound(), peek(), put(), and update().

◆ kind_string

template<typename T>

const char* const tlm::tlm_fifo< T >::kind_string

static

Definition at line 127 of file fifo.hh.

Referenced by kind().

◆ m_data_read_event

template<typename T>

sc_core::sc_event tlm::tlm_fifo< T >::m_data_read_event

protected

Definition at line 151 of file fifo.hh.

Referenced by ok_to_put(), put(), read_event(), and update().

◆ m_data_written_event

template<typename T>

sc_core::sc_event tlm::tlm_fifo< T >::m_data_written_event

protected

Definition at line 152 of file fifo.hh.

Referenced by get(), ok_to_get(), ok_to_peek(), peek(), and update().

◆ m_expand

template<typename T>

bool tlm::tlm_fifo< T >::m_expand

protected

Definition at line 147 of file fifo.hh.

Referenced by init(), nb_expand(), nb_unbound(), and update().

◆ m_num_read

template<typename T>

int tlm::tlm_fifo< T >::m_num_read

protected

Definition at line 145 of file fifo.hh.

Referenced by debug(), get(), init(), nb_get(), update(), and used().

◆ m_num_read_no_notify

template<typename T>

int tlm::tlm_fifo< T >::m_num_read_no_notify

protected

Definition at line 149 of file fifo.hh.

Referenced by init(), and update().

◆ m_num_readable

template<typename T>

int tlm::tlm_fifo< T >::m_num_readable

protected

Definition at line 144 of file fifo.hh.

Referenced by debug(), init(), is_full(), update(), and used().

◆ m_num_written

template<typename T>

int tlm::tlm_fifo< T >::m_num_written

protected

Definition at line 146 of file fifo.hh.

Referenced by debug(), init(), is_full(), put(), and update().

◆ m_size

template<typename T>

int tlm::tlm_fifo< T >::m_size

protected

Definition at line 142 of file fifo.hh.

Referenced by init(), nb_bound(), nb_expand(), nb_reduce(), nb_unbound(), and size().

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

systemc/ext/tlm_core/1/req_rsp/channels/fifo/fifo.hh
systemc/ext/tlm_core/1/req_rsp/channels/fifo/fifo_peek.hh
systemc/ext/tlm_core/1/req_rsp/channels/fifo/fifo_put_get.hh
systemc/ext/tlm_core/1/req_rsp/channels/fifo/fifo_resize.hh

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ tlm_fifo() [1/3]

◆ tlm_fifo() [2/3]

◆ ~tlm_fifo()

◆ tlm_fifo() [3/3]

Member Function Documentation

◆ debug()

◆ get()

◆ init()

◆ is_empty()

◆ is_full()

◆ kind()

◆ nb_bound()

◆ nb_can_get()

◆ nb_can_peek()

◆ nb_can_put()

◆ nb_expand()

◆ nb_get()

◆ nb_peek() [1/2]

◆ nb_peek() [2/2]

◆ nb_poke()

◆ nb_put()

◆ nb_reduce()

◆ nb_unbound()

◆ ok_to_get()

◆ ok_to_peek()

◆ ok_to_put()

◆ operator=()

◆ peek()

◆ put()

◆ read_event()

◆ size()

◆ update()

◆ used()

Member Data Documentation

◆ buffer

◆ kind_string

◆ m_data_read_event

◆ m_data_written_event

◆ m_expand

◆ m_num_read

◆ m_num_read_no_notify

◆ m_num_readable

◆ m_num_written

◆ m_size