クラス テンプレート sc_core::sc_fifo< T >

#include <sc_fifo.h>

sc_core::sc_fifo< T >に対する継承グラフ

[凡例]

すべてのメンバ一覧

Public メソッド
	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
Protected メソッド
virtual void	update ()
void	init (int)
void	buf_init (int)
bool	buf_write (const T &)
bool	buf_read (T &)
Protected 変数
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
Private メソッド
	sc_fifo (const sc_fifo< T > &)
sc_fifo &	operator= (const sc_fifo< T > &)

---

説明

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

sc_fifo.h の 83 行で定義されています。

---

コンストラクタとデストラクタ

template<class T>

sc_core::sc_fifo< T >::sc_fifo

(

int

size_ = 16

)

[inline, explicit]

sc_fifo.h の 92 行で定義されています。

        : sc_prim_channel( sc_gen_unique_name( "fifo" ) )
        { init( size_ ); }

template<class T>

sc_core::sc_fifo< T >::sc_fifo	(	const char *	name_,
		int	size_ = 16
	)			[inline, explicit]

sc_fifo.h の 96 行で定義されています。

        : sc_prim_channel( name_ )
        { init( size_ ); }

template<class T>

virtual sc_core::sc_fifo< T >::~sc_fifo

(

)

[inline, virtual]

sc_fifo.h の 103 行で定義されています。

        { delete [] m_buf; }

template<class T>

sc_core::sc_fifo< T >::sc_fifo

(

const sc_fifo< T > &

)

[private]

---

関数

template<class T>

void sc_core::sc_fifo< T >::register_port	(	sc_port_base &	port_,
		const char *	if_typename_
	)			[inline, virtual]

sc_core::sc_interfaceを再定義しています。

sc_fifo.h の 213 行で定義されています。

{
    std::string nm( if_typename_ );
    if( nm == typeid( sc_fifo_in_if<T> ).name() ) {
        // only one reader can be connected
        if( m_reader != 0 ) {
            SC_REPORT_ERROR( SC_ID_MORE_THAN_ONE_FIFO_READER_, 0 );
        }
        m_reader = &port_;
    } else {  // nm == typeid( sc_fifo_out_if<T> ).name()
        // only one writer can be connected
        if( m_writer != 0 ) {
            SC_REPORT_ERROR( SC_ID_MORE_THAN_ONE_FIFO_WRITER_, 0 );
        }
        m_writer = &port_;
    }
}

template<class T>

void sc_core::sc_fifo< T >::read

(

T &

val_

)

[inline, virtual]

sc_core::sc_fifo_blocking_in_if< T >を実装しています。

sc_fifo.h の 238 行で定義されています。

{
    while( num_available() == 0 ) {
        sc_core::wait( m_data_written_event );
    }
    m_num_read ++;
    buf_read( val_ );
    request_update();
}

template<class T>

T sc_core::sc_fifo< T >::read

(

)

[inline, virtual]

sc_core::sc_fifo_blocking_in_if< T >を実装しています。

sc_fifo.h の 251 行で定義されています。

{
    T tmp;
    read( tmp );
    return tmp;
}

template<class T>

bool sc_core::sc_fifo< T >::nb_read

(

T &

val_

)

[inline, virtual]

sc_core::sc_fifo_nonblocking_in_if< T >を実装しています。

sc_fifo.h の 263 行で定義されています。

{
    if( num_available() == 0 ) {
        return false;
    }
    m_num_read ++;
    buf_read( val_ );
    request_update();
    return true;
}

template<class T>

virtual int sc_core::sc_fifo< T >::num_available

(

)

const [inline, virtual]

sc_core::sc_fifo_in_if< T >を実装しています。

sc_fifo.h の 122 行で定義されています。

        { return ( m_num_readable - m_num_read ); }

template<class T>

virtual const sc_event& sc_core::sc_fifo< T >::data_written_event

(

)

const [inline, virtual]

sc_core::sc_fifo_nonblocking_in_if< T >を実装しています。

sc_fifo.h の 128 行で定義されています。

        { return m_data_written_event; }

template<class T>

void sc_core::sc_fifo< T >::write

(

const T &

val_

)

[inline, virtual]

sc_core::sc_fifo_blocking_out_if< T >を実装しています。

sc_fifo.h の 280 行で定義されています。

{
    while( num_free() == 0 ) {
        sc_core::wait( m_data_read_event );
    }
    m_num_written ++;
    buf_write( val_ );
    request_update();
}

template<class T>

bool sc_core::sc_fifo< T >::nb_write

(

const T &

val_

)

[inline, virtual]

sc_core::sc_fifo_nonblocking_out_if< T >を実装しています。

sc_fifo.h の 295 行で定義されています。

{
    if( num_free() == 0 ) {
        return false;
    }
    m_num_written ++;
    buf_write( val_ );
    request_update();
    return true;
}

template<class T>

virtual int sc_core::sc_fifo< T >::num_free

(

)

const [inline, virtual]

sc_core::sc_fifo_out_if< T >を実装しています。

sc_fifo.h の 141 行で定義されています。

        { return ( m_size - m_num_readable - m_num_written ); }

template<class T>

virtual const sc_event& sc_core::sc_fifo< T >::data_read_event

(

)

const [inline, virtual]

sc_core::sc_fifo_nonblocking_out_if< T >を実装しています。

sc_fifo.h の 147 行で定義されています。

        { return m_data_read_event; }

template<class T>

sc_core::sc_fifo< T >::operator T

(

)

[inline]

sc_fifo.h の 153 行で定義されています。

        { return read(); }

template<class T>

sc_fifo<T>& sc_core::sc_fifo< T >::operator=

(

const T &

a

)

[inline]

sc_fifo.h の 157 行で定義されています。

        { write( a ); return *this; }

