(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.8 and 1.24.18.2

version 1.8, 2001/12/13 14:53:49 version 1.24.18.2, 2006/03/07 18:45:45
Line 1 
Line 1 
 //%/////////////////////////////////////////////////////////////////////////////  //%2006////////////////////////////////////////////////////////////////////////
 // //
 // Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM  // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
   // 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.
   // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
   // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
   // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
   // EMC Corporation; VERITAS Software Corporation; The Open Group.
   // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
   // EMC Corporation; Symantec 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 20 
Line 29 
 // //
 //============================================================================== //==============================================================================
 // //
 // Author: Mike Brasher (mbrasher@bmc.com)  
 //  
 // Modified By:  
 //  
 //%///////////////////////////////////////////////////////////////////////////// //%/////////////////////////////////////////////////////////////////////////////
  
 /*  
   
  CIMFlavor.h -- This file declares qualifier flavor constants.  
   
 */  
   
 #ifndef Pegasus_Flavor_h #ifndef Pegasus_Flavor_h
 #define Pegasus_Flavor_h #define Pegasus_Flavor_h
  
 #include <Pegasus/Common/Config.h> #include <Pegasus/Common/Config.h>
 #include <Pegasus/Common/Array.h>  
 #include <Pegasus/Common/String.h> #include <Pegasus/Common/String.h>
   #include <Pegasus/Common/Linkage.h>
  
 PEGASUS_NAMESPACE_BEGIN PEGASUS_NAMESPACE_BEGIN
   
 /** /**
 CIMQualifier flavor constants      The CIMFlavor class represents the DMTF standard CIM qualifier flavor
       definition, which encapsulates the propagation and override rules for
       qualifiers.  The propagation rules define whether a qualifier may be
       propagated from classes to derived classes or from classes to instances.
       The override rules define whether a derived class may override a
       qualifier value.
   
       A CIMFlavor contains one or more of these values: OVERRIDABLE,
       TOSUBCLASS, TOINSTANCE, TRANSLATABLE, DISABLEOVERRIDE, ENABLEOVERRIDE,
       RESTRICTED and DEFAULTS.
 */ */
 struct PEGASUS_COMMON_LINKAGE CIMFlavor  class PEGASUS_COMMON_LINKAGE CIMFlavor
 { {
     static const Uint32 NONE;  public:
     static const Uint32 OVERRIDABLE;  
     static const Uint32 TOSUBCLASS;  
     static const Uint32 TOINSTANCE;  
     static const Uint32 TRANSLATABLE;  
  
     // These are the defaults according to the CIM DTD:      /**
     // OVERRIDABLE, TOSUBCLASS          Constructs a CIMFlavor object with the value NONE.
       */
       CIMFlavor();
  
     static const Uint32 DEFAULTS;      /**
 };          Constructs a CIMFlavor object from the value of a specified
           CIMFlavor object.
           @param flavor The CIMFlavor object from which to construct a new
               CIMFlavor object.
       */
       CIMFlavor(const CIMFlavor & flavor);
   
       /**
           Assigns the value of the specified CIMFlavor object to this object.
           @param scope The CIMFlavor object from which to assign this
               CIMFlavor object.
           @return A reference to this CIMFlavor object.
       */
       CIMFlavor& operator=(const CIMFlavor& flavor);
   
       /**
           Adds flavor values to the CIMFlavor object.
           @param flavor A CIMFlavor containing the flavor values to add.
       */
       void addFlavor(const CIMFlavor& flavor);
   
       /**
           Removes flavor values from the CIMFlavor object.
           @param flavor A CIMFlavor containing the flavor values to remove.
       */
       void removeFlavor(const CIMFlavor& flavor);
   
       /**
           Checks whether the flavor contains specified flavor values.
           @param flavor A CIMFlavor specifying the flavor values to check.
           @return True if the flavor contains all the values in the specified
               CIMFlavor object, false otherwise.
       */
       Boolean hasFlavor(const CIMFlavor& flavor) const;
   
       /**
           Compares the CIMFlavor with a specified CIMFlavor.
           @param flavor The CIMFlavor to be compared.
           @return True if this flavor has the same set of values as the
               specified flavor, false otherwise.
       */
       Boolean equal(const CIMFlavor& flavor) const;
   
       /**
           Adds two flavor values.
           @param flavor A CIMFlavor containing the flavor value to add to this
               flavor.
           @return A new CIMFlavor object containing a union of the values in the
               two flavor objects.
       */
       CIMFlavor operator+(const CIMFlavor& flavor) const;
  
 /** FlavorToMof - Converts the flavor attributes of a qualifier to CIM MOF      /**
     keywords separated by spaces and returns them as a String.          Returns a String representation of the CIMFlavor object.
     @param flavor Variable contianing the flavor mask          This method is for diagnostic purposes. The format of the output
     @return Strin containing the flavor attribute keywords.          is subject to change.
 */          @return A String containing a human-readable representation of the
 PEGASUS_COMMON_LINKAGE String FlavorToMof(Uint32 flavor);              flavor value.
       */
 /** FlavorToXML - converts the flavor attributes of a qualifier to cimxml      String toString() const;
     format and puts them into the variable out.  
     @param out XML output stream into which the xml is places.      /**
     @param flavor variable containing the flavor definition          Indicates that the qualifier has no flavors.
     <pre>      */
     // Get flavorkeywords and test for any returned keywords      static const CIMFlavor NONE;
     Uint32 flavor = CIMFlavor::DEFAULTS,  
     String flavorString;      /**
     flavorString = FlavorToMof(_flavor);          Indicates that the qualifier may be overridden.
     if (flavorString.size())      */
         ...           // code to execute if keywords exist      static const CIMFlavor OVERRIDABLE;
   
     </pre>      /**
 */          Indicates that the override feature is enabled for the qualifier.
 PEGASUS_COMMON_LINKAGE void FlavorToXml(          Thus, the qualifier may be overridden.
     Array<Sint8>& out,      */
     Uint32 flavor);      static const CIMFlavor ENABLEOVERRIDE;
   
       /**
           Indicates that the override feature is disabled for the qualifier.
           Thus, the qualifier may not be overridden.
       */
       static const CIMFlavor DISABLEOVERRIDE;
   
       /**
           Indicates that the qualifier is propagated to subclasses.
       */
       static const CIMFlavor TOSUBCLASS;
   
       /**
           Indicates that the qualifier is not propagated to subclasses.
       */
       static const CIMFlavor RESTRICTED;
   
       /**
           Indicates that the qualifier is propagated to instances.
       */
       static const CIMFlavor TOINSTANCE;
   
       /**
           Indicates that the qualifier is translatable (for
           internationalization).
       */
       static const CIMFlavor TRANSLATABLE;
   
       /**
           Indicates the default flavor settings (OVERRIDABLE | TOSUBCLASS).
       */
       static const CIMFlavor DEFAULTS;
   
       /**
           Indicates that the qualifier is propagated to subclasses and to
           instances (TOSUBCLASS | TOINSTANCE).
       */
       static const CIMFlavor TOSUBELEMENTS;
   
   private:
   
       /*
           Constructs a CIMFlavor object with the specified values.
           @param flavor A Uint32 representing the set of flavor values.
       */
       CIMFlavor(const Uint32 flavor);
   
       Uint32 cimFlavor;
   
       friend class BinaryStreamer;
   };
  
 PEGASUS_NAMESPACE_END PEGASUS_NAMESPACE_END
  

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