sc_fifo_in.hh revision 12841:22aa7ba47bf9 
1/*
2 * Copyright 2018 Google, Inc.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met: redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer;
8 * redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution;
11 * neither the name of the copyright holders nor the names of its
12 * contributors may be used to endorse or promote products derived from
13 * this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * Authors: Gabe Black
28 */
29
30#ifndef __SYSTEMC_EXT_CHANNEL_SC_FIFO_IN_HH__
31#define __SYSTEMC_EXT_CHANNEL_SC_FIFO_IN_HH__
32
33#include "../core/sc_port.hh"
34#include "sc_fifo_in_if.hh"
35#include "warn_unimpl.hh"
36
37namespace sc_core
38{
39
40class sc_event;
41class sc_event_finder;
42
43template <class T>
44class sc_fifo_in : public sc_port<sc_fifo_in_if<T>, 0>
45{
46  public:
47    sc_fifo_in() : sc_port<sc_fifo_in_if<T>, 0>() {}
48    explicit sc_fifo_in(const char *name) : sc_port<sc_fifo_in_if<T>, 0>(name)
49    {}
50    virtual ~sc_fifo_in() {}
51
52    void
53    read(T &)
54    {
55        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
56    }
57    T
58    read()
59    {
60        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
61        return *(T *)nullptr;
62    }
63    bool
64    nb_read(T &)
65    {
66        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
67        return false;
68    }
69    const sc_event &
70    data_written_event() const
71    {
72        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
73        return *(const sc_event *)nullptr;
74    }
75    sc_event_finder &
76    data_written() const
77    {
78        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
79        return *(sc_event_finder *)nullptr;
80    }
81    int
82    num_available() const
83    {
84        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
85        return 0;
86    }
87    virtual const char *kind() const { return "sc_fifo_in"; }
88
89  private:
90    // Disabled
91    sc_fifo_in(const sc_fifo_in<T> &) : sc_port<sc_fifo_in_if<T>, 0>() {}
92    sc_fifo_in<T> &operator = (const sc_fifo_in<T> &) { return *this; }
93};
94
95} // namespace sc_core
96
97#endif  //__SYSTEMC_EXT_CHANNEL_SC_FIFO_IN_HH__
98