version 1.12, 2002/05/15 20:04:10
|
version 1.24.18.2, 2006/03/07 18:45:45
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%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 |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Mike Brasher (mbrasher@bmc.com) |
|
// |
|
// Modified By: Karl Schopmeyer(k.schopmeyer@opengroup.org) |
|
// Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com) |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#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 |
| |
/** This structure defines flavor constants borne by CIMQualifier objects. |
/** |
|
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 |
{ | { |
/** Indicates that the qualifier has no flavors. |
public: |
|
|
|
/** |
|
Constructs a CIMFlavor object with the value NONE. |
|
*/ |
|
CIMFlavor(); |
|
|
|
/** |
|
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. |
*/ | */ |
static const Uint32 NONE; |
Boolean equal(const CIMFlavor& flavor) const; |
| |
/** Indicates that the qualifier may be overriden. |
/** |
|
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. |
*/ | */ |
static const Uint32 OVERRIDABLE; |
CIMFlavor operator+(const CIMFlavor& flavor) const; |
static const Uint32 ENABLEOVERRIDE; |
|
| |
static const Uint32 DISABLEOVERRIDE; |
/** |
|
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; |
| |
/** Indicates that the qualifier is propagated to the qualifier in the |
/** |
subclass with the same name. |
Indicates that the qualifier has no flavors. |
*/ | */ |
static const Uint32 TOSUBCLASS; |
static const CIMFlavor NONE; |
| |
/* Indicates that the qualifier may not be propagated to the qualifier |
/** |
in a subclass |
Indicates that the qualifier may be overridden. |
*/ | */ |
static const Uint32 RESTRICTED; |
static const CIMFlavor OVERRIDABLE; |
| |
/** Indicates that the qualifier is propagated to the qualifier in the |
/** |
instance with the same name. |
Indicates that the override feature is enabled for the qualifier. |
|
Thus, the qualifier may be overridden. |
*/ | */ |
|
static const CIMFlavor ENABLEOVERRIDE; |
| |
static const Uint32 TOINSTANCE; |
/** |
|
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 whether qualifier is translatable (for internationalization). |
/** |
|
Indicates that the qualifier is not propagated to subclasses. |
*/ | */ |
static const Uint32 TRANSLATABLE; |
static const CIMFlavor RESTRICTED; |
| |
/** Defaults according to the CIM DTD (OVERRIDABLE | TOSUBCLASS). |
/** |
|
Indicates that the qualifier is propagated to instances. |
*/ | */ |
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; |
| |
/** Includes all elements of Flavor.. |
/** |
|
Indicates the default flavor settings (OVERRIDABLE | TOSUBCLASS). |
*/ | */ |
static const Uint32 ALL; |
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 |