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

// Class Description *************************************************
//
//  Name:  AnalyzeChipResolution
//  Base class: Resolution
//
//  Description: Resolution to call Analyze() on a CHIP_CLASS
//  Usage:
//
// End Class Description *********************************************

//--------------------------------------------------------------------
// Includes
//--------------------------------------------------------------------
#if !defined(iipResolution_h)
#include <iipResolution.h>
#endif

namespace PRDF
{

//--------------------------------------------------------------------
//  Forward References
//--------------------------------------------------------------------
class CHIP_CLASS;

/**
 <One line Class description>
 @author Doug Gilbert
 */
class AnalyzeChipResolution: public Resolution
{
public:
  /**
   Constructor
   <ul>
   <br><b>Parameters:</b>   chip: Chip object
   <br><b>Requirements:</b> None
   <br><b>Promises:</b>     Object created
   <br><b>Exceptions:</b>   None
   </ul><br>
   */
  AnalyzeChipResolution(CHIP_CLASS & chip) : xChip(chip) {}

  /*
   Destructor
   <ul>
   <br><b>Parameters:</b>   None.
   <br><b>Returns:</b>      No value returned
   <br><b>Requirements:</b> None.
   <br><b>Promises:</b>     None.
   <br><b>Exceptions:</b>   None.
   <br><b>Notes:</b>        Compiler default is sufficient
   </ul><br>
   */
  //  ~iipAnalyzeChipResolution();

  /**
   Resolve service data by calling chip.Analyze()
   <ul>
   <br><b>Parameters:</b>   {parms}
   <br><b>Returns:</b>      {return}
   <br><b>Requirements:</b> {preconditions}
   <br><b>Promises:</b>     {postconditions}
   <br><b>Exceptions:</b>   None.
   <br><b>Notes:</b>        {optional}
   </ul><br>
   */
  virtual int32_t Resolve(STEP_CODE_DATA_STRUCT & serviceData);

private:  // functions
private:  // Data

  /**
   @see CHIP_CLASS
   */
  CHIP_CLASS & xChip;

};

} // end namespace PRDF

#endif /* iipAnalyzeChipResolution_h */

// Change Log *********************************************************
//
//  Flag Reason   Vers Date     Coder Description
//  ---- -------- ---- -------- ----- -------------------------------
//                     05/05/98 DRG   Initial Creation
//
// End Change Log *****************************************************
OpenPOWER on IntegriCloud