version 1.16, 2002/08/14 21:09:00
|
version 1.23, 2004/10/17 20:39:16
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%2004//////////////////////////////////////////////////////////////////////// |
// | // |
// 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. |
|
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation; VERITAS Software 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 |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// 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_Flavor_h | #ifndef Pegasus_Flavor_h |
|
|
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 |
|
|
| |
/** | /** |
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 (); |
| |
|
|
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); |
| |
|
|
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); |
| |
|
|
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 set of |
@param flavor Specifies the name of the CIMFlavor object that |
flavor values to remove |
contains the flavor values to remove from the CIMFlavor object. |
*/ | */ |
void removeFlavor (const CIMFlavor & flavor); | void removeFlavor (const CIMFlavor & flavor); |
| |
|
|
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, |
object is included in the CIMFlavor object. Otherwise, a value of |
False otherwise |
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. |
|
|
| |
/** | /** |
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; |
| |
/** | /** |
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; |
| |
/** | /** |
Indicates that the qualifier may not be overridden |
Indicates that the qualifier may not be overridden. |
*/ | */ |
static const CIMFlavor DISABLEOVERRIDE; | static const CIMFlavor DISABLEOVERRIDE; |
| |
/** | /** |
Indicates that the qualifier is propagated to the qualifier in the | Indicates that the qualifier is propagated to the qualifier in the |
subclass with the same name |
subclass with the same name. |
*/ | */ |
static const CIMFlavor TOSUBCLASS; | static const CIMFlavor TOSUBCLASS; |
| |
/** | /** |
Indicates that the qualifier is not propagated to the qualifier in the | 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 | subclass with the same name; it applies only to the class in which it |
is declared |
is declared. |
*/ | */ |
static const CIMFlavor RESTRICTED; | static const CIMFlavor RESTRICTED; |
| |
/** | /** |
Indicates that the qualifier is propagated to the qualifier in the | Indicates that the qualifier is propagated to the qualifier in the |
instance with the same name |
instance with the same name. |
*/ | */ |
static const CIMFlavor TOINSTANCE; | static const CIMFlavor TOINSTANCE; |
| |
/** | /** |
Indicates that the qualifier is translatable (for internationalization) |
Indicates that the qualifier is translatable (for internationalization). |
*/ | */ |
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; |
| |
/** | /** |
Indicates both toSubclass and toInstance (TOSUBCLASS | TOINSTANCE) |
Indicates both toSubclass and toInstance (TOSUBCLASS | TOINSTANCE). |
*/ | */ |
static const CIMFlavor TOSUBELEMENTS; | 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: | 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); |
| |
Uint32 cimFlavor; | Uint32 cimFlavor; |
|
|
|
friend class BinaryStreamer; |
}; | }; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |