SystemC  2.3.1
Accellera SystemC proof-of-concept library
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
sc_core::sc_fifo< T > Class Template Reference

#include <sysc/communication/sc_fifo.h>

Inheritance diagram for sc_core::sc_fifo< T >:
Inheritance graph
[legend]
Collaboration diagram for sc_core::sc_fifo< T >:
Collaboration graph
[legend]

Public Member Functions

 sc_fifo (int size_=16)
 
 sc_fifo (const char *name_, int size_=16)
 
virtual ~sc_fifo ()
 
virtual void register_port (sc_port_base &, const char *)
 
virtual void read (T &)
 
virtual T read ()
 
virtual bool nb_read (T &)
 
virtual int num_available () const
 
virtual const sc_event & data_written_event () const
 
virtual void write (const T &)
 
virtual bool nb_write (const T &)
 
virtual int num_free () const
 
virtual const sc_event & data_read_event () const
 
 operator T ()
 
sc_fifo< T > & operator= (const T &a)
 
void trace (sc_trace_file *tf) const
 
virtual void print (::std::ostream &=::std::cout) const
 
virtual void dump (::std::ostream &=::std::cout) const
 
virtual const char * kind () const
 
- Public Member Functions inherited from sc_core::sc_interface
virtual const sc_event & default_event () const
 
virtual ~sc_interface ()
 
- Public Member Functions inherited from sc_core::sc_prim_channel
bool update_requested ()
 
void request_update ()
 
void async_request_update ()
 
- Public Member Functions inherited from sc_core::sc_object
const char * name () const
 
const char * basename () const
 
sc_simcontext * simcontext () const
 
bool add_attribute (sc_attr_base &)
 
sc_attr_base * get_attribute (const std::string &name_)
 
const sc_attr_base * get_attribute (const std::string &name_) const
 
sc_attr_base * remove_attribute (const std::string &name_)
 
void remove_all_attributes ()
 
int num_attributes () const
 
sc_attr_cltn & attr_cltn ()
 
const sc_attr_cltn & attr_cltn () const
 
virtual const std::vector
< sc_event * > & 		get_child_events () const
 
virtual const std::vector
< sc_object * > & 		get_child_objects () const
 
sc_object * get_parent () const
 
sc_object * get_parent_object () const
 

Protected Member Functions

virtual void update ()
 
void init (int)
 
void buf_init (int)
 
bool buf_write (const T &)
 
bool buf_read (T &)
 
- Protected Member Functions inherited from sc_core::sc_fifo_in_if< T >
 sc_fifo_in_if ()
 
- Protected Member Functions inherited from sc_core::sc_interface
 sc_interface ()
 
- Protected Member Functions inherited from sc_core::sc_fifo_out_if< T >
 sc_fifo_out_if ()
 
- Protected Member Functions inherited from sc_core::sc_prim_channel
 sc_prim_channel ()
 
 sc_prim_channel (const char *)
 
virtual ~sc_prim_channel ()
 
virtual void before_end_of_elaboration ()
 
virtual void end_of_elaboration ()
 
virtual void start_of_simulation ()
 
virtual void end_of_simulation ()
 
void wait ()
 
void wait (const sc_event &e)
 
void wait (const sc_event_or_list &el)
 
void wait (const sc_event_and_list &el)
 
void wait (const sc_time &t)
 
void wait (double v, sc_time_unit tu)
 
void wait (const sc_time &t, const sc_event &e)
 
void wait (double v, sc_time_unit tu, const sc_event &e)
 
void wait (const sc_time &t, const sc_event_or_list &el)
 
void wait (double v, sc_time_unit tu, const sc_event_or_list &el)
 
void wait (const sc_time &t, const sc_event_and_list &el)
 
void wait (double v, sc_time_unit tu, const sc_event_and_list &el)
 
void wait (int n)
 
void next_trigger ()
 
void next_trigger (const sc_event &e)
 
void next_trigger (const sc_event_or_list &el)
 
void next_trigger (const sc_event_and_list &el)
 
void next_trigger (const sc_time &t)
 
void next_trigger (double v, sc_time_unit tu)
 
void next_trigger (const sc_time &t, const sc_event &e)
 
