summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/prdf/common/framework/resolution/iipCalloutResolution.h
blob: 7fbdf372ebbaf936f8da546ba106125bd32bf4d2 (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
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
155
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/common/framework/resolution/iipCalloutResolution.h $ */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 1998,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 iipCalloutResolution_h
#define iipCalloutResolution_h

// Class Description *************************************************
//
//  Name:  CalloutResolution
//  Base class: Resolution
//
//  Description: Resolution makes a MRU Callout.
//
//  Usage:
//
//
//  CalloutResolution  r1(PU0,MRU_MED);
//  ResolutionMap rm(....)    // see iipResolutionMap.h
//  rm.Add(BIT_LIST_STRING_31,&r1);  // if bit 31 is on callout PU0 HIGH as
//                                   // the failing item
//
//  ...
//
//
// End Class Description *********************************************

//--------------------------------------------------------------------
// Includes
//--------------------------------------------------------------------

#include <prdfCallouts.H>
#include <iipResolution.h>

namespace PRDF
{

//--------------------------------------------------------------------
//  Forward References
//--------------------------------------------------------------------

/**
 A resolution that adds a MRU callout to the service data collector
 @version V4R5
 @author Douglas R. Gilbert
*/

class CalloutResolution: public Resolution
{
public:

  /**
   CTOR
   <ul>
   <br><b>Parameters:  </b> a MruValues, a PriorityValues (see xspiiCallout.h)
   <br><b>Returns:     </b> None.
   <br><b>Requirements:</b> None.
   <br><b>Promises:    </b> Object created
   <br><b>Exceptions:  </b> None.
   </ul><br>
   */
  CalloutResolution(PRDcallout callout, PRDpriority priority);
  CalloutResolution(void);    // default
  CalloutResolution(const CalloutResolution & cr);

  // Function Specification ********************************************
  //
  // Purpose:      Destruction
  // Parameters:   None.
  // Returns:      No value returned
  // Requirements: None.
  // Promises:     None.
  // Exceptions:   None.
  // Concurrency:  Reentrant
  // Notes:        Compiler default is sufficient
  //
  // End Function Specification ****************************************
  //~CalloutResolution();

  /**
   Resolve by adding a the MRU callout to the service data collector
   <ul>
   <br><b>Parameters:  </b> ServiceDataCollector
   <br><b>Returns:     </b> Return code [SUCCESS | nonZero]
   <br><b>Requirements:</b> none.
   <br><b>Promises:    </b> serviceData::GetMruList().GetCount()++
   <br><b>Exceptions:  </b> None.
   </ul><br>
   */
  virtual int32_t Resolve(STEP_CODE_DATA_STRUCT & error);

  // dg00 start
  virtual bool operator==(const Resolution & r) const
  {
    return r.operator==(*this);  // compare whatever r is with this
  }

  virtual bool operator==(const CalloutResolution & r) const
  {
    return((xMruCallout == r.xMruCallout) && (xPriority == r.xPriority));
  }

//  friend int operator==(const CalloutResolution& a, const CalloutResolution& b)
//  {
//    return((a.xMruCallout == b.xMruCallout) && (a.xPriority == b.xPriority));
//  }
  // dg00 end

private:  // functions
private:  // Data

 PRDcallout xMruCallout;
 PRDpriority xPriority;

};


inline
CalloutResolution::CalloutResolution(PRDcallout callout,
                                     PRDpriority priority)
: xMruCallout(callout), xPriority(priority)
{}

inline
CalloutResolution::CalloutResolution() :
    xMruCallout(NULL), xPriority(MRU_MED)
{}

inline
CalloutResolution::CalloutResolution(const CalloutResolution & cr)
: xMruCallout(cr.xMruCallout), xPriority(cr.xPriority)
{}

} // end namespace PRDF

#endif /* iipCalloutResolution_h */
OpenPOWER on IntegriCloud