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

// Class Description *************************************************
//
//  Name:  TryResolution
//  Base class: Resolution
//
//  Description: Try a resolution  - if it does not work then
//               call a default resolution
//  Usage:
//
// End Class Description *********************************************

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

namespace PRDF
{

//--------------------------------------------------------------------
//  Forward References
//--------------------------------------------------------------------
/**
 **One line Class description**
 @author Doug Gilbert
 */
class TryResolution: public Resolution
{
public:
  /**
   Constructor
   <ul>
   <br><b>Parameter:   </b> Resolution to try first
   <br><b>Parameter:   </b> Resolution if the try resolution fails
   <br><b>Returns:     </b> Nothing
   <br><b>Requirements:</b> None
   <br><b>Promises:    </b> Object created
   <br><b>Exceptions:  </b> None
   <br><b>Notes:       </b>
   </ul><br>
   */
  TryResolution(Resolution &tryRes, Resolution & defaultRes);
  TryResolution();

  /*
   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>
   */
  //  ~TryResolution();

  /**
   ** description **
   <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>
   */

  /**
   Resolve by calling TryResolution else call DefaultResolution
   <ul>
   <br><b>Parameters:  </b> ServiceDataCollector
   <br><b>Returns:     </b> Return code [SUCCESS | nonZero]
   <br><b>Requirements:</b> none.
   <br><b>Promises:    </b> if(TryResolution.Resolve() != SUCCESS)
                            then xDefaultResolution.Resolve();
   <br><b>Exceptions:  </b> None.
   </ul><br>
   */
  virtual int32_t Resolve(STEP_CODE_DATA_STRUCT & error);

private:  // functions
private:  // Data

Resolution * xTryResolution;
Resolution * xDefaultResolution;

};

inline
TryResolution::TryResolution(Resolution &tryRes, Resolution & defaultRes)
: xTryResolution(&tryRes), xDefaultResolution(&defaultRes) {}

inline
TryResolution::TryResolution()
  : xTryResolution(NULL), xDefaultResolution(NULL) {}

} // end namespace PRDF

#endif /* xspprdTryResolution_h */

OpenPOWER on IntegriCloud