summaryrefslogtreecommitdiffstats
path: root/src/usr/diag/prdf/common/framework/resolution/iipResolution.h
blob: 899d90c65cfd3917a6c3a71c88bb952959218389 (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
156
157
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/prdf/common/framework/resolution/iipResolution.h $ */
/*                                                                        */
/* IBM CONFIDENTIAL                                                       */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 1996,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 iipResolution_h
#define iipResolution_h

// Class Description *************************************************
//
//  Name:  Resolution
//  Base class: None
//
//  Description:  This module contains the Processor Runtime
//                  Diagnostics Resolution class declaration.
//                Resolution provides a mechansim to resolve a
//                hardware error and provide service data
//
//  Usage:  Abstract base class
//
//  int32_t foo(STEP_CODE_DATA_STRUCT &serviceData,
//             ResolutionMap &map)
//  {
//    Resolution &r = map.LookUp(BIT_LIST_STRING_21);
//    int32_t rc = r.Resolve(serviceData);
//    return(rc);
//  }
//
// End Class Description *********************************************
/*--------------------------------------------------------------------*/
/* Reference the virtual function tables and inline function
   defintions in another translation unit.                            */
/*--------------------------------------------------------------------*/

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

#if !defined(PRDF_TYPES_H)
#include <prdf_types.h>
#endif

#if !defined(IIPSTEP_H)
#include <iipstep.h>
#endif

namespace PRDF
{

//--------------------------------------------------------------------
//  Forward References
//--------------------------------------------------------------------
class CalloutResolution;    //dg00


class Resolution
{
public:

  /**
   Destructor
   @pre None
   @post None
   @note This destructor does nothing.  This definitions
         would have the same effect as the compiler generated
         default destructor.  It is declared virtual so that
         derived classes will be destructed properly.
   */
  virtual ~Resolution();

  /**
   Resolve the service data for this error syndrome
   @pre None
   @post service data is complete
   @return SUCCESS | non-zero
   */
  virtual int32_t Resolve(STEP_CODE_DATA_STRUCT & data) = 0;
  // Function Specification ********************************************
  //
  // Purpose:      Resolve service data for a specific error bit (Pure Virtual)
  // Parameters:   Reference to the Step code data structure
  // Returns:      return code
  // Requirements: None
  // Promises:     if rc = SUCCESS then data filled with apropriate service data
  // Exceptions:   None
  // Concurrency:  synchronous
  // Notes:        if rc != SUCCESS then state of service data is unpredictable
  //
  // End Function Specification ****************************************


  // Copy ctor   - compiler default is sufficient
  // Assignment  - compiler default is sufficient

  // dg00 start
  /**
   Comparison
   <ul>
   <br><b>Parameters:  </b> A Resolution
   <br><b>Returns:     </b> [true | false]
   <br><b>Requirements:</b> None.
   <br><b>Promises:    </b> None.
   <br><b>Exceptions:  </b> None.
   <br><b>Notes:       </b> Each derived class that supports comparison must be listed
   here.
   </ul><br>
   */
  virtual bool operator==(const Resolution & r) const
  { return false; }  // default
  virtual bool operator==(const CalloutResolution & r) const
  { return false; }
  // dg00 end

protected:

  Resolution() {}
  // Function Specification ********************************************
  //
  // Purpose:      Constructor
  // Parameters:   Pointer to charater string bit list encoding (opt)
  // Returns:      Nothing
  // Requirements: None
  // Promises:     Object created
  // Exceptions:   None
  // Concurrency:  synchronous
  // Notes:
  //
  // End Function Specification ****************************************

private:  // functions
private:  // Data


};

} // end namespace PRDF

#endif /* iipResolution_h */

OpenPOWER on IntegriCloud