blob: 7ca9b3ff443b07f187d4b92a52c4db9d60471194 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/framework/config/prdfParentDomain.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 1996,2012 */
/* */
/* p1 */
/* */
/* Object Code Only (OCO) source materials */
/* Licensed Internal Code Source Materials */
/* IBM HostBoot Licensed Internal Code */
/* */
/* The source code for this program is not published or otherwise */
/* divested of its trade secrets, irrespective of what has been */
/* deposited with the U.S. Copyright Office. */
/* */
/* Origin: 30 */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef prdfParentDomain_H
#define prdfParentDomain_H
#include <prdfRuleChip.H>
#include <vector>
/**
Template class that Define a domain Parent that contain other domains as children.
@par
@note Parent class: Domain
@par Usage Examples:
@code
@endcode
*/
template <typename T>
class ParentDomain
{
public:
//The information stored for chaining Domains is two things. a Chip of origin.
// Also, a pointer the the child domain. The child domain is the next domain in
// a potential chain or string of domains. The chip is the original chip that started it.
typedef std::pair< TARGETING::TargetHandle_t, T * > ChipToDomainPointerPairType;
typedef std::vector< ChipToDomainPointerPairType > VectorOfDomainPointerType;
// Need to add typename here to tell the compiler that vector< ... >::iterator is a type.
// Otherwise because of the T template parm it doesn't know it's a type yet.
typedef typename std::vector< ChipToDomainPointerPairType >::iterator iterator;
/**
Constructor
<ul>
<br><b>Parameter: </b> domainId: Identifies the Domain (See iipconst.h)
<br><b>Parameter: </b> size: Estimate of max number of chips in domain
<br><b>Returns: </b> None.
<br><b>Requirements:</b> None.
<br><b>Promises: </b> Object created
<br><b>Exceptions: </b> None.
<br><b>Notes: </b>
</ul><br>
*/
ParentDomain();
/**
Add Children to this chip in this domain.
<ul>
<br><b>Parameter: </b> domainId: Identifies the Domain (See iipconst.h)
<br><b>Parameter: </b> chip: Parent to add children to.
<br><b>Parameter: </b> chipList: List of children to add to this Parent.
<br><b>Returns: </b> SUCCESS or FAILURE.
<br><b>Requirements:</b> None.
<br><b>Promises: </b> Object created
<br><b>Exceptions: </b> None.
<br><b>Notes: </b>
</ul><br>
*/
int32_t AddChild(TARGETING::TargetHandle_t i_pchipHandle, T * i_childDomain);
/**
Returns a begin iterator to a list of children domains.
<ul>
<br><b>Parameter: </b> None.
<br><b>Returns: </b> begin iterator.
<br><b>Requirements:</b> None.
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
<br><b>Notes: </b>
</ul><br>
*/
iterator getBeginIterator();
/**
Returns a end iterator to a list of children domains.
<ul>
<br><b>Parameter: </b> None.
<br><b>Returns: </b> end iterator.
<br><b>Requirements:</b> None.
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
<br><b>Notes: </b>
</ul><br>
*/
iterator getEndIterator();
/**
Prints out the ids of the parent chip and children domains.
<ul>
<br><b>Parameter: </b> None
<br><b>Returns: </b> begin iterator.
<br><b>Requirements:</b> None.
<br><b>Promises: </b> None.
<br><b>Exceptions: </b> None.
<br><b>Notes: </b>
</ul><br>
*/
void printChildrenIds();
protected:
private:
VectorOfDomainPointerType iv_childrenDomains;
};
#endif
|
