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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/targeting/common/utilFilter.H $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2012,2013 */
/* */
/* 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 __TARGETING_COMMON_UTIL_FILTER_H
#define __TARGETING_COMMON_UTIL_FILTER_H
/**
* @file targeting/common/utilFilter.H
*
* @brief Targeting Filter utility functions
*/
#include <attributeenums.H>
#include <targeting/common/predicates/predicatebase.H>
#include <targeting/common/iterators/targetiterator.H>
#include <targeting/common/iterators/rangefilter.H>
namespace TARGETING
{
/**
* @brief Populate the o_vector with target chip pointers based on the
* requested type, and functional state.
*
* @parm[out] o_vector, reference of vector of target pointers.
* @parm[in] i_type, the type of the chip targets to be obtained
* @parm[in] i_functional, set to true to return only functional targets
*
* @return N/A
*/
void getAllChips(TARGETING::TargetHandleList & o_vector,
TYPE i_type, bool i_functional = true );
/**
* @brief Populate the o_vector with target chiplet pointers based on the
* requested type, and functional state.
*
* @parm[out] o_vector, reference of vector of target pointers.
* @parm[in] i_type, the type of the chiplet targets to be obtained
* @parm[in] i_functional, set to true to return only functional targets
*
* @return N/A
*/
void getAllChiplets(TARGETING::TargetHandleList & o_vector,
TYPE i_type, bool i_functional = true );
/**
* @brief Populate the o_vector with chiplet target object pointers associated
* to the input chip
*
* @parm[out] o_vector, reference of vector of target pointers.
* @parm[in] i_chip, the chip target for retrieving its child chiplets
* @parm[in] i_type, the type of the chiplet targets to be obtained
* @parm[in] i_functional, set to true to return only functional targets
*
* @return N/A
*/
void getChildChiplets(TARGETING::TargetHandleList & o_vector,
const Target * i_chip, TYPE i_type, bool i_functional = true );
/**
* @brief Populate the o_vector with target object pointers which are
* affinity children of the input target
*
* @parm[out] o_vector, reference of vector of target pointers.
* @parm[in] i_target, the target for retrieving affinity-child targets
* @parm[in] i_class, the class of the target to be obtained
* @parm[in] i_type, the type of the target to be obtained
* @parm[in] i_functional, set to true to return only functional targets
*
* @return N/A
*/
void getChildAffinityTargets ( TARGETING::TargetHandleList& o_vector,
const Target * i_target, CLASS i_class, TYPE i_type,
bool i_functional = true );
/**
* @brief Populate the o_vector with target object pointers which are
* affinity parents of the input target
*
* @parm[out] o_vector, reference of vector of target pointers.
* @parm[in] i_target, the target for retrieving affinity-parent targets
* @parm[in] i_class, the class of the target to be obtained
* @parm[in] i_type, the type of the target to be obtained
* @parm[in] i_functional, set to true to return only functional targets
*
* @return N/A
*/
void getParentAffinityTargets ( TARGETING::TargetHandleList& o_vector,
const Target * i_target, CLASS i_class, TYPE i_type,
bool i_functional = true );
/**
* @brief return the parent chip target of the specified input chiplet
*
* @parm[in] i_pChiplet, chiplet target for retrieving the parent chip target
*
* @return Parent chip target pointer or NULL if error
*/
const Target * getParentChip( const Target * i_pChiplet );
/**
* @brief Return a list of all cards in a system
*
* @param[out] o_vector - Vector of the matching targets.
* @param[in] i_cardType - The Targeting type.
* @param[in] i_function - Return only Functional cards, default = true
*
* @return NONE
*/
void getAllCards( TARGETING::TargetHandleList & o_vector,
TYPE i_cardType,
bool i_functional = true );
/**
* @brief Return a list of all cards in a system
*
* @param[out] o_vector - Vector of the matching targets.
* @param[in] i_cardType - The Targeting type.
* @param[in] i_function - Return only Functional cards, default = true
*
* @return NONE
*/
void getAllLogicalCards( TARGETING::TargetHandleList & o_vector,
TYPE i_cardType,
bool i_functional = true );
}
#endif // __TARGETING_COMMON_UTIL_H
|
