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

Diff for /pegasus/src/Pegasus/Common/CIMFlavor.h between version 1.19 and 1.20

version 1.19, 2003/10/22 14:26:02 version 1.20, 2003/10/27 19:48:06
Line 42 
Line 42 
 PEGASUS_NAMESPACE_BEGIN PEGASUS_NAMESPACE_BEGIN
  
 /** /**
     The CIMFlavor class implements the concept of the CIM qualifier flavor.      The CIMFlavor class implements the concept of the CIM qualifier flavor that
     The qualifier flavor concept encapsulates the propagation and override      encapsulates the propagation and override rules for qualifiers.
     rules for the qualifier.  The propagation rules define whether a qualifier      The propagation rules define whether a qualifier
     may be propagated from classes to derived classes, or from classes to     may be propagated from classes to derived classes, or from classes to
     instances.  The override rules define whether or not derived classes may     instances.  The override rules define whether or not derived classes may
     override a qualifier value, or whether it must be fixed for an entire      override a qualifier value or whether it must be fixed for an entire
     class hierarchy.     class hierarchy.
  
     The possible values are: OVERRIDABLE, TOSUBCLASS, TOINSTANCE,     The possible values are: OVERRIDABLE, TOSUBCLASS, TOINSTANCE,
     TRANSLATABLE, DISABLEOVERRIDE, RESTRICTED.      TRANSLATABLE, DISABLEOVERRIDE, ENABLEOVERRID, RESTRICTED and DEFAULTS.
     The flavor is a set of zero or more of these possible values.     The flavor is a set of zero or more of these possible values.
  */  */
 class PEGASUS_COMMON_LINKAGE CIMFlavor class PEGASUS_COMMON_LINKAGE CIMFlavor
Line 60 
Line 60 
  
     /**     /**
         Constructs a CIMFlavor object with no flavor values set (default         Constructs a CIMFlavor object with no flavor values set (default
         constructor).          constructor). The parameters and values are null.
      */      */
     CIMFlavor ();     CIMFlavor ();
  
Line 68 
Line 68 
         Constructs a CIMFlavor object from an existing CIMFlavor object (copy         Constructs a CIMFlavor object from an existing CIMFlavor object (copy
         constructor).         constructor).
  
         @param   flavor  another CIMFlavor object.          @param   flavor  Specifies the name of the CIMFlavor instance of
           the CIMFlavor object.
      */      */
     CIMFlavor (const CIMFlavor & flavor);     CIMFlavor (const CIMFlavor & flavor);
  
Line 76 
Line 77 
         Assigns the value of one CIMFlavor object to another (assignment         Assigns the value of one CIMFlavor object to another (assignment
         operator).         operator).
  
         @param   flavor   a CIMFlavor object.          @param   flavor   Specifies the name of the CIMFlavor instance of
           the CIMFlavor object.
  
         @return  the CIMFlavor object          @return  The new instance of the CIMFlavor object.
      */      */
     CIMFlavor & operator= (const CIMFlavor & flavor);     CIMFlavor & operator= (const CIMFlavor & flavor);
  
Line 86 
Line 88 
         Adds the set of flavor values of the specified CIMFlavor object to this         Adds the set of flavor values of the specified CIMFlavor object to this
         CIMFlavor object.         CIMFlavor object.
  
         @param   flavor  a CIMFlavor object.          @param   flavor  Specifies the name of the CIMFlavor object that
           contains the flavor values to add to the CIMFlavor object.
      */      */
     void addFlavor (const CIMFlavor & flavor);     void addFlavor (const CIMFlavor & flavor);
  
     /**     /**
         Removes the specified set of flavor values from the CIMFlavor object.         Removes the specified set of flavor values from the CIMFlavor object.
  
         @param   flavor   a CIMFlavor representing the flavor          @param   flavor   Specifies the name of the CIMFlavor object that
                           values to be removed.          contains the flavor values to remove from the CIMFlavor object.
      */      */
     void removeFlavor (const CIMFlavor & flavor);     void removeFlavor (const CIMFlavor & flavor);
  
