|
version 1.14, 2002/07/26 20:01:19
|
version 1.16, 2002/08/14 21:09:00
|
|
|
|
| // | // |
| // Modified By: Karl Schopmeyer(k.schopmeyer@opengroup.org) | // Modified By: Karl Schopmeyer(k.schopmeyer@opengroup.org) |
| // Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com) | // Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com) |
| |
// Carol Ann Krug Graves, Hewlett-Packard Company |
| |
// (carolann_graves@hp.com) |
| // | // |
| //%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| | |
|
|
|
| #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> | #include <Pegasus/Common/Linkage.h> |
| | |
| PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| | |
| /** This structure defines flavor constants borne by CIMQualifier objects. |
/** |
| |
The CIMFlavor class implements the concept of the CIM qualifier flavor. |
| |
The qualifier flavor concept encapsulates the propagation and override |
| |
rules for the qualifier. 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 or not derived classes may |
| |
override a qualifier value, or whether it must be fixed for an entire |
| |
class hierarchy. |
| |
|
| |
The possible values are: OVERRIDABLE, TOSUBCLASS, TOINSTANCE, |
| |
TRANSLATABLE, DISABLEOVERRIDE, RESTRICTED. |
| |
The flavor is a set of zero or more of these possible values. |
| */ | */ |
| struct PEGASUS_COMMON_LINKAGE CIMFlavor |
class PEGASUS_COMMON_LINKAGE CIMFlavor |
| { | { |
| /** Indicates that the qualifier has no flavors. |
public: |
| |
|
| |
/** |
| |
Constructs a CIMFlavor object with no flavor values set (default |
| |
constructor). |
| |
*/ |
| |
CIMFlavor (); |
| |
|
| |
/** |
| |
Constructs a CIMFlavor object from an existing CIMFlavor object (copy |
| |
constructor). |
| |
|
| |
@param flavor another CIMFlavor object |
| |
*/ |
| |
CIMFlavor (const CIMFlavor & flavor); |
| |
|
| |
/** |
| |
Assigns the value of one CIMFlavor object to another (assignment |
| |
operator). |
| |
|
| |
@param flavor a CIMFlavor object |
| |
|
| |
@return the CIMFlavor object |
| |
*/ |
| |
CIMFlavor & operator= (const CIMFlavor & flavor); |
| |
|
| |
/** |
| |
Adds the set of flavor values of the specified CIMFlavor object to this |
| |
CIMFlavor object. |
| |
|
| |
@param flavor a CIMFlavor object |
| |
*/ |
| |
void addFlavor (const CIMFlavor & flavor); |
| |
|
| |
/** |
| |
Removes the specified set of flavor values from the CIMFlavor object. |
| |
|
| |
@param flavor a CIMFlavor representing the set of |
| |
flavor values to remove |
| |
*/ |
| |
void removeFlavor (const CIMFlavor & flavor); |
| |
|
| |
/** |
| |
Determines if every value in the specified CIMFlavor object is included |
| |
in this CIMFlavor object. |
| |
|
| |
@param flavor a CIMFlavor object |
| |
|
| |
@return True if every value in the specified CIMFlavor object is |
| |
included in the CIMFlavor object, |
| |
False otherwise |
| */ | */ |
| static const Uint32 NONE; |
Boolean hasFlavor (const CIMFlavor & flavor) const; |
| |
|
| |
/** |
| |
Compares two CIMFlavor objects. |
| |
|
| |
@param flavor a CIMFlavor object |
| | |
| /** Indicates that the qualifier may be overriden. |
@return True if the two CIMFlavor objects are equal, |
| |
False otherwise |
| */ | */ |
| static const Uint32 OVERRIDABLE; |
Boolean equal (const CIMFlavor & flavor) const; |
| static const Uint32 ENABLEOVERRIDE; |
|
| | |
| static const Uint32 DISABLEOVERRIDE; |
/** |
| |
Combines two CIMFlavor objects. |
| | |
| /** Indicates that the qualifier is propagated to the qualifier in the |
@param flavor a CIMFlavor object to add |
| subclass with the same name. |
|
| |
@return A new CIMFlavor object that represents the combination of this |
| |
flavor with the specified flavor. |
| */ | */ |
| static const Uint32 TOSUBCLASS; |
CIMFlavor operator+ (const CIMFlavor & flavor) const; |
| | |
| /* Indicates that the qualifier may not be propagated to the qualifier |
/** |
| in a subclass |
Returns a String representation of the CIMFlavor object. |
| |
This method is for diagnostic purposes. The format of the output |
| |
is subject to change. |
| */ | */ |
| static const Uint32 RESTRICTED; |
String toString () const; |
| | |
| /** Indicates that the qualifier is propagated to the qualifier in the |
/** |
| instance with the same name. |
Indicates that the qualifier has no flavors |
| */ | */ |
| |
static const CIMFlavor NONE; |
| | |
| static const Uint32 TOINSTANCE; |
/** |
| |
Indicates that the qualifier may be overridden |
| |
*/ |
| |
static const CIMFlavor OVERRIDABLE; |
| |
static const CIMFlavor ENABLEOVERRIDE; |
| |
|
| |
/** |
| |
Indicates that the qualifier may not be overridden |
| |
*/ |
| |
static const CIMFlavor DISABLEOVERRIDE; |
| |
|
| |
/** |
| |
Indicates that the qualifier is propagated to the qualifier in the |
| |
subclass with the same name |
| |
*/ |
| |
static const CIMFlavor TOSUBCLASS; |
| | |
| /** Indicates whether qualifier is translatable (for internationalization). |
/** |
| |
Indicates that the qualifier is not propagated to the qualifier in the |
| |
subclass with the same name; it applies only to the class in which it |
| |
is declared |
| */ | */ |
| static const Uint32 TRANSLATABLE; |
static const CIMFlavor RESTRICTED; |
| | |
| /** Defaults according to the CIM DTD (OVERRIDABLE | TOSUBCLASS). |
/** |
| |
Indicates that the qualifier is propagated to the qualifier in the |
| |
instance with the same name |
| */ | */ |
| static const Uint32 DEFAULTS; |
static const CIMFlavor TOINSTANCE; |
| | |
| /** Set both toInstance and toinstance according to the CIM DTD (OVERRIDABLE | TOSUBCLASS). |
/** |
| |
Indicates that the qualifier is translatable (for internationalization) |
| */ | */ |
| static const Uint32 TOSUBELEMENTS; |
static const CIMFlavor TRANSLATABLE; |
| |
|
| |
/** |
| |
Indicates default flavor setting (OVERRIDABLE | TOSUBCLASS) |
| |
*/ |
| |
static const CIMFlavor DEFAULTS; |
| |
|
| |
/** |
| |
Indicates both toSubclass and toInstance (TOSUBCLASS | TOINSTANCE) |
| |
*/ |
| |
static const CIMFlavor TOSUBELEMENTS; |
| |
|
| |
/** |
| |
Indicates the set of all possible flavor values: OVERRIDABLE, |
| |
TOSUBCLASS, TOINSTANCE, TRANSLATABLE, DISABLEOVERRIDE, RESTRICTED |
| |
Note that some of these possible values are mutually exclusive, and |
| |
thus CIMFlavor:ALL does not represent a valid qualifier flavor object |
| |
It may be used, for example, to clear the flavor settings |
| |
*/ |
| |
static const CIMFlavor ALL; |
| |
|
| |
private: |
| |
|
| |
/** |
| |
Constructs a CIMFlavor object with the specified set of values. |
| | |
| /** Includes all elements of Flavor.. |
@param flavor a Uint32 representing the set of flavor |
| |
values to initialize with |
| */ | */ |
| static const Uint32 ALL; |
CIMFlavor (const Uint32 flavor); |
| | |
| |
Uint32 cimFlavor; |
| }; | }; |
| | |
| PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
Return to
CIMFlavor.h
CVS log
Up to [Pegasus] / pegasus / src / Pegasus / Common