summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/attn/attnlist.H
blob: 3c1ce4ec886cc4c347be4c68f42477f45b6f91f8 (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
/*  IBM_PROLOG_BEGIN_TAG
 *  This is an automatically generated prolog.
 *
 *  $Source: src/usr/diag/attn/attnlist.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 __ATTN_ATTNLIST_H
#define __ATTN_ATTNLIST_H

/**
 * @file attnlist.H
 *
 * @brief HBATTN AttentionList definition.
 */

#include "attnops.H"
#include "attnfwd.H"

namespace ATTN
{

/**
 * @brief AttentionList Class definition.
 *
 * Container for Attentions.  Attentions
 * kept sorted by attention type priority.
 */
class AttentionList : public std::vector<Attention>
{
    public:

        /**
         * @brief merge Merge two containers.
         *
         * @param[in] i_src Container from which elements are merged.
         *
         * @return AttentionList Merged attention list.
         */
        AttentionList & merge(const AttentionList & i_src);

        /**
         * @brief add Insert a new Attention element.
         *
         * @param[in] i_attn The attention element to add.
         */
        void add(const Attention & i_attn);

        /**
         * @brief getAttnList Convert to PRDF::AttnList.
         *
         * Elements are placed such that attentions with
         * higher priority appear before those with
         * lower priority.
         *
         * @param[out] o_dest Where PRDF::AttnData elements are placed.
         */
        void getAttnList(PRDF::AttnList & o_dest) const;

        /**
         * @brief forEach Invoke a functor on each element.
         *
         * @param[in] i_functor The functor to invoke.
         *
         * @return Functor The functor.
         */
        template<typename Functor>
            Functor forEach(Functor i_functor) const
            {
                return std::for_each(begin(), end(), i_functor);
            }

        /**
         * @brief split Create two lists by evaluating a predicate.
         *
         * @param[in/out] io_true Insert elements that evaluate true.
         * @param[in/out] ioi_false Insert elements that evaluate false.
         * @param[in] i_predicate The predicate to evaluate.
         *
         * @return Predicate The predicate functor.
         */
        template<typename Predicate>
            Predicate split(AttentionList & io_true,
                    AttentionList & io_false,
                    Predicate i_predicate) const
            {
                const_iterator dit = begin();

                while(dit != end())
                {
                    i_predicate(*dit)
                        ? io_true.add(*dit)
                        : io_false.add(*dit);

                    ++dit;
                }

                return i_predicate;
            }

        /**
         * @brief AttnListTest Provide access to unit test.
         */
        friend class ::AttnListTest;
};
}
#endif
OpenPOWER on IntegriCloud