pegasus/src/Pegasus/Common/CIMValue.h - annotate

Return to CIMValue.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

1 karl 1.42 //%2005////////////////////////////////////////////////////////////////////////
2 mike 1.11 //
3 karl 1.40 // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development 4 // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. 5 // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
6 karl 1.35 // IBM Corp.; EMC Corporation, The Open Group.
7 karl 1.40 // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; 8 // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
9 karl 1.42 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; 10 // EMC Corporation; VERITAS Software Corporation; The Open Group.
11 mike 1.11 // 12 // Permission is hereby granted, free of charge, to any person obtaining a copy
13 kumpf 1.25 // of this software and associated documentation files (the "Software"), to 14 // deal in the Software without restriction, including without limitation the 15 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
16 mike 1.11 // sell copies of the Software, and to permit persons to whom the Software is 17 // furnished to do so, subject to the following conditions: 18 //
19 kumpf 1.25 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
20 mike 1.11 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED 21 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
22 kumpf 1.25 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR 23 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 24 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 mike 1.11 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 27 // 28 //============================================================================== 29 // 30 //%///////////////////////////////////////////////////////////////////////////// 31 32 #ifndef Pegasus_Value_h 33 #define Pegasus_Value_h 34 35 #include <Pegasus/Common/String.h> 36 #include <Pegasus/Common/Config.h> 37 #include <Pegasus/Common/CIMType.h>
38 kumpf 1.23 #include <Pegasus/Common/CIMObjectPath.h>
39 dave.sudlik 1.41 #include <Pegasus/Common/CIMObject.h>
40 mike 1.11 #include <Pegasus/Common/CIMDateTime.h>
41 kumpf 1.18 #include <Pegasus/Common/Exception.h>
42 mike 1.11 #include <Pegasus/Common/Array.h>
43 kumpf 1.29 #include <Pegasus/Common/Linkage.h>
44 mike 1.11 45 PEGASUS_NAMESPACE_BEGIN 46
47 kumpf 1.18 class CIMValueRep;
48 dave.sudlik 1.41 class CIMObject;
49 kumpf 1.18
50 mike 1.11 /** 51 The CIMValue class represents a value of any of the CIM data types
52 kumpf 1.34 (see \Ref{CIMType} for a list of valid CIM data types). This class
53 mike 1.11 encapsulates a union which holds the current value. The class also 54 has a type field indicating the type of that value. 55 */ 56 class PEGASUS_COMMON_LINKAGE CIMValue 57 { 58 public:
59 kumpf 1.34 /** Constructor - Creates an NULL CIMValue object set to null and 60 with type CIMType:none and !arraytype.
61 karl 1.15 */
62 mike 1.11 CIMValue(); 63
64 kumpf 1.34 /** Constructor - Creates a NULL CIMValue object with the type and
65 kumpf 1.32 array indicator set as specified. 66 @exception TypeMismatchException If the given type is not valid for a 67 CIMValue object.
68 karl 1.15 */ 69 CIMValue(CIMType type, Boolean isArray, Uint32 arraySize = 0); 70
71 kumpf 1.34 /// Constructor.
72 kumpf 1.18 CIMValue(Boolean x);
73 mike 1.11
74 kumpf 1.34 /// Constructor.
75 kumpf 1.18 CIMValue(Uint8 x);
76 mike 1.11
77 kumpf 1.34 /// Constructor.
78 kumpf 1.18 CIMValue(Sint8 x);
79 mike 1.11
80 kumpf 1.34 /// Constructor.
81 kumpf 1.18 CIMValue(Uint16 x);
82 mike 1.11
83 kumpf 1.34 /// Constructor.
84 kumpf 1.18 CIMValue(Sint16 x);
85 mike 1.11
86 kumpf 1.34 /// Constructor.
87 kumpf 1.18 CIMValue(Uint32 x);
88 mike 1.11
89 kumpf 1.34 /// Constructor.
90 kumpf 1.18 CIMValue(Sint32 x);
91 mike 1.11
92 kumpf 1.34 /// Constructor.
93 kumpf 1.18 CIMValue(Uint64 x);
94 mike 1.11
95 kumpf 1.34 /// Constructor.
96 kumpf 1.18 CIMValue(Sint64 x);
97 mike 1.11
98 kumpf 1.34 /// Constructor.
99 kumpf 1.18 CIMValue(Real32 x);
100 mike 1.11
101 kumpf 1.34 /// Constructor.
102 kumpf 1.18 CIMValue(Real64 x);
103 mike 1.11
104 kumpf 1.34 /// Constructor.
105 kumpf 1.18 CIMValue(const Char16& x);
106 mike 1.11
107 kumpf 1.34 /// Constructor.
108 kumpf 1.18 CIMValue(const String& x);
109 mike 1.11
110 kumpf 1.34 /// Constructor.
111 kumpf 1.18 CIMValue(const CIMDateTime& x);
112 mike 1.11
113 kumpf 1.34 /// Constructor.
114 kumpf 1.23 CIMValue(const CIMObjectPath& x);
115 mike 1.11
116 denise.eckstein 1.46 /** Constructor. 117 Note: Constructing a CIMValue with an uninitialized CIMObject is not 118 defined and results in a thrown UninitializedObjectException. 119 Note: The input CIMObject will be cloned before putting it into the 120 value of the constructed CIMValue. This is because CIMObjects use a 121 shared representation model, but we don't want CIMObjects inside a 122 CIMValue to be altered by other external changes. 123 */
124 dave.sudlik 1.41 CIMValue(const CIMObject& x); 125 126 /// Constructor.
127 kumpf 1.18 CIMValue(const Array<Boolean>& x);
128 mike 1.11
129 kumpf 1.34 /// Constructor.
130 kumpf 1.18 CIMValue(const Array<Uint8>& x);
131 mike 1.11
132 kumpf 1.34 /// Constructor.
133 kumpf 1.18 CIMValue(const Array<Sint8>& x);
134 mike 1.11
135 kumpf 1.34 /// Constructor.
136 kumpf 1.18 CIMValue(const Array<Uint16>& x);
137 mike 1.11
138 kumpf 1.34 /// Constructor.
139 kumpf 1.18 CIMValue(const Array<Sint16>& x);
140 mike 1.11
141 kumpf 1.34 /// Constructor.
142 kumpf 1.18 CIMValue(const Array<Uint32>& x);
143 mike 1.11
144 kumpf 1.34 /// Constructor.
145 kumpf 1.18 CIMValue(const Array<Sint32>& x);
146 mike 1.11
147 kumpf 1.34 /// Constructor.
148 kumpf 1.18 CIMValue(const Array<Uint64>& x);
149 mike 1.11
150 kumpf 1.34 /// Constructor.
151 kumpf 1.18 CIMValue(const Array<Sint64>& x);
152 mike 1.11
153 kumpf 1.34 /// Constructor.
154 kumpf 1.18 CIMValue(const Array<Real32>& x);
155 mike 1.11
156 kumpf 1.34 /// Constructor.
157 kumpf 1.18 CIMValue(const Array<Real64>& x);
158 mike 1.11
159 kumpf 1.34 /// Constructor.
160 kumpf 1.18 CIMValue(const Array<Char16>& x);
161 mike 1.11
162 kumpf 1.34 /// Constructor.
163 kumpf 1.18 CIMValue(const Array<String>& x);
164 mike 1.11
165 kumpf 1.34 /// Constructor.
166 kumpf 1.18 CIMValue(const Array<CIMDateTime>& x);
167 mike 1.11
168 kumpf 1.34 /// Constructor.
169 kumpf 1.23 CIMValue(const Array<CIMObjectPath>& x);
170 kumpf 1.14
171 denise.eckstein 1.46 /** Constructor. 172 Note: Constructing a CIMValue with an uninitialized CIMObject anywhere 173 in the input array is not defined and results in a thrown 174 UninitializedObjectException. 175 Note: Each CIMObject in the input Array will be cloned before putting 176 the Array into the value of the constructed CIMValue. This is because 177 CIMObjects use a shared representation model, but we don't want 178 CIMObjects inside a CIMValue to be altered by other external changes. 179 */
180 dave.sudlik 1.41 CIMValue(const Array<CIMObject>& x); 181
182 denise.eckstein 1.46 /** Constructor. 183 Note: If the input type is CIMObject, it/they will be cloned before 184 putting it into the value of the constructed CIMValue. This is because 185 CIMObjects use a shared representation model, but we don't want 186 CIMObjects inside a CIMValue to be altered by other external changes. 187 */
188 mike 1.11 CIMValue(const CIMValue& x); 189
190 kumpf 1.34 /// Destructor.
191 mike 1.11 ~CIMValue(); 192
193 denise.eckstein 1.46 /** Operator = 194 Note: If the right hand side type is CIMObject, it/they will be cloned 195 before putting it into the value of the target CIMValue. This is because 196 CIMObjects use a shared representation model, but we don't want 197 CIMObjects inside a CIMValue to be altered by other external changes. 198 */
199 kumpf 1.18 CIMValue& operator=(const CIMValue& x);
200 mike 1.11
201 kumpf 1.34 /** Assigns one CIMValue object to another CIMValue object. 202 @param x - CIMValue object to be used for assignment.
203 dave.sudlik 1.45 Note: If the input type is CIMObject, it/they will be cloned before 204 putting it into the value of the target CIMValue. This is because 205 CIMObjects use a shared representation model, but we don't want 206 CIMObjects inside a CIMValue to be altered by other external changes.
207 karl 1.13 */
208 mike 1.11 void assign(const CIMValue& x); 209
210 kumpf 1.34 /** Clears the attributes and value of the CIMValue object.
211 karl 1.13 */
212 mike 1.11 void clear(); 213
214 kumpf 1.34 /** Compares the types of two CIMValues. This
215 karl 1.13 compares the type field and the array indicators.
216 kumpf 1.18 @return true if both are of the same type and both are either arrays
217 kumpf 1.34 or not, false otherwise.
218 karl 1.13 <pre> 219 CIMValue a(Boolean(true); 220 CIMValue b = a; 221 if b.typeCompatible(a) 222 ... 223 </pre>
224 mike 1.11 */
225 kumpf 1.18 Boolean typeCompatible(const CIMValue& x) const;
226 mike 1.11
227 kumpf 1.34 /** Determines if the value is an array. 228 @return true if the value is an array, false otherwise.
229 mike 1.11 */
230 kumpf 1.18 Boolean isArray() const;
231 mike 1.11
232 kumpf 1.34 /** Determines whether the CIMvalue object is Null.
233 kumpf 1.18 Null is the specific condition where no value has
234 kumpf 1.34 yet been set. If a CIMValue object is Null, any get on that 235 object will create an exception. 236 @return true if the CIMValue object is Null, false otherwise.
237 mike 1.12 */
238 kumpf 1.18 Boolean isNull() const;
239 mike 1.12
240 kumpf 1.34 /** Gets the size of an Array CIMValue. 241 @return The number of entries in the array.
242 mike 1.11 */ 243 Uint32 getArraySize() const; 244
245 kumpf 1.34 /** Gets the CIMType attribute for the CIMValue. 246 @return the CIMType value.
247 karl 1.13 */
248 kumpf 1.18 CIMType getType() const;
249 mike 1.11
250 kumpf 1.34 /** Sets the CIMValue a NULL, but with valid CIMType and array 251 characteristics. 252 @param type - CIMType for this CIMValue. 253 @param isArray - Boolean indicating whether this is an array CIMValue. 254 @param arraySize - Optional parameter indicating the array size.
255 karl 1.15 <pre>
256 kumpf 1.34 CIMValue value; 257 value.setNullValue(CIMType::BOOLEAN, false);
258 karl 1.15 </pre>
259 karl 1.13 */
260 mike 1.11 void setNullValue(CIMType type, Boolean isArray, Uint32 arraySize = 0); 261
262 kumpf 1.34 /** Sets the type, Array attribute and puts the value provided 263 into the value of the target CIMValue.
264 karl 1.13 <pre> 265 CIMValue x; 266 x.set(Uint16(9)); 267 </pre>
268 dave.sudlik 1.45 @exception UninitializedObjectException If the given type is CIMObject, 269 and the input CIMObject parameter is uninitialized or at least one entry 270 in the Array of CIMObjects is uninitialized. 271 Note: If the input type is CIMObject, it/they will be cloned before 272 putting it into the value of the target CIMValue. This is because 273 CIMObjects use a shared representation model, but we don't want 274 CIMObjects inside a CIMValue to be altered by other external changes.
275 karl 1.13 */
276 mike 1.11 void set(Boolean x); 277
278 kumpf 1.34 ///
279 mike 1.11 void set(Uint8 x);
280 karl 1.13 ///
281 mike 1.11 void set(Sint8 x);
282 karl 1.13 ///
283 mike 1.11 void set(Uint16 x);
284 karl 1.13 ///
285 mike 1.11 void set(Sint16 x);
286 karl 1.13 ///
287 mike 1.11 void set(Uint32 x);
288 karl 1.13 ///
289 mike 1.11 void set(Sint32 x);
290 karl 1.13 ///
291 mike 1.11 void set(Uint64 x);
292 karl 1.13 ///
293 mike 1.11 void set(Sint64 x);
294 karl 1.13 ///
295 mike 1.11 void set(Real32 x);
296 karl 1.13 ///
297 mike 1.11 void set(Real64 x);
298 karl 1.13 ///
299 mike 1.11 void set(const Char16& x);
300 karl 1.13 ///
301 mike 1.11 void set(const String& x);
302 karl 1.13 ///
303 mike 1.11 void set(const CIMDateTime& x);
304 karl 1.13 ///
305 kumpf 1.23 void set(const CIMObjectPath& x);
306 karl 1.13 ///
307 dave.sudlik 1.41 void set(const CIMObject& x); 308 ///
309 mike 1.11 void set(const Array<Boolean>& x);
310 karl 1.13 ///
311 mike 1.11 void set(const Array<Uint8>& x);
312 karl 1.13 ///
313 mike 1.11 void set(const Array<Sint8>& x);
314 karl 1.13 ///
315 mike 1.11 void set(const Array<Uint16>& x);
316 karl 1.13 ///
317 mike 1.11 void set(const Array<Sint16>& x);
318 karl 1.13 ///
319 mike 1.11 void set(const Array<Uint32>& x);
320 karl 1.13 ///
321 mike 1.11 void set(const Array<Sint32>& x);
322 karl 1.13 ///
323 mike 1.11 void set(const Array<Uint64>& x);
324 karl 1.13 ///
325 mike 1.11 void set(const Array<Sint64>& x);
326 karl 1.13 ///
327 mike 1.11 void set(const Array<Real32>& x);
328 karl 1.13 ///
329 mike 1.11 void set(const Array<Real64>& x);
330 karl 1.13 ///
331 mike 1.11 void set(const Array<Char16>& x);
332 karl 1.13 ///
333 mike 1.11 void set(const Array<String>& x);
334 karl 1.13 ///
335 mike 1.11 void set(const Array<CIMDateTime>& x);
336 kumpf 1.14 ///
337 kumpf 1.23 void set(const Array<CIMObjectPath>& x);
338 dave.sudlik 1.41 /// 339 void set(const Array<CIMObject>& x);
340 mike 1.11
341 kumpf 1.34 /** Gets the value of a CIMValue.
342 kumpf 1.31 Note: Before using get, the caller should use getType () and isNull () 343 to ensure that the value is not null, and is of the correct type.
344 dave.sudlik 1.45 345 The behavior of get is undefined when the value is null.
346 kumpf 1.31
347 kumpf 1.34 @param Variable in which to return the value.
348 kumpf 1.31 @exception TypeMismatchException If the CIMValue type is not compatible
349 kumpf 1.34 with the type of the output parameter. 350 <pre> 351 Uint32 v; 352 CIMValue value(CIMValue::UINT32, UINT32(99)); 353 value.get(v); 354 </pre>
355 kumpf 1.31 356 <pre>
357 kumpf 1.34 Uint32 v; 358 CIMValue value = property.getValue (); 359 if ((value.getType () == CIMTYPE_UINT32) && (!value.isNull ())) 360 value.get (v);
361 kumpf 1.31 </pre>
362 karl 1.13 */
363 mike 1.11 void get(Boolean& x) const;
364 karl 1.13 ///
365 mike 1.11 void get(Uint8& x) const;
366 karl 1.13 ///
367 mike 1.11 void get(Sint8& x) const;
368 karl 1.13 ///
369 mike 1.11 void get(Uint16& x) const;
370 karl 1.13 ///
371 mike 1.11 void get(Sint16& x) const;
372 karl 1.13 ///
373 mike 1.11 void get(Uint32& x) const;
374 karl 1.13 ///
375 mike 1.11 void get(Sint32& x) const;
376 karl 1.13 ///
377 mike 1.11 void get(Uint64& x) const;
378 karl 1.13 ///
379 mike 1.11 void get(Sint64& x) const;
380 karl 1.13 ///
381 mike 1.11 void get(Real32& x) const;
382 karl 1.13 ///
383 mike 1.11 void get(Real64& x) const;
384 karl 1.13 ///
385 mike 1.11 void get(Char16& x) const;
386 karl 1.13 ///
387 mike 1.11 void get(String& x) const;
388 karl 1.13 ///
389 mike 1.11 void get(CIMDateTime& x) const;
390 karl 1.13 ///
391 kumpf 1.23 void get(CIMObjectPath& x) const;
392 karl 1.13 ///
393 dave.sudlik 1.41 void get(CIMObject& x) const; 394 ///
395 mike 1.11 void get(Array<Boolean>& x) const;
396 karl 1.13 ///
397 mike 1.11 void get(Array<Uint8>& x) const;
398 kumpf 1.44 ///
399 mike 1.11 void get(Array<Sint8>& x) const;
400 karl 1.13 ///
401 mike 1.11 void get(Array<Uint16>& x) const;
402 karl 1.13 ///
403 mike 1.11 void get(Array<Sint16>& x) const;
404 karl 1.13 ///
405 mike 1.11 void get(Array<Uint32>& x) const;
406 karl 1.13 ///
407 mike 1.11 void get(Array<Sint32>& x) const;
408 karl 1.13 ///
409 mike 1.11 void get(Array<Uint64>& x) const;
410 karl 1.13 ///
411 mike 1.11 void get(Array<Sint64>& x) const;
412 karl 1.13 ///
413 mike 1.11 void get(Array<Real32>& x) const;
414 karl 1.13 ///
415 mike 1.11 void get(Array<Real64>& x) const;
416 karl 1.13 ///
417 mike 1.11 void get(Array<Char16>& x) const;
418 karl 1.13 ///
419 mike 1.11 void get(Array<String>& x) const;
420 karl 1.13 ///
421 mike 1.11 void get(Array<CIMDateTime>& x) const;
422 kumpf 1.14 ///
423 kumpf 1.23 void get(Array<CIMObjectPath>& x) const;
424 dave.sudlik 1.41 /// 425 void get(Array<CIMObject>& x) const;
426 mike 1.11
427 kumpf 1.34 /** Compares with another CIMValue object for equality. 428 @param x - CIMValue to compare with. 429 @return true if they are identical in type, attribute and value, 430 false otherwise.
431 kumpf 1.27 */ 432 Boolean equal(const CIMValue& x) const;
433 kumpf 1.20
434 kumpf 1.34 /** Converts the CIMvalue to a string. Should only be 435 used for output purposes. To get an actual String value, use 436 get(String &). 437 @return String output for CIMValue.
438 kumpf 1.18 <PRE> 439 String test; 440 CIMValue value(Boolean(true)); 441 test = value.toString(); // puts "TRUE" into test 442 </PRE>
443 kumpf 1.44 */
444 mike 1.11 String toString() const; 445
446 david.dillard 1.43 #ifdef PEGASUS_USE_DEPRECATED_INTERFACES
447 kumpf 1.44 /** 448 <I><B>Deprecated Interface</B></I><BR> 449 Constructor. (Note: This constructor exists solely to support binary 450 compatibility with a previous definition of the Sint8 type.) 451 */
452 david.dillard 1.43 CIMValue(char x); 453
454 kumpf 1.44 /** 455 <I><B>Deprecated Interface</B></I><BR> 456 Constructor. (Note: This constructor exists solely to support binary 457 compatibility with a previous definition of the Sint8 type.) 458 */
459 david.dillard 1.43 CIMValue(const Array<char>& x); 460
461 kumpf 1.44 /** 462 <I><B>Deprecated Interface</B></I><BR> 463 Sets an Sint8 value. (Note: This method exists solely to support 464 binary compatibility with a previous definition of the Sint8 type.) 465 */
466 david.dillard 1.43 void set(char x); 467
468 kumpf 1.44 /** 469 <I><B>Deprecated Interface</B></I><BR> 470 Sets an Sint8 array value. (Note: This method exists solely to support 471 binary compatibility with a previous definition of the Sint8 type.) 472 */
473 david.dillard 1.43 void set(const Array<char>& x); 474
475 kumpf 1.44 /** 476 <I><B>Deprecated Interface</B></I><BR> 477 Gets an Sint8 value. (Note: This method exists solely to support 478 binary compatibility with a previous definition of the Sint8 type.) 479 */
480 david.dillard 1.43 void get(char& x) const; 481
482 kumpf 1.44 /** 483 <I><B>Deprecated Interface</B></I><BR> 484 Gets an Sint8 array value. (Note: This method exists solely to support 485 binary compatibility with a previous definition of the Sint8 type.) 486 */
487 david.dillard 1.43 void get(Array<char>& x) const; 488 #endif 489
490 mike 1.11 private: 491
492 a.arora 1.37 CIMValueRep* _rep;
493 mike 1.11 494 friend class CIMMethodRep; 495 friend class CIMParameterRep; 496 friend class CIMPropertyRep; 497 friend class CIMQualifierRep; 498 friend class CIMQualifierDeclRep;
499 schuur 1.38 friend class BinaryStreamer;
500 mike 1.11 };
501 kumpf 1.18
502 karl 1.17 /** operator == compares two CIMValue objects for equality.
503 kumpf 1.34 @param x - First CIMValue to compare 504 @param y - Second CIMValue to compare 505 @return true if they are identical in type, attribute and value, 506 false otherwise.
507 karl 1.17 */
508 mike 1.11 PEGASUS_COMMON_LINKAGE Boolean operator==(const CIMValue& x, const CIMValue& y); 509
510 kumpf 1.34 /** operator != compares two CIMValue objects for inequality. 511 @param x - First CIMValue to compare 512 @param y - Second CIMValue to compare 513 @return true if they are NOT identical in type, attribute or value, 514 false otherwise.
515 karl 1.17 */
516 kumpf 1.18 PEGASUS_COMMON_LINKAGE Boolean operator!=(const CIMValue& x, const CIMValue& y);
517 mike 1.11 518 #define PEGASUS_ARRAY_T CIMValue
519 kumpf 1.24 # include <Pegasus/Common/ArrayInter.h>
520 mike 1.11 #undef PEGASUS_ARRAY_T 521 522 PEGASUS_NAMESPACE_END 523 524 #endif /* Pegasus_Value_h */

No CVS admin address has been configured