(file) Return to CIMValue.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/CIMValue.h between version 1.32 and 1.39

version 1.32, 2002/09/20 04:06:42 version 1.39, 2004/08/25 00:14:24
Line 1 
Line 1 
 //%/////////////////////////////////////////////////////////////////////////////  //%2003////////////////////////////////////////////////////////////////////////
 // //
 // Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM,  // Copyright (c) 2000, 2001, 2002  BMC Software, Hewlett-Packard Development
 // The Open Group, Tivoli Systems  // Company, L. P., IBM Corp., The Open Group, Tivoli Systems.
   // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.;
   // IBM Corp.; EMC Corporation, The Open Group.
 // //
 // Permission is hereby granted, free of charge, to any person obtaining a copy // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to // of this software and associated documentation files (the "Software"), to
Line 21 
Line 23 
 // //
 //============================================================================== //==============================================================================
 // //
 // Author: Mike Brasher (mbrasher@bmc.com)  
 //  
 // Modified By: Karl schopmeyer (k.schopmeyer@opengroup.org)  
 //              Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)  
 //              Carol Ann Krug Graves, Hewlett-Packard Company  
 //                (carolann_graves@hp.com)  
 //  
 //%///////////////////////////////////////////////////////////////////////////// //%/////////////////////////////////////////////////////////////////////////////
  
 #ifndef Pegasus_Value_h #ifndef Pegasus_Value_h
