version 1.16, 2002/08/14 21:09:00
|
version 1.29, 2008/12/02 09:00:42
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%LICENSE//////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM, |
// Licensed to The Open Group (TOG) under one or more contributor license |
// The Open Group, Tivoli Systems |
// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with |
|
// this work for additional information regarding copyright ownership. |
|
// Each contributor licenses this file to you under the OpenPegasus Open |
|
// Source License; you may not use this file except in compliance with the |
|
// License. |
|
// |
|
// Permission is hereby granted, free of charge, to any person obtaining a |
|
// copy of this software and associated documentation files (the "Software"), |
|
// to deal in the Software without restriction, including without limitation |
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|
// and/or sell copies of the Software, and to permit persons to whom the |
|
// Software is furnished to do so, subject to the following conditions: |
|
// |
|
// The above copyright notice and this permission notice shall be included |
|
// in all copies or substantial portions of the Software. |
|
// |
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
|
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
|
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
|
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
|
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
|
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a copy |
////////////////////////////////////////////////////////////////////////// |
// of this software and associated documentation files (the "Software"), to |
|
// deal in the Software without restriction, including without limitation the |
|
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
|
// sell copies of the Software, and to permit persons to whom the Software is |
|
// furnished to do so, subject to the following conditions: |
|
// |
|
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN |
|
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED |
|
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT |
|
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
|
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
|
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
|
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
|
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
// |
|
//============================================================================== |
|
// |
|
// 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) |
|
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
|
|
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
/** | /** |
The CIMFlavor class implements the concept of the CIM qualifier flavor. |
The CIMFlavor class represents the DMTF standard CIM qualifier flavor |
The qualifier flavor concept encapsulates the propagation and override |
definition, which encapsulates the propagation and override rules for |
rules for the qualifier. The propagation rules define whether a qualifier |
qualifiers. The propagation rules define whether a qualifier may be |
may be propagated from classes to derived classes, or from classes to |
propagated from classes to derived classes or from classes to instances. |
instances. The override rules define whether or not derived classes may |
The override rules define whether a derived class may override a |
override a qualifier value, or whether it must be fixed for an entire |
qualifier value. |
class hierarchy. |
|
|
A CIMFlavor contains one or more of these values: OVERRIDABLE, |
The possible values are: OVERRIDABLE, TOSUBCLASS, TOINSTANCE, |
TOSUBCLASS, TOINSTANCE, TRANSLATABLE, DISABLEOVERRIDE, ENABLEOVERRIDE, |
TRANSLATABLE, DISABLEOVERRIDE, RESTRICTED. |
RESTRICTED and DEFAULTS. |
The flavor is a set of zero or more of these possible values. |
|
*/ | */ |
class PEGASUS_COMMON_LINKAGE CIMFlavor | class PEGASUS_COMMON_LINKAGE CIMFlavor |
{ | { |
public: | public: |
| |
/** | /** |
Constructs a CIMFlavor object with no flavor values set (default |
Constructs a CIMFlavor object with the value NONE. |
constructor). |
|
*/ | */ |
CIMFlavor (); | CIMFlavor (); |
| |
/** | /** |
Constructs a CIMFlavor object from an existing CIMFlavor object (copy |
Constructs a CIMFlavor object from the value of a specified |
constructor). |
CIMFlavor object. |
|
@param flavor The CIMFlavor object from which to construct a new |
@param flavor another CIMFlavor object |
CIMFlavor object. |
*/ | */ |
CIMFlavor (const CIMFlavor & flavor); | CIMFlavor (const CIMFlavor & flavor); |
| |
/** | /** |
Assigns the value of one CIMFlavor object to another (assignment |
Assigns the value of the specified CIMFlavor object to this object. |
operator). |
@param flavor The CIMFlavor object from which to assign this |
|
CIMFlavor object. |
@param flavor a CIMFlavor object |
@return A reference to this CIMFlavor object. |
|
|
@return 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 flavor values to the CIMFlavor object. |
CIMFlavor object. |
@param flavor A CIMFlavor containing the flavor values to add. |
|
|
@param flavor a CIMFlavor object |
|
*/ | */ |
void addFlavor (const CIMFlavor & flavor); | void addFlavor (const CIMFlavor & flavor); |
| |
/** | /** |
Removes the specified set of flavor values from the CIMFlavor object. |
Removes flavor values from the CIMFlavor object. |
|
@param flavor A CIMFlavor containing the flavor values to remove. |
@param flavor a CIMFlavor representing the set of |
|
flavor values to remove |
|
*/ | */ |
void removeFlavor (const CIMFlavor & flavor); | void removeFlavor (const CIMFlavor & flavor); |
| |
/** | /** |
Determines if every value in the specified CIMFlavor object is included |
Checks whether the flavor contains specified flavor values. |
in this CIMFlavor object. |
@param flavor A CIMFlavor specifying the flavor values to check. |
|
@return True if the flavor contains all the values in the specified |
@param flavor a CIMFlavor object |
CIMFlavor object, false otherwise. |
|
|
@return True if every value in the specified CIMFlavor object is |
|
included in the CIMFlavor object, |
|
False otherwise |
|
*/ | */ |
Boolean hasFlavor (const CIMFlavor & flavor) const; | Boolean hasFlavor (const CIMFlavor & flavor) const; |
| |
/** | /** |
Compares two CIMFlavor objects. |
Compares the CIMFlavor with a specified CIMFlavor. |
|
@param flavor The CIMFlavor to be compared. |
@param flavor a CIMFlavor object |
@return True if this flavor has the same set of values as the |
|
specified flavor, false otherwise. |
@return True if the two CIMFlavor objects are equal, |
|
False otherwise |
|
*/ | */ |
Boolean equal (const CIMFlavor & flavor) const; | Boolean equal (const CIMFlavor & flavor) const; |
| |
/** | /** |
Combines two CIMFlavor objects. |
Adds two flavor values. |
|
@param flavor A CIMFlavor containing the flavor value to add to this |
@param flavor a CIMFlavor object to add |
flavor. |
|
@return A new CIMFlavor object containing a union of the values in the |
@return A new CIMFlavor object that represents the combination of this |
two flavor objects. |
flavor with the specified flavor. |
|
*/ | */ |
CIMFlavor operator+ (const CIMFlavor & flavor) const; | CIMFlavor operator+ (const CIMFlavor & flavor) const; |
| |
|
|
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 | This method is for diagnostic purposes. The format of the output |
is subject to change. | is subject to change. |
|
@return A String containing a human-readable representation of the |
|
flavor value. |
*/ | */ |
String toString () const; | String toString () const; |
| |
/** | /** |
Indicates that the qualifier has no flavors |
Indicates that the qualifier has no flavors. |
*/ | */ |
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 enabled for the qualifier. |
|
Thus, the qualifier may be overridden. |
|
*/ |
static const CIMFlavor ENABLEOVERRIDE; | static const CIMFlavor ENABLEOVERRIDE; |
| |
/** | /** |
Indicates that the qualifier may not be overridden |
Indicates that the override feature is disabled for the qualifier. |
|
Thus, 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 subclasses. |
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 subclasses. |
subclass with the same name; it applies only to the class in which it |
|
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 instances. |
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 that the qualifier is propagated to subclasses and to |
|
instances (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 a CIMFlavor object with the specified values. |
|
@param flavor A Uint32 representing the set of flavor values. |
@param flavor a Uint32 representing the set of flavor |
|
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 |