blob: 25a6fd930e4e90115e311cf4291f65b74319be9d (
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/diag/prdf/common/util/iipdgtb.h $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* COPYRIGHT International Business Machines Corp. 1993,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 IIPDGTB_H
#define IIPDGTB_H
/* Module Description *************************************************/
/* */
/* Name: iipdgtb.h */
/* */
/* Description: This module provides the Digit String Byte class
declaration. */
/* */
/* End Module Description *********************************************/
/* Change Log *********************************************************/
/* */
/* Flag PTR/DCR# Userid Date Description */
/* ---- -------- -------- -------- ----------- */
/* JST 10/20/93 Initial Creation */
/* */
/* End Change Log *****************************************************/
/*--------------------------------------------------------------------*/
/* Reference the virtual function tables and inline function
defintions in another translation unit. */
/*--------------------------------------------------------------------*/
/*--------------------------------------------------------------------*/
/* Includes */
/*--------------------------------------------------------------------*/
#include <iipdigit.h>
namespace PRDF
{
/*--------------------------------------------------------------------*/
/* Forward References */
/*--------------------------------------------------------------------*/
/*--------------------------------------------------------------------*/
/* User Types */
/*--------------------------------------------------------------------*/
/*--------------------------------------------------------------------*/
/* Constants */
/*--------------------------------------------------------------------*/
/*--------------------------------------------------------------------*/
/* Macros */
/*--------------------------------------------------------------------*/
/*--------------------------------------------------------------------*/
/* Global Variables */
/*--------------------------------------------------------------------*/
/*--------------------------------------------------------------------*/
/* Function Prototypes */
/*--------------------------------------------------------------------*/
/* Class Specification ************************************************/
/* */
/* Name: DIGIT_STRING_BYTE_CLASS */
/* */
/* Title: Byte Digit String */
/* */
/* Purpose: DIGIT_STRING_BYTE_CLASS provides an efficient
representation using a byte (8 bits) for each digit in
the string. */
/* */
/* Usage: This is general purpose base class. */
/* */
/* Side-effects: Memory is allocated. */
/* */
/* Dependencies: None. */
/* */
/* Notes: The Compact Digit String represents each digit in the
string using a byte. This limits the maximum_digit_value
that can be represented to 255. If an attempt is made
to set a digit to a value greater than 255, then the
contents and behaviour of the Digit String are undefined. */
/* */
/* Cardinality: N */
/* */
/* Metaclass: None. */
/* */
/* Space Complexity: O(m) where m is the number of digits in the
string. */
/* */
/* End Class Specification ********************************************/
class DIGIT_STRING_BYTE_CLASS : public DIGIT_STRING_CLASS
{
private:
// Data Specification //////////////////////////////////////////////
//
// Purpose: This buffer is dynamically allocated for digits.
//
// End Data Specification //////////////////////////////////////////
uint8_t * xbuffer;
protected:
// Function Specification //////////////////////////////////////////
//
// Title: Set String (Virtual)
//
// Purpose: This function allocates memory for the string
// representation. Any memory that has been previously
// allocated is deallocated.
//
// Side-effects: Memory is allocated.
//
// Dependencies: This function must be called at least once prior
// to the first Digit read or write.
//
// End Function Specification //////////////////////////////////////
virtual void SetString
(
void
/*!i No parameters */
);
/*!o No value returned */
public:
// Function Specification //////////////////////////////////////////
//
// Title: DIGIT_STRING_BYTE_CLASS (Constructor)
//
// Purpose: This function initializes the data members.
//
// Side-effects: This instance is initialized.
// Memory is allocated.
//
// Dependencies: None.
//
// Time Complexity: Dominated by time complexity of SetString().
//
// End Function Specification //////////////////////////////////////
DIGIT_STRING_BYTE_CLASS
(
uint32_t mdv,
/*!i Maximum digit value */
uint32_t l
/*!i String length */
) :
/*!o No value returned */
DIGIT_STRING_CLASS(mdv, l),
xbuffer(NULL)
{
SetString();
}
// Function Specification //////////////////////////////////////////
//
// Title: DIGIT_STRING_BYTE_CLASS (Base Class Copy Constructor)
//
// Purpose: This function initializes the data members. The digit
// string values are also copied.
//
// Side-effects: This instance is initialized.
// Memory is allocated.
//
// Dependencies: All Digit String values must be less than or equal
// to 255.
//
// Time Complexity: Dominated by time complexity of the functions
// called.
//
// End Function Specification //////////////////////////////////////
DIGIT_STRING_BYTE_CLASS
(
const DIGIT_STRING_CLASS & string
/*!i Digit String reference to copy */
);
/*!o No value returned */
// Function Specification //////////////////////////////////////////
//
// Title: DIGIT_STRING_BYTE_CLASS (Copy Constructor)
//
// Purpose: This function initializes the data members. The digit
// string values are also copied.
//
// Side-effects: This instance is initialized.
// Memory is allocated.
//
// Dependencies: None.
//
// Time Complexity: Dominated by time complexity of the functions
// called.
//
// End Function Specification //////////////////////////////////////
DIGIT_STRING_BYTE_CLASS
(
const DIGIT_STRING_BYTE_CLASS & string
/*!i Digit String Compact reference to copy */
);
/*!o No value returned */
// Function Specification //////////////////////////////////////////
//
// Title: ~DIGIT_STRING_BYTE_CLASS (Virtual destructor)
//
// Purpose: This function deallocates the digit string
// representation.
//
// Side-effects: Memory is deallocated.
//
// Dependencies: None.
//
// End Function Specification //////////////////////////////////////
virtual ~DIGIT_STRING_BYTE_CLASS
(
void
/*!i No paramters */
);
/*!o No value returned */
// Function Specification //////////////////////////////////////////
//
// Title: Assingment operator
//
// Purpose: This function assigns the data members with the values
// from the Digit String reference. The digit string
// values are also assigned.
//
// Side-effects: Data members are modified.
// Memory is reallocated.
//
// Dependencies: All Digit String values must be less than or equal
// to 255.
//
// Time Complexity: Dominated by time complexity of the functions
// called.
//
// End Function Specification //////////////////////////////////////
DIGIT_STRING_BYTE_CLASS & operator=
(
const DIGIT_STRING_CLASS & string
/*!i Digit string instance to assign from */
);
/*!o Reference to this Digit String instance */
DIGIT_STRING_BYTE_CLASS & operator=
(
const DIGIT_STRING_BYTE_CLASS & string
/*!i Digit string instance to assign from */
);
// Function Specification //////////////////////////////////////////
//
// Title: Get Value (Virtual)
//
// Purpose: This function returns the value of a digit at the
// specified position.
//
// Side-effects: None.
//
// Dependencies: Position must be in the string.
//
// End Function Specification //////////////////////////////////////
virtual uint32_t GetValue
(
uint32_t offset
/*!i Digit offset */
) const;
/*!o Digit value */
// Function Specification //////////////////////////////////////////
//
// Title: Set Value (Virtual)
//
// Purpose: This function sets the value of the digit at the
// specified position. No other digits are affected.
//
// Side-effects: A digit in the string is modified.
//
// Dependencies: Position must be in the string.
// Digit value must be less than or equal to 255.
//
// End Function Specification //////////////////////////////////////
virtual void SetValue
(
uint32_t offset,
/*!i Digit offset */
uint32_t value
/*!i Digit value to set */
);
/*!o No value returned */
};
} //End namespace PRDF
#endif
|
