convenience_socket_bases.h revision 13586:008fe87c1ad4 
1/*****************************************************************************
2
3  Licensed to Accellera Systems Initiative Inc. (Accellera) under one or
4  more contributor license agreements.  See the NOTICE file distributed
5  with this work for additional information regarding copyright ownership.
6  Accellera licenses this file to you under the Apache License, Version 2.0
7  (the "License"); you may not use this file except in compliance with the
8  License.  You may obtain a copy of the License at
9
10    http://www.apache.org/licenses/LICENSE-2.0
11
12  Unless required by applicable law or agreed to in writing, software
13  distributed under the License is distributed on an "AS IS" BASIS,
14  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15  implied.  See the License for the specific language governing
16  permissions and limitations under the License.
17
18 *****************************************************************************/
19#ifndef __SYSTEMC_EXT_TLM_UTILS_CONVENIENCE_SOCKET_BASES_H__
20#define __SYSTEMC_EXT_TLM_UTILS_CONVENIENCE_SOCKET_BASES_H__
21
22namespace sc_core
23{
24
25class sc_object;
26
27} // namespace sc_core
28
29namespace tlm_utils
30{
31
32// Implementation-defined base class helper for convenience sockets.
33class convenience_socket_base
34{
35  public:
36    void display_warning(const char *msg) const;
37    void display_error(const char *msg) const;
38
39  protected:
40    virtual ~convenience_socket_base() {}
41
42  private:
43    virtual const char *get_report_type() const = 0;
44    virtual const sc_core::sc_object *get_socket() const = 0;
45};
46
47// Implementation-defined base class helper for simple sockets.
48class simple_socket_base : public convenience_socket_base
49{
50    virtual const char *get_report_type() const;
51
52  protected:
53    void elaboration_check(const char *action) const;
54};
55
56// Implementation-defined base class helper for passthrough sockets.
57class passthrough_socket_base : public convenience_socket_base
58{
59    virtual const char *get_report_type() const;
60};
61
62// Implementation-defined base class helper for multi sockets.
63class multi_socket_base : public convenience_socket_base
64{
65    virtual const char *get_report_type() const;
66};
67
68// Implementation-defined base class for callback helpers.
69class convenience_socket_cb_holder
70{
71  public:
72    void display_warning(const char *msg) const;
73    void display_error(const char *msg) const;
74
75  protected:
76    explicit convenience_socket_cb_holder(convenience_socket_base *owner) :
77        m_owner(owner)
78    {}
79
80  private:
81    convenience_socket_base *m_owner;
82};
83
84} // namespace tlm_utils
85
86#endif /* __SYSTEMC_EXT_TLM_UTILS_CONVENIENCE_SOCKET_BASES_H__ */
87