sc_event_queue.hh revision 13258:91b819262b87 
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_EVENT_QUEUE_HH__
31#define __SYSTEMC_EXT_CHANNEL_SC_EVENT_QUEUE_HH__
32
33#include <queue>
34
35#include "../core/sc_event.hh"
36#include "../core/sc_interface.hh"
37#include "../core/sc_module.hh" // for sc_gen_unique_name
38#include "../core/sc_module_name.hh"
39#include "../core/sc_port.hh"
40#include "../core/sc_time.hh"
41#include "warn_unimpl.hh"
42
43namespace sc_core
44{
45
46class sc_event;
47
48class sc_event_queue_if : public virtual sc_interface
49{
50  public:
51    virtual void notify(double, sc_time_unit) = 0;
52    virtual void notify(const sc_time &) = 0;
53    virtual void cancel_all() = 0;
54};
55
56class sc_event_queue : public sc_event_queue_if, public sc_module
57{
58  public:
59    SC_HAS_PROCESS(sc_event_queue);
60
61    sc_event_queue(sc_module_name name=
62                   sc_module_name(sc_gen_unique_name("event_queue")));
63    ~sc_event_queue();
64
65    virtual const char *kind() const { return "sc_event_queue"; }
66
67    virtual void notify(double, sc_time_unit);
68    virtual void notify(const sc_time &);
69    virtual void cancel_all();
70
71    virtual const sc_event &default_event() const;
72
73  private:
74    void _trigger();
75
76    sc_event _defaultEvent;
77    std::priority_queue<
78        sc_time, std::vector<sc_time>, std::greater<sc_time> > _times;
79};
80
81// Nonstandard
82typedef sc_port<sc_event_queue_if, 1, SC_ONE_OR_MORE_BOUND>
83        sc_event_queue_port;
84
85} // namespace sc_core
86
87#endif  //__SYSTEMC_EXT_CHANNEL_SC_EVENT_QUEUE_HH__
88