sc_object.hh revision 12940:f191f383f3bf 
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_OBJECT_HH__
31#define __SYSTEMC_EXT_CORE_SC_OBJECT_HH__
32
33#include <iostream>
34#include <string>
35#include <vector>
36
37namespace sc_core
38{
39
40class sc_event;
41class sc_attr_base;
42class sc_attr_cltn;
43class sc_simcontext;
44
45class sc_object
46{
47  public:
48    const char *name() const;
49    const char *basename() const;
50
51    virtual const char *kind() const;
52
53    virtual void print(std::ostream & =std::cout) const;
54    virtual void dump(std::ostream & =std::cout) const;
55
56    virtual const std::vector<sc_object *> &get_child_objects() const;
57    virtual const std::vector<sc_event *> &get_child_events() const;
58    sc_object *get_parent_object() const;
59
60    bool add_attribute(sc_attr_base &);
61    sc_attr_base *get_attribute(const std::string &);
62    sc_attr_base *remove_attribute(const std::string &);
63    void remove_all_attributes();
64    int num_attributes() const;
65    sc_attr_cltn &attr_cltn();
66    const sc_attr_cltn &attr_cltn() const;
67
68    // Deprecated
69    sc_simcontext *
70    simcontext() const;
71
72  protected:
73    sc_object();
74    sc_object(const char *);
75    sc_object(const sc_object &);
76    sc_object &operator = (const sc_object &);
77    virtual ~sc_object();
78};
79
80const std::vector<sc_object *> &sc_get_top_level_objects();
81sc_object *sc_find_object(const char *);
82
83} // namespace sc_core
84
85#endif  //__SYSTEMC_EXT_CORE_SC_OBJECT_HH__
86