Line 102 
Line 105 
         Determines if every value in the specified CIMFlavor object is included         Determines if every value in the specified CIMFlavor object is included
         in this CIMFlavor object.         in this CIMFlavor object.
  
         @param   flavor  a CIMFlavor object.          @param   flavor  Specifies the name of the CIMFlavor instance whose
           values you want to compare to the CIMFlavor object.
  
         @return  true if every value in the specified CIMFlavor object is          @return  True if every value in the specified instance of the CIMFlavor
                  included in the CIMFlavor object, false otherwise.          object is included in the CIMFlavor object.  Otherwise, a value of
           false is returned.
      */      */
     Boolean hasFlavor (const CIMFlavor & flavor) const;     Boolean hasFlavor (const CIMFlavor & flavor) const;
  
     /**     /**
         Compares two CIMFlavor objects.          Compares two CIMFlavor objects and determines whether or not they are equal.
  
         @param   flavor  a CIMFlavor object.          @param   flavor  Specifies the name of the CIMFlavor instance that you want
           to compare to the CIMFlavor object.
  
         @return true if the two CIMFlavor objects are equal,          @return True if the two CIMFlavor objects are equal.  Otherwise, a value
                 false otherwise.          of false is returned.
      */      */
     Boolean equal (const CIMFlavor & flavor) const;     Boolean equal (const CIMFlavor & flavor) const;
  
     /**     /**
         Combines two CIMFlavor objects.          Combines two CIMFlavor objects. The parameters and values of the specified
           CIMFlavor instance are included (added) to the CIMFlavor object.
  
         @param   flavor   a CIMFlavor object to add.          @param   flavor   Specifies the name of the CIMFlavor instance to add to the
           CIMFlavor object.
  
         @return A new CIMFlavor object that represents the combination of this         @return A new CIMFlavor object that represents the combination of this
                 flavor with the specified flavor.                 flavor with the specified flavor.
Line 131 
Line 139 
  
     /**     /**
         Returns a String representation of the CIMFlavor object.         Returns a String representation of the CIMFlavor object.
         This method is for diagnostic purposes.  The format of the output          Use this method to aide in debugging problems.  Depending on the implementation,
         is subject to change.          the string format may vary.  The returned value cannot be null but may be empty.
      */      */
     String toString () const;     String toString () const;
  
     /**     /**
         Indicates that the qualifier has no flavors.          Indicates that the qualifier has no flavors. Thus, the qualifier does not have
            any parameters nor values.
      */      */
     static const CIMFlavor NONE;     static const CIMFlavor NONE;
  
Line 145 
Line 154 
         Indicates that the qualifier may be overridden.         Indicates that the qualifier may be overridden.
      */      */
     static const CIMFlavor OVERRIDABLE;     static const CIMFlavor OVERRIDABLE;
       /**
           Indicates that the override feature is enable for the qualifier. Thus, the
           qualifier can be overridden.
        */
     static const CIMFlavor ENABLEOVERRIDE;     static const CIMFlavor ENABLEOVERRIDE;
  
     /**     /**
Line 177 
Line 190 
     static const CIMFlavor TRANSLATABLE;     static const CIMFlavor TRANSLATABLE;
  
     /**     /**
         Indicates default flavor setting (OVERRIDABLE | TOSUBCLASS).          Indicates the default flavor settings. (OVERRIDABLE | TOSUBCLASS).
      */      */
     static const CIMFlavor DEFAULTS;     static const CIMFlavor DEFAULTS;
  
Line 188 
Line 201 
  
 private: private:
  
     /**      /*
         Constructs a CIMFlavor object with the specified set of values.          Constructs an instance of the CIMFlavor object with the specified set of values.
  
         @param   flavor    a Uint32 representing the set of flavor          @param   flavor    A Uint32 representing the set of flavor
                            values to initialize with.                            values to initialize with.
      */      */
     CIMFlavor (const Uint32 flavor);     CIMFlavor (const Uint32 flavor);

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