blob: c2ddcf00b2d616c177b3a2dab370e1f290ae2b6e (
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
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/include/usr/targeting/common/predicates/predicateisnonfunctional.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 2014 */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef __TARGETING_COMMON_PREDICATEISNONFUNCTIONAL_H
#define __TARGETING_COMMON_PREDICATEISNONFUNCTIONAL_H
/**
* @file targeting/common/predicates/predicateisnonfunctional.H
*
* PredicateIsNonFunctional class, used to filter targets for HWP wrapper.
* From the example tutorial page at
* https://w3-connections.ibm.com/wikis/home?lang=en_US#/wiki/Host%20Boot/page/Target%20And%20Attribute%20Usage%20Guide
* :
* Create Custom Predicate
* Take the following predicate "template" and customize to your needs.
* Make sure to:
* 1) Rename the class in the appropriate places
* 2) Implement the operator() function which should return "true" if
* the given Target matches the predicate criteria, false otherwise
* 3) Add any input arguments to the constructor, and any necessary
* private variables to store state
* 4) Implement the destructor, if needed
* 5) Update documentation
*
* See example in src/include/usr/targeting/predicate/predicatectm.H
* (and usr/targeting/predicate/predicatectm.C)
*
*/
/******************************************************************************/
// Includes
/******************************************************************************/
#include <stdint.h>
// targeting support.
#include <targeting/common/attributes.H>
#include <targeting/common/entitypath.H>
#include <targeting/common/target.H>
#include <targeting/common/targetservice.H>
#include <targeting/common/iterators/rangefilter.H>
#include <targeting/common/predicates/predicatectm.H>
namespace TARGETING
{
class PredicateIsNonFunctional : public PredicateBase
{
public:
/**
* @brief Create a predicate to select targets that
* are marked non-functional.
*
* @param[in] i_requirepresent
* Bool indicating whether to select targets which
* are present and non-functional (true)(default), or
* to select all non-functioal targets, regardless of
* present state (false)
*/
PredicateIsNonFunctional(bool i_requirePresent = true);
/**
* @brief Destroy the predicate
*/
virtual ~PredicateIsNonFunctional();
/**
* @brief returns true if target is marked non-functional
*
* @param[in] i_pTarget
* Handle to the target to perform the predicate check on
*
* @return bool indicating whether target is non-functional or not
*/
bool operator()(const TARGETING::Target* i_pTarget) const ;
private:
// Whether to return targets who are present and non-functional (true)
// or to return all non-functional targets, regardless of present state
// (false)
bool iv_requirePresent;
TARG_DISABLE_COPY_AND_ASSIGNMENT_OPERATORS(PredicateIsNonFunctional);
};
}; // end namespace
#endif // __TARGETING_COMMON_PREDICATEISNONFUNCTIONAL_H
|