void next_trigger (double v, sc_time_unit tu, const sc_event &e)
 
void next_trigger (const sc_time &t, const sc_event_or_list &el)
 
void next_trigger (double v, sc_time_unit tu, const sc_event_or_list &el)
 
void next_trigger (const sc_time &t, const sc_event_and_list &el)
 
void next_trigger (double v, sc_time_unit tu, const sc_event_and_list &el)
 
bool timed_out ()
 
- Protected Member Functions inherited from sc_core::sc_object
 sc_object ()
 
 sc_object (const char *nm)
 
 sc_object (const sc_object &)
 
sc_object & operator= (const sc_object &)
 
virtual ~sc_object ()
 
virtual void add_child_event (sc_event *event_p)
 
virtual void add_child_object (sc_object *object_p)
 
virtual bool remove_child_event (sc_event *event_p)
 
virtual bool remove_child_object (sc_object *object_p)
 
phase_cb_mask register_simulation_phase_callback (phase_cb_mask)
 
phase_cb_mask unregister_simulation_phase_callback (phase_cb_mask)
 

Protected Attributes

int m_size
 
T * m_buf
 
int m_free
 
int m_ri
 
int m_wi
 
sc_port_base * m_reader
 
sc_port_base * m_writer
 
int m_num_readable
 
int m_num_read
 
int m_num_written
 
sc_event m_data_read_event
 
sc_event m_data_written_event
 

Additional Inherited Members

- Public Types inherited from sc_core::sc_prim_channel
enum  { list_end = 0xdb }
 
- Public Types inherited from sc_core::sc_object
typedef unsigned phase_cb_mask
 

Detailed Description

template<class T>
class sc_core::sc_fifo< T >

Definition at line 48 of file sc_fifo.h.

Constructor & Destructor Documentation

template<class T >
sc_core::sc_fifo< T >::sc_fifo ( int  size_ = 16)
inlineexplicit

Definition at line 57 of file sc_fifo.h.

template<class T >
sc_core::sc_fifo< T >::sc_fifo ( const char *  name_,
int  size_ = 16 
)
inlineexplicit

Definition at line 65 of file sc_fifo.h.

template<class T >
virtual sc_core::sc_fifo< T >::~sc_fifo ( )
inlinevirtual

Definition at line 76 of file sc_fifo.h.

Member Function Documentation

template<class T >
void sc_core::sc_fifo< T >::buf_init ( int  size_)
inlineprotected

Definition at line 377 of file sc_fifo.h.

template<class T >
bool sc_core::sc_fifo< T >::buf_read ( T &  val_)
inlineprotected

Definition at line 406 of file sc_fifo.h.

template<class T >
bool sc_core::sc_fifo< T >::buf_write ( const T &  val_)
inlineprotected

Definition at line 392 of file sc_fifo.h.

template<class T >
virtual const sc_event& sc_core::sc_fifo< T >::data_read_event ( ) const
inlinevirtual

Implements sc_core::sc_fifo_nonblocking_out_if< T >.

Definition at line 120 of file sc_fifo.h.

template<class T >
virtual const sc_event& sc_core::sc_fifo< T >::data_written_event ( ) const
inlinevirtual

Implements sc_core::sc_fifo_nonblocking_in_if< T >.

Definition at line 101 of file sc_fifo.h.

template<class T >
void sc_core::sc_fifo< T >::dump ( ::std::ostream &  os = ::std::cout) const
inlinevirtual

Reimplemented from sc_core::sc_object.

Definition at line 322 of file sc_fifo.h.

template<class T >
void sc_core::sc_fifo< T >::init ( int  size_)
inlineprotected

Definition at line 361 of file sc_fifo.h.

template<class T >
virtual const char* sc_core::sc_fifo< T >::kind ( ) const
inlinevirtual

Reimplemented from sc_core::sc_prim_channel.

Definition at line 140 of file sc_fifo.h.

template<class T >
bool sc_core::sc_fifo< T >::nb_read ( T &  val_)
inlinevirtual

Implements sc_core::sc_fifo_nonblocking_in_if< T >.

Definition at line 245 of file sc_fifo.h.

template<class T >
bool sc_core::sc_fifo< T >::nb_write ( const T &  val_)
inlinevirtual