template<class T>

void sc_core::sc_fifo< T >::trace

(

sc_trace_file *

tf

)

const [inline, virtual]

sc_core::sc_objectを再定義しています。

sc_fifo.h の 310 行で定義されています。

{
#if defined(DEBUG_SYSTEMC)
    char buf[32];
    std::string nm = name();
    for( int i = 0; i < m_size; ++ i ) {
        std::sprintf( buf, "_%d", i );
        sc_trace( tf, m_buf[i], nm + buf );
    }
#endif
}

template<class T>

void sc_core::sc_fifo< T >::print

(

::std::ostream &

os = ::std::cout

)

const [inline, virtual]

sc_core::sc_objectを再定義しています。

sc_fifo.h の 326 行で定義されています。

{
    if( m_free != m_size ) {
        int i = m_ri;
        do {
            os << m_buf[i] << ::std::endl;
            i = ( i + 1 ) % m_size;
        } while( i != m_wi );
    }
}

template<class T>

void sc_core::sc_fifo< T >::dump

(

::std::ostream &

os = ::std::cout

)

const [inline, virtual]

sc_core::sc_objectを再定義しています。

sc_fifo.h の 340 行で定義されています。

{
    os << "name = " << name() << ::std::endl;
    if( m_free != m_size ) {
        int i = m_ri;
        int j = 0;
        do {
            os << "value[" << i << "] = " << m_buf[i] << ::std::endl;
            i = ( i + 1 ) % m_size;
            j ++;
        } while( i != m_wi );
    }
}

template<class T>

virtual const char* sc_core::sc_fifo< T >::kind

(

)

const [inline, virtual]

sc_core::sc_prim_channelを再定義しています。

sc_fifo.h の 167 行で定義されています。

        { return "sc_fifo"; }

template<class T>

void sc_core::sc_fifo< T >::update

(

)

[inline, protected, virtual]

sc_core::sc_prim_channelを再定義しています。

sc_fifo.h の 358 行で定義されています。

{
    if( m_num_read > 0 ) {
        m_data_read_event.notify(SC_ZERO_TIME);
    }

    if( m_num_written > 0 ) {
        m_data_written_event.notify(SC_ZERO_TIME);
    }

    m_num_readable = m_size - m_free;
    m_num_read = 0;
    m_num_written = 0;
}

template<class T>

void sc_core::sc_fifo< T >::init

(

int

size_

)

[inline, protected]

sc_fifo.h の 379 行で定義されています。

{
    buf_init( size_ );

    m_reader = 0;
    m_writer = 0;

    m_num_readable = 0;
    m_num_read = 0;
    m_num_written = 0;
}

template<class T>

void sc_core::sc_fifo< T >::buf_init

(

int

size_

)

[inline, protected]

sc_fifo.h の 395 行で定義されています。

{
    if( size_ <= 0 ) {
        SC_REPORT_ERROR( SC_ID_INVALID_FIFO_SIZE_, 0 );
    }
    m_size = size_;
    m_buf = new T[m_size];
    m_free = m_size;
    m_ri = 0;
    m_wi = 0;
}

template<class T>

bool sc_core::sc_fifo< T >::buf_write

(

const T &

val_

)

[inline, protected]

sc_fifo.h の 410 行で定義されています。

{
    if( m_free == 0 ) {
        return false;
    }
    m_buf[m_wi] = val_;
    m_wi = ( m_wi + 1 ) % m_size;
    m_free --;
    return true;
}

template<class T>

bool sc_core::sc_fifo< T >::buf_read

(

T &

val_

)

[inline, protected]

sc_fifo.h の 424 行で定義されています。

{
    if( m_free == m_size ) {
        return false;
    }
    val_ = m_buf[m_ri];
    m_ri = ( m_ri + 1 ) % m_size;
    m_free ++;
    return true;
}

template<class T>

sc_fifo& sc_core::sc_fifo< T >::operator=

(

const sc_fifo< T > &

)

[private]

---

変数

template<class T>

int sc_core::sc_fifo< T >::m_size [protected]

sc_fifo.h の 184 行で定義されています。

template<class T>

T* sc_core::sc_fifo< T >::m_buf [protected]

sc_fifo.h の 185 行で定義されています。

template<class T>

int sc_core::sc_fifo< T >::m_free [protected]

sc_fifo.h の 186 行で定義されています。

template<class T>

int sc_core::sc_fifo< T >::m_ri [protected]

sc_fifo.h の 187 行で定義されています。

template<class T>

int sc_core::sc_fifo< T >::m_wi [protected]

sc_fifo.h の 188 行で定義されています。

template<class T>

sc_port_base* sc_core::sc_fifo< T >::m_reader [protected]

sc_fifo.h の 190 行で定義されています。

template<class T>

sc_port_base* sc_core::sc_fifo< T >::m_writer [protected]

sc_fifo.h の 191 行で定義されています。

template<class T>

int sc_core::sc_fifo< T >::m_num_readable [protected]

sc_fifo.h の 193 行で定義されています。

template<class T>

int sc_core::sc_fifo< T >::m_num_read [protected]

sc_fifo.h の 194 行で定義されています。

template<class T>

int sc_core::sc_fifo< T >::m_num_written [protected]

sc_fifo.h の 195 行で定義されています。

template<class T>

sc_event sc_core::sc_fifo< T >::m_data_read_event [protected]

sc_fifo.h の 197 行で定義されています。

template<class T>

sc_event sc_core::sc_fifo< T >::m_data_written_event [protected]

sc_fifo.h の 198 行で定義されています。

---

このクラスの説明は次のファイルから生成されました:

• C:/systemc-2.2.0/systemc-2.2.0/src/sysc/communication/sc_fifo.h