Line 48 
Line 43 
  
 /** /**
     The CIMValue class represents a value of any of the CIM data types     The CIMValue class represents a value of any of the CIM data types
     (see CIMType.h for a list of valid CIM data types). This class      (see \Ref{CIMType} for a list of valid CIM data types). This class
     encapsulates a union which holds the current value. The class also     encapsulates a union which holds the current value. The class also
     has a type field indicating the type of that value.     has a type field indicating the type of that value.
 */ */
 class PEGASUS_COMMON_LINKAGE CIMValue class PEGASUS_COMMON_LINKAGE CIMValue
 { {
 public: public:
     /** Constructor with no value. This constructor creates an NULL CIMValue      /** Constructor - Creates an NULL CIMValue object set to null and
         object set to null and with type CIMType:none and !arraytype.          with type CIMType:none and !arraytype.
     */     */
     CIMValue();     CIMValue();
  
     /** Constructor that creates a NULL CIMValue object with the type and      /** Constructor - Creates a NULL CIMValue object with the type and
         array indicator set as specified.         array indicator set as specified.
         @exception TypeMismatchException If the given type is not valid for a         @exception TypeMismatchException If the given type is not valid for a
         CIMValue object.         CIMValue object.
     */     */
     CIMValue(CIMType type, Boolean isArray, Uint32 arraySize = 0);     CIMValue(CIMType type, Boolean isArray, Uint32 arraySize = 0);
  
     // ATTN This needs an example      /// Constructor.
     /** Constructor with the Value constructor and a value.  
         This constructs a  
         CIMValue object with the type defined by the value constructor  
         and the value  
         installed  
     */  
     CIMValue(Boolean x);     CIMValue(Boolean x);
  
     /// Constructor      /// Constructor.
     CIMValue(Uint8 x);     CIMValue(Uint8 x);
  
     /// Constructor      /// Constructor.
     CIMValue(Sint8 x);     CIMValue(Sint8 x);
  
     /// Constructor      /// Constructor.
     CIMValue(Uint16 x);     CIMValue(Uint16 x);
  
     /// Constructor      /// Constructor.
     CIMValue(Sint16 x);     CIMValue(Sint16 x);
  
     /// Constructor      /// Constructor.
     CIMValue(Uint32 x);     CIMValue(Uint32 x);
  
     /// Constructor      /// Constructor.
     CIMValue(Sint32 x);     CIMValue(Sint32 x);
  
     /// Constructor      /// Constructor.
     CIMValue(Uint64 x);     CIMValue(Uint64 x);
  
     /// Constructor      /// Constructor.
     CIMValue(Sint64 x);     CIMValue(Sint64 x);
  
     /// Constructor      /// Constructor.
     CIMValue(Real32 x);     CIMValue(Real32 x);
  
     /// Constructor      /// Constructor.
     CIMValue(Real64 x);     CIMValue(Real64 x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Char16& x);     CIMValue(const Char16& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const String& x);     CIMValue(const String& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const CIMDateTime& x);     CIMValue(const CIMDateTime& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const CIMObjectPath& x);     CIMValue(const CIMObjectPath& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Boolean>& x);     CIMValue(const Array<Boolean>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Uint8>& x);     CIMValue(const Array<Uint8>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Sint8>& x);     CIMValue(const Array<Sint8>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Uint16>& x);     CIMValue(const Array<Uint16>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Sint16>& x);     CIMValue(const Array<Sint16>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Uint32>& x);     CIMValue(const Array<Uint32>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Sint32>& x);     CIMValue(const Array<Sint32>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Uint64>& x);     CIMValue(const Array<Uint64>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Sint64>& x);     CIMValue(const Array<Sint64>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Real32>& x);     CIMValue(const Array<Real32>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Real64>& x);     CIMValue(const Array<Real64>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<Char16>& x);     CIMValue(const Array<Char16>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<String>& x);     CIMValue(const Array<String>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<CIMDateTime>& x);     CIMValue(const Array<CIMDateTime>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const Array<CIMObjectPath>& x);     CIMValue(const Array<CIMObjectPath>& x);
  
     /// Constructor      /// Constructor.
     CIMValue(const CIMValue& x);     CIMValue(const CIMValue& x);
  
     /// Destructor      /// Destructor.
     ~CIMValue();     ~CIMValue();
  
     /// Operator =     /// Operator =
     CIMValue& operator=(const CIMValue& x);     CIMValue& operator=(const CIMValue& x);
  
     /** assign - The method to assign one CIMValue object to another CIMValue      /** Assigns one CIMValue object to another CIMValue object.
     object.          @param x - CIMValue object to be used for assignment.
     */     */
     void assign(const CIMValue& x);     void assign(const CIMValue& x);
  
     /** clear - Clears the attributes and value of the CIMValue object.      /** Clears the attributes and value of the CIMValue object.
     */     */
     void clear();     void clear();
  
     /** typeCompatible - Compares the types of two CIMValues. This      /** Compares the types of two CIMValues. This
         compares the type field and the array indicators.         compares the type field and the array indicators.
         @return true if both are of the same type and both are either arrays         @return true if both are of the same type and both are either arrays
         or not. Else returns false.          or not, false otherwise.
         <pre>         <pre>
             CIMValue a(Boolean(true);             CIMValue a(Boolean(true);
             CIMValue b = a;             CIMValue b = a;
Line 194 
Line 183 
     */     */
     Boolean typeCompatible(const CIMValue& x) const;     Boolean typeCompatible(const CIMValue& x) const;
  
     /** isArray - Determines if the value is an array      /** Determines if the value is an array.
         @return TRUE if the value is an array          @return true if the value is an array, false otherwise.
     */     */
     Boolean isArray() const;     Boolean isArray() const;
  
     /** Returns whether the CIMvalue object is Null.      /** Determines whether the CIMvalue object is Null.
         Null is the specific condition where no value has         Null is the specific condition where no value has
         yet been set into the value.          yet been set. If a CIMValue object is Null, any get on that
         If a CIMValue object is Null, any get on that object          object will create an exception.
         will create an exception.          @return true if the CIMValue object is Null, false otherwise.
         @return Returns True if the CIMValue object is Null  
     */     */
     Boolean isNull() const;     Boolean isNull() const;
  
     /** getArraySize = Returns the size of an Array CIMValue      /** Gets the size of an Array CIMValue.
         @return The number of entries in the array          @return The number of entries in the array.
     */     */
     Uint32 getArraySize() const;     Uint32 getArraySize() const;
  
     /** getType - Gets the CIMType attribute for the CIMValue.      /** Gets the CIMType attribute for the CIMValue.
         @return the CIMType value          @return the CIMType value.
     */     */
     CIMType getType() const;     CIMType getType() const;
  
     /** setNullValue - Sets the CIMType, the Array indicator and if it is      /** Sets the CIMValue a NULL, but with valid CIMType and array
         the arraytype, the Arraysize of a CIMValue and sets the isNull          characteristics.
         Attribute.  This function is used to set up CIMValues an NULL but          @param type - CIMType for this CIMValue.
         with valid CIMType and array characteristics (ex. when update from          @param isArray - Boolean indicating whether this is an array CIMValue.
         XML)          @param arraySize - Optional parameter indicating the array size.
         @param type - The CIMType for this CIMValue  
         @param isArray - Boolean indicating whether this is an array CIMValue  
         @param arraySize (optional) Uint32 parameter indicating the array  
         size  
         @return void  
         <pre>         <pre>
             CIMValue value;                   // Create a CIMValue object              CIMValue value;
             value.setNullValue(CIMType::BOOLEAN, false);  // Set it              value.setNullValue(CIMType::BOOLEAN, false);
         </pre>         </pre>
     */     */
     void setNullValue(CIMType type, Boolean isArray, Uint32 arraySize = 0);     void setNullValue(CIMType type, Boolean isArray, Uint32 arraySize = 0);
  
     //  All of the CIMTypes defined in ATTN: and the Array types defined in      /** Sets the type, Array attribute and puts the value provided
     //  ATTN: may be set.          into the value of the target CIMValue.
     /** set - Sets the type, Array attribute and puts the value provided  
         into the value of the target CIMValue. This function sets the  
         CIMValue to nonNull also. The result is a complete CIMValue object  
         @param x Typed value (ex. Boolean(true).  
         @return void  
         <pre>         <pre>
             CIMValue x;             CIMValue x;
             x.set(Uint16(9));             x.set(Uint16(9));
Line 249 
Line 227 
     */     */
     void set(Boolean x);     void set(Boolean x);
  
     /// Set      ///
     void set(Uint8 x);     void set(Uint8 x);
     ///     ///
     void set(Sint8 x);     void set(Sint8 x);
Line 308 
Line 286 
     ///     ///
     void set(const Array<CIMObjectPath>& x);     void set(const Array<CIMObjectPath>& x);
  
     /** get - Gets the value of a CIMValue      /** Gets the value of a CIMValue.
   
         Note: Before using get, the caller should use getType () and isNull ()         Note: Before using get, the caller should use getType () and isNull ()
         to ensure that the value is not null, and is of the correct type.         to ensure that the value is not null, and is of the correct type.
         If the CIMValue is null, the output parameter is not updated.  
   
         @param Variable in which we return the value  
  
           @param Variable in which to return the value.
         @exception TypeMismatchException If the CIMValue type is not compatible         @exception TypeMismatchException If the CIMValue type is not compatible
                    with the type of the output parameter                     with the type of the output parameter.
                 <pre>                 <pre>
                 Uint32 v;                 Uint32 v;
                 CIMValue value(CIMValue::UINT32, UINT32(99));                 CIMValue value(CIMValue::UINT32, UINT32(99));
Line 391 
Line 366 
     ///     ///
     void get(Array<CIMObjectPath>& x) const;     void get(Array<CIMObjectPath>& x) const;
  
     /** Compare with another CIMValue object for equality.      /** Compares with another CIMValue object for equality.
         @param x - CIMValue to compare with          @param x - CIMValue to compare with.
         @return True if they are identical in type, attribute and value.          @return true if they are identical in type, attribute and value,
           false otherwise.
     */     */
     Boolean equal(const CIMValue& x) const;     Boolean equal(const CIMValue& x) const;
  
     /** toString - Converts the CIMvalue to a string.  Should only be      /** Converts the CIMvalue to a string.  Should only be
             used for output purposes.  To get an actual String value, use             used for output purposes.  To get an actual String value, use
             get(String &).             get(String &).
         @return - String output for CIMValue.          @return  String output for CIMValue.
         <PRE>         <PRE>
         Example:  
             String test;             String test;
             CIMValue value(Boolean(true));             CIMValue value(Boolean(true));
             test = value.toString();  // puts "TRUE" into test             test = value.toString();  // puts "TRUE" into test
Line 412 
Line 387 
  
 private: private:
  
     // ATTN-RK-P2-20020719: For debugging only; remove before API release.  
     // Use CIMValue(const String&) instead.  
     PEGASUS_EXPLICIT CIMValue(const char* x) {}  
   
     CIMValueRep* _rep;     CIMValueRep* _rep;
  
     friend class CIMMethodRep;     friend class CIMMethodRep;
Line 423 
Line 394 
     friend class CIMPropertyRep;     friend class CIMPropertyRep;
     friend class CIMQualifierRep;     friend class CIMQualifierRep;
     friend class CIMQualifierDeclRep;     friend class CIMQualifierDeclRep;
       friend class BinaryStreamer;
 }; };
  
 /** operator == compares two CIMValue objects for equality. /** operator == compares two CIMValue objects for equality.
         @param x - First CIMValue to compare         @param x - First CIMValue to compare
         @param y - Second CIMValue to compare         @param y - Second CIMValue to compare
         @return True if they are identical in type, attribute and value.      @return true if they are identical in type, attribute and value,
       false otherwise.
 */ */
 PEGASUS_COMMON_LINKAGE Boolean operator==(const CIMValue& x, const CIMValue& y); PEGASUS_COMMON_LINKAGE Boolean operator==(const CIMValue& x, const CIMValue& y);
  
 /** operator != compares two CIMValue objects for inequality  /** operator != compares two CIMValue objects for inequality.
       @param x - First CIMValue to compare
       @param y - Second CIMValue to compare
       @return true if they are NOT identical in type, attribute or value,
       false otherwise.
 */ */
 PEGASUS_COMMON_LINKAGE Boolean operator!=(const CIMValue& x, const CIMValue& y); PEGASUS_COMMON_LINKAGE Boolean operator!=(const CIMValue& x, const CIMValue& y);
  

Legend:
Removed from v.1.32  
changed lines
  Added in v.1.39
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2