Implements sc_core::sc_fifo_nonblocking_out_if< T >.

Definition at line 277 of file sc_fifo.h.

template<class T >
virtual int sc_core::sc_fifo< T >::num_available ( ) const
inlinevirtual

Implements sc_core::sc_fifo_in_if< T >.

Definition at line 95 of file sc_fifo.h.

template<class T >
virtual int sc_core::sc_fifo< T >::num_free ( ) const
inlinevirtual

Implements sc_core::sc_fifo_out_if< T >.

Definition at line 114 of file sc_fifo.h.

template<class T >
sc_core::sc_fifo< T >::operator T ( )
inline

Definition at line 126 of file sc_fifo.h.

template<class T >
sc_fifo<T>& sc_core::sc_fifo< T >::operator= ( const T &  a)
inline

Definition at line 130 of file sc_fifo.h.

template<class T >
void sc_core::sc_fifo< T >::print ( ::std::ostream &  os = ::std::cout) const
inlinevirtual

Reimplemented from sc_core::sc_object.

Definition at line 308 of file sc_fifo.h.

template<class T >
void sc_core::sc_fifo< T >::read ( T &  val_)
inlinevirtual

Implements sc_core::sc_fifo_blocking_in_if< T >.

Definition at line 220 of file sc_fifo.h.

template<class T >
T sc_core::sc_fifo< T >::read ( )
inlinevirtual

Implements sc_core::sc_fifo_blocking_in_if< T >.

Definition at line 233 of file sc_fifo.h.

template<class T >
void sc_core::sc_fifo< T >::register_port ( sc_port_base &  port_,
const char *  if_typename_ 
)
inlinevirtual

Reimplemented from sc_core::sc_interface.

Definition at line 186 of file sc_fifo.h.

template<class T >
void sc_core::sc_fifo< T >::trace ( sc_trace_file *  tf) const
inlinevirtual

Reimplemented from sc_core::sc_object.

Definition at line 292 of file sc_fifo.h.

template<class T >
void sc_core::sc_fifo< T >::update ( )
inlineprotectedvirtual

Reimplemented from sc_core::sc_prim_channel.

Definition at line 340 of file sc_fifo.h.

template<class T >
void sc_core::sc_fifo< T >::write ( const T &  val_)
inlinevirtual

Implements sc_core::sc_fifo_blocking_out_if< T >.

Definition at line 262 of file sc_fifo.h.

Member Data Documentation

template<class T >
T* sc_core::sc_fifo< T >::m_buf
protected

Definition at line 158 of file sc_fifo.h.

template<class T >
sc_event sc_core::sc_fifo< T >::m_data_read_event
protected

Definition at line 170 of file sc_fifo.h.

template<class T >
sc_event sc_core::sc_fifo< T >::m_data_written_event
protected

Definition at line 171 of file sc_fifo.h.

template<class T >
int sc_core::sc_fifo< T >::m_free
protected

Definition at line 159 of file sc_fifo.h.

template<class T >
int sc_core::sc_fifo< T >::m_num_read
protected

Definition at line 167 of file sc_fifo.h.

template<class T >
int sc_core::sc_fifo< T >::m_num_readable
protected

Definition at line 166 of file sc_fifo.h.

template<class T >
int sc_core::sc_fifo< T >::m_num_written
protected

Definition at line 168 of file sc_fifo.h.

template<class T >
sc_port_base* sc_core::sc_fifo< T >::m_reader
protected

Definition at line 163 of file sc_fifo.h.

template<class T >
int sc_core::sc_fifo< T >::m_ri
protected

Definition at line 160 of file sc_fifo.h.

template<class T >
int sc_core::sc_fifo< T >::m_size
protected

Definition at line 157 of file sc_fifo.h.

template<class T >
int sc_core::sc_fifo< T >::m_wi
protected

Definition at line 161 of file sc_fifo.h.

template<class T >
sc_port_base* sc_core::sc_fifo< T >::m_writer
protected

Definition at line 164 of file sc_fifo.h.

The documentation for this class was generated from the following file:
Generated on Thu Jun 19 2014 07:41:24 for SystemC by   doxygen 1.8.6