sc_prim.hh revision 12929:6ed4226c66c7 
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_CORE_SC_PRIM_HH__
31#define __SYSTEMC_EXT_CORE_SC_PRIM_HH__
32
33#include "sc_object.hh"
34#include "sc_time.hh"
35
36namespace sc_core
37{
38
39class sc_event;
40class sc_event_and_list;
41class sc_event_or_list;
42
43class sc_prim_channel : public sc_object
44{
45  public:
46    virtual const char *kind() const;
47
48  protected:
49    sc_prim_channel();
50    explicit sc_prim_channel(const char *);
51    virtual ~sc_prim_channel() {}
52
53    void request_update();
54    void async_request_update();
55    virtual void update() {}
56
57    void next_trigger();
58    void next_trigger(const sc_event &);
59    void next_trigger(const sc_event_or_list &);
60    void next_trigger(const sc_event_and_list &);
61    void next_trigger(const sc_time &);
62    void next_trigger(double, sc_time_unit);
63    void next_trigger(const sc_time &, const sc_event &);
64    void next_trigger(double, sc_time_unit, const sc_event &);
65    void next_trigger(const sc_time &, const sc_event_or_list &);
66    void next_trigger(double, sc_time_unit, const sc_event_or_list &);
67    void next_trigger(const sc_time &, const sc_event_and_list &);
68    void next_trigger(double, sc_time_unit, const sc_event_and_list &);
69
70    // Nonstandard.
71    bool timed_out();
72
73    void wait();
74    void wait(int);
75    void wait(const sc_event &);
76    void wait(const sc_event_or_list &);
77    void wait(const sc_event_and_list &);
78    void wait(const sc_time &);
79    void wait(double, sc_time_unit);
80    void wait(const sc_time &, const sc_event &);
81    void wait(double, sc_time_unit, const sc_event &);
82    void wait(const sc_time &, const sc_event_or_list &);
83    void wait(double, sc_time_unit, const sc_event_or_list &);
84    void wait(const sc_time &, const sc_event_and_list &);
85    void wait(double, sc_time_unit, const sc_event_and_list &);
86
87    virtual void before_end_of_elaboration() {}
88    virtual void end_of_elaboration() {}
89    virtual void start_of_simulation() {}
90    virtual void end_of_simulation() {}
91
92  private:
93    // Disabled
94    sc_prim_channel(const sc_prim_channel &);
95    sc_prim_channel &operator = (const sc_prim_channel &);
96};
97
98} // namespace sc_core
99
100#endif  //__SYSTEMC_EXT_CORE_SC_PRIM_HH__
101