gem5  v19.0.0.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
hello_object.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Jason Lowe-Power
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met: redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer;
9  * redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution;
12  * neither the name of the copyright holders nor the names of its
13  * contributors may be used to endorse or promote products derived from
14  * this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * Authors: Jason Lowe-Power
29  */
30 
31 #ifndef __LEARNING_GEM5_HELLO_OBJECT_HH__
32 #define __LEARNING_GEM5_HELLO_OBJECT_HH__
33 
34 #include <string>
35 
37 #include "params/HelloObject.hh"
38 #include "sim/sim_object.hh"
39 
40 class HelloObject : public SimObject
41 {
42  private:
46  void processEvent();
47 
50 
53 
55  const std::string myName;
56 
58  const Tick latency;
59 
61  int timesLeft;
62 
63  public:
64  HelloObject(HelloObjectParams *p);
65 
71  void startup();
72 };
73 
74 #endif // __LEARNING_GEM5_HELLO_OBJECT_HH__
const std::string myName
The name of this object in the Python config file.
Definition: hello_object.hh:55
void startup()
Part of a SimObject&#39;s initilaization.
Definition: hello_object.cc:52
const Tick latency
Latency between calling the event (in ticks)
Definition: hello_object.hh:58
void processEvent()
Example function to execute on an event trigger.
Definition: hello_object.cc:59
uint64_t Tick
Tick count type.
Definition: types.hh:63
HelloObject(HelloObjectParams *p)
Definition: hello_object.cc:36
int timesLeft
Number of times left to fire the event before goodbye.
Definition: hello_object.hh:61
EventFunctionWrapper event
An event that wraps the above function.
Definition: hello_object.hh:49
Bitfield< 0 > p
Abstract superclass for simulation objects.
Definition: sim_object.hh:96
GoodbyeObject * goodbye
Pointer to the corresponding GoodbyeObject. Set via Python.
Definition: hello_object.hh:52

Generated on Fri Feb 28 2020 16:27:01 for gem5 by doxygen 1.8.13