Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | // ========== Copyright Header Begin ========================================== |
2 | // | |
3 | // OpenSPARC T2 Processor File: XactorBaseExpectDataStruct.vr | |
4 | // Copyright (C) 1995-2007 Sun Microsystems, Inc. All Rights Reserved | |
5 | // 4150 Network Circle, Santa Clara, California 95054, U.S.A. | |
6 | // | |
7 | // * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
8 | // | |
9 | // This program is free software; you can redistribute it and/or modify | |
10 | // it under the terms of the GNU General Public License as published by | |
11 | // the Free Software Foundation; version 2 of the License. | |
12 | // | |
13 | // This program is distributed in the hope that it will be useful, | |
14 | // but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | // GNU General Public License for more details. | |
17 | // | |
18 | // You should have received a copy of the GNU General Public License | |
19 | // along with this program; if not, write to the Free Software | |
20 | // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
21 | // | |
22 | // For the avoidance of doubt, and except that if any non-GPL license | |
23 | // choice is available it will apply instead, Sun elects to use only | |
24 | // the General Public License version 2 (GPLv2) at this time for any | |
25 | // software where a choice of GPL license versions is made | |
26 | // available with the language indicating that GPLv2 or any later version | |
27 | // may be used, or where a choice of which version of the GPL is applied is | |
28 | // otherwise unspecified. | |
29 | // | |
30 | // Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, | |
31 | // CA 95054 USA or visit www.sun.com if you need additional information or | |
32 | // have any questions. | |
33 | // | |
34 | // ========== Copyright Header End ============================================ | |
35 | #include <vera_defines.vrh> | |
36 | #include "XactorBasePacket.vrh" | |
37 | #include "XactorDefines.vri" | |
38 | ||
39 | #include "cReport.vrh" | |
40 | ||
41 | virtual class XactorBaseExpectDataStruct { | |
42 | ||
43 | // Transactor Name | |
44 | protected string XactorName; | |
45 | ||
46 | // Report handle. | |
47 | ReportClass MyReport; | |
48 | ||
49 | task new () {} | |
50 | ||
51 | // Inserts a new node in the data structure. | |
52 | // Item is a reference to a transactor packet object | |
53 | // The function will return a reference to the inserted node | |
54 | virtual task Insert (XactorBasePacket Item, | |
55 | var event RemoveEvents[XACT_EXPECT_DATA_STRUCT_REMOVE_EVENTS] | |
56 | ); | |
57 | ||
58 | // Deletes the specified node | |
59 | // Success = 1 if the node was removed and 0 otherwise | |
60 | virtual task Delete (XactorBasePacket Item, | |
61 | var bit Success); | |
62 | ||
63 | // Deletes the specified node that contains "Item". The | |
64 | // search is done by comparing Items and the node's packet | |
65 | // references. | |
66 | // Success = 1 if the node was removed and 0 otherwise | |
67 | virtual task RefDelete (XactorBasePacket Item, | |
68 | var bit Success); | |
69 | ||
70 | // Deletes multiple nodes when Item has "wildcards" | |
71 | // Success = 1 if at least a node was removed and 0 otherwise | |
72 | virtual task WildCardDelete1 (XactorBasePacket Item, | |
73 | var bit Success); | |
74 | ||
75 | // Returns the number of nodes in the data structure | |
76 | virtual function integer CountNodes(); | |
77 | ||
78 | // Prints each node of the data structure. | |
79 | virtual task PrintNodes(); | |
80 | ||
81 | // Returns 1 if Item is found in the data structure and 0 otherwise | |
82 | virtual function bit InStructure(XactorBasePacket Item); | |
83 | ||
84 | // Returns 1 if the data structure is empty and 0 otherwise | |
85 | virtual function bit Empty(); | |
86 | ||
87 | // Will walk the data structure and on each node triggering | |
88 | // the corresponding status flags. At the end of the walk, every node | |
89 | // is deleted by nulling the head references. | |
90 | virtual task Reset(); | |
91 | } | |
92 | ||
93 |