version 1.8, 2001/12/13 14:53:49
|
version 1.30.2.2, 2009/07/20 10:41:43
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%LICENSE//////////////////////////////////////////////////////////////// |
// |
|
// Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM |
|
// |
|
// 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. |
|
// | // |
//============================================================================== |
// Licensed to The Open Group (TOG) under one or more contributor license |
|
// 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. |
// | // |
// 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 flavor 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; |
|
|
|
/** |
|
Returns a String representation of the CIMFlavor object. |
|
This method is for diagnostic purposes. The format of the output |
|
is subject to change. |
|
@return A String containing a human-readable representation of the |
|
flavor value. |
|
*/ |
|
String toString() const; |
| |
/** FlavorToMof - Converts the flavor attributes of a qualifier to CIM MOF |
/** |
keywords separated by spaces and returns them as a String. |
Indicates that the qualifier has no flavors. |
@param flavor Variable contianing the flavor mask |
*/ |
@return Strin containing the flavor attribute keywords. |
static const CIMFlavor NONE; |
*/ |
|
PEGASUS_COMMON_LINKAGE String FlavorToMof(Uint32 flavor); |
/** |
|
Indicates that the qualifier may be overridden. |
/** FlavorToXML - converts the flavor attributes of a qualifier to cimxml |
*/ |
format and puts them into the variable out. |
static const CIMFlavor OVERRIDABLE; |
@param out XML output stream into which the xml is places. |
|
@param flavor variable containing the flavor definition |
/** |
<pre> |
Indicates that the override feature is enabled for the qualifier. |
// Get flavorkeywords and test for any returned keywords |
Thus, the qualifier may be overridden. |
Uint32 flavor = CIMFlavor::DEFAULTS, |
*/ |
String flavorString; |
static const CIMFlavor ENABLEOVERRIDE; |
flavorString = FlavorToMof(_flavor); |
|
if (flavorString.size()) |
/** |
... // code to execute if keywords exist |
Indicates that the override feature is disabled for the qualifier. |
|
Thus, the qualifier may not be overridden. |
</pre> |
*/ |
*/ |
static const CIMFlavor DISABLEOVERRIDE; |
PEGASUS_COMMON_LINKAGE void FlavorToXml( |
|
Array<Sint8>& out, |
/** |
Uint32 flavor); |
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. |
|
NOTE: This flavor is deprecated and should not be used. |
|
*/ |
|
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. This |
|
flavor is equivalent to TOSUBCLASSES. The TOINSTANCE flavor is no |
|
longer included here since it is deprecated. |
|
*/ |
|
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; |
|
friend class SCMOClass; |
|
friend class SCMODump; |
|
}; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
| |