blob: e826f19e7bb19a7aa6f1fdebbba0a73d7d969423 (
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
|
/* IBM_PROLOG_BEGIN_TAG
* This is an automatically generated prolog.
*
* $Source: src/include/usr/targeting/common/predicates/predicateisfunctional.H $
*
* IBM CONFIDENTIAL
*
* COPYRIGHT International Business Machines Corp. 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 other-
* wise 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_PREDICATEISFUNCTIONAL_H
#define __TARGETING_COMMON_PREDICATEISFUNCTIONAL_H
/**
* @file targeting/common/predicates/predicateisfunctional.H
*
* PredicateIsFunctional 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 PredicateIsFunctional : public PredicateBase
{
public:
/**
* @brief Create a predicate to select targets that
* are marked functional.
* Default (no parms) is to check for functional: assumption is that
* functional implies poweredOn, etc.
* More function will probably be added later.
*
*/
PredicateIsFunctional( );
/**
* @brief Destroy the predicate
*/
virtual ~PredicateIsFunctional();
/**
* @brief returns true if target is marked functional
*
* @param[in] i_pTarget
* Handle to the target to perform the predicate check on
*
* @return bool indicating whether target it functional or not
*/
bool operator()(const TARGETING::Target* i_pTarget) const ;
private:
TARG_DISABLE_COPY_AND_ASSIGNMENT_OPERATORS(PredicateIsFunctional);
};
}; // end namespace
#endif // __TARGETING_COMMON_PREDICATEISFUNCTIONAL_H
|
