sc_fifo_in.hh revision 12868 
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    // Deprecated binding constructors.
53    explicit sc_fifo_in(const sc_fifo_in_if<T> &interface) :
54        sc_port<sc_fifo_in_if<T>, 0>(interface)
55    {}
56    sc_fifo_in(const char *name, const sc_fifo_in_if<T> &interface) :
57        sc_port<sc_fifo_in_if<T>, 0>(name, interface)
58    {}
59    explicit sc_fifo_in(sc_port_b<sc_fifo_in_if<T> > &parent) :
60        sc_port<sc_fifo_in_if<T>, 0>(parent)
61    {}
62    sc_fifo_in(const char *name, sc_port_b<sc_fifo_in_if<T> > &parent) :
63        sc_port<sc_fifo_in_if<T>, 0>(name, parent)
64    {}
65    explicit sc_fifo_in(sc_port<sc_fifo_in_if<T>, 0> &parent) :
66        sc_port<sc_fifo_in_if<T>, 0>(parent)
67    {}
68    sc_fifo_in(const char *name, sc_port<sc_fifo_in_if<T>, 0> &parent) :
69        sc_port<sc_fifo_in_if<T>, 0>(name, parent)
70    {}
71
72    void
73    read(T &)
74    {
75        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
76    }
77    T
78    read()
79    {
80        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
81        return *(T *)nullptr;
82    }
83    bool
84    nb_read(T &)
85    {
86        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
87        return false;
88    }
89    const sc_event &
90    data_written_event() const
91    {
92        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
93        return *(const sc_event *)nullptr;
94    }
95    sc_event_finder &
96    data_written() const
97    {
98        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
99        return *(sc_event_finder *)nullptr;
100    }
101    int
102    num_available() const
103    {
104        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
105        return 0;
106    }
107    virtual const char *kind() const { return "sc_fifo_in"; }
108
109  private:
110    // Disabled
111    sc_fifo_in(const sc_fifo_in<T> &) : sc_port<sc_fifo_in_if<T>, 0>() {}
112    sc_fifo_in<T> &operator = (const sc_fifo_in<T> &) { return *this; }
113};
114
115} // namespace sc_core
116
117#endif  //__SYSTEMC_EXT_CHANNEL_SC_FIFO_IN_HH__
118