sc_buffer.hh revision 12867:eb8d1838275b 
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_BUFFER_HH__
31#define __SYSTEMC_EXT_CHANNEL_SC_BUFFER_HH__
32
33#include "../core/sc_module.hh" // for sc_gen_unique_name
34#include "sc_signal.hh"
35#include "warn_unimpl.hh" // for warn_unimpl
36
37namespace sc_core
38{
39
40// Having a default value for the WRITER_POLICY parameter is non-standard, but
41// matches the Accellera implementation to enable the regression tests.
42template <class T, sc_writer_policy WRITER_POLICY=SC_ONE_WRITER>
43class sc_buffer : public sc_signal<T, WRITER_POLICY>
44{
45  public:
46    sc_buffer() : sc_signal<T, WRITER_POLICY>(sc_gen_unique_name("buffer")) {}
47    explicit sc_buffer(const char *name) :
48            sc_signal<T, WRITER_POLICY>(sc_gen_unique_name(name))
49    {}
50
51    virtual void
52    write(const T&)
53    {
54        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
55    }
56
57    sc_buffer<T, WRITER_POLICY> &
58    operator = (const T &)
59    {
60        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
61        return *this;
62    }
63    sc_buffer<T, WRITER_POLICY> &
64    operator = (const sc_signal<T, WRITER_POLICY> &)
65    {
66        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
67        return *this;
68    }
69    sc_buffer<T, WRITER_POLICY> &
70    operator = (const sc_buffer<T, WRITER_POLICY> &)
71    {
72        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
73        return *this;
74    }
75
76    virtual const char *kind() const { return "sc_buffer"; }
77
78  protected:
79    virtual void
80    update()
81    {
82        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
83    }
84
85  private:
86    // Disabled
87    sc_buffer(const sc_buffer<T, WRITER_POLICY> &) {}
88};
89
90} // namespace sc_core
91
92#endif  //__SYSTEMC_EXT_CHANNEL_SC_BUFFER_HH__
93