version 1.14, 2002/08/14 22:32:23
|
version 1.14.2.1, 2002/10/28 15:43:21
|
|
|
// | // |
// Author: Mike Brasher (mbrasher@bmc.com) | // Author: Mike Brasher (mbrasher@bmc.com) |
// | // |
// Modified By: Carol Ann Krug Graves, Hewlett-Packard Company |
// Modified By: |
// (carolann_graves@hp.com) |
|
// Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com) |
|
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
|
|
#define Pegasus_Scope_h | #define Pegasus_Scope_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 |
| |
/** | /** |
The CIMScope class implements the concept of the scope of a CIM qualifier |
The CIMQualifier Scopes are as follows: |
object. The scope of a qualifier defines the set of types of CIM objects |
NONE, Class, ASSOCIATION,INDICATION,PROPERTY, REFERENCE, METHOD, |
with which the qualifier may be used. The possible values are: |
PARAMETER, ANY |
NONE, CLASS, ASSOCIATION, INDICATION, PROPERTY, REFERENCE, METHOD, |
|
PARAMETER, ANY. |
|
The scope is a set of one or more of these possible values. |
|
The value "NONE" implies a CIMScope object that has not yet been assigned a |
|
value (uninitialized). It is not a valid value for the scope of a |
|
qualifier object. |
|
The value "ANY" means that the qualifier may be used with any of the CIM |
|
object types, and is equivalent to listing each of the object types in the |
|
scope. |
|
*/ | */ |
class PEGASUS_COMMON_LINKAGE CIMScope |
struct PEGASUS_COMMON_LINKAGE CIMScope |
{ | { |
public: |
static const Uint32 NONE; |
|
static const Uint32 CLASS; |
/** |
static const Uint32 ASSOCIATION; |
Constructs a CIMScope object with no value set (default constructor). |
static const Uint32 INDICATION; |
*/ |
static const Uint32 PROPERTY; |
CIMScope (); |
static const Uint32 REFERENCE; |
|
static const Uint32 METHOD; |
/** |
static const Uint32 PARAMETER; |
Constructs a CIMScope object from an existing CIMScope object (copy |
static const Uint32 ANY; |
constructor). |
|
|
|
@param scope another CIMScope object |
|
*/ |
|
CIMScope (const CIMScope & scope); |
|
|
|
/** |
|
Assigns the value of one CIMScope object to another (assignment |
|
operator). |
|
|
|
@param scope a CIMScope object |
|
|
|
@return the CIMScope object |
|
*/ |
|
CIMScope & operator= (const CIMScope & scope); |
|
|
|
/** |
|
Determines if every value in the specified CIMScope object is included |
|
in this CIMScope object. |
|
|
|
@param scope a CIMScope object |
|
|
|
@return True if every value in the specified CIMScope object is |
|
included in the CIMScope object, |
|
False otherwise |
|
*/ |
|
Boolean hasScope (const CIMScope & scope) const; |
|
|
|
/** |
|
Adds the specified scope value to the CIMScope object. |
|
|
|
@param scope a scope value |
|
|
|
@exception InvalidScope if the scope value is invalid |
|
*/ |
|
void addScope (const CIMScope & scope); |
|
|
|
/** |
|
Compares two CIMScope objects. |
|
|
|
@param scope a CIMScope object |
|
|
|
@return True if the two CIMScope objects are equal, |
|
False otherwise |
|
*/ |
|
Boolean equal (const CIMScope & scope) const; |
|
|
|
/** |
|
Combines two CIMScope objects. |
|
|
|
@param scope a CIMScope object to add |
|
|
|
@return A new CIMScope object that represents the combination of this |
|
scope with the specified scope. |
|
*/ |
|
CIMScope operator+ (const CIMScope & scope) const; |
|
|
|
/** |
|
Returns a String representation of the CIMScope object. |
|
This method is for diagnostic purposes. The format of the output |
|
is subject to change. |
|
*/ |
|
String toString () const; |
|
|
|
/** |
|
Indicates that the CIMScope object has no value (is uninitialized) |
|
*/ |
|
static const CIMScope NONE; |
|
|
|
/** |
|
Indicates that the qualifier may be used with classes |
|
*/ |
|
static const CIMScope CLASS; |
|
|
|
/** |
|
Indicates that the qualifier may be used with associations |
|
*/ |
|
static const CIMScope ASSOCIATION; |
|
|
|
/** |
|
Indicates that the qualifier may be used with indications |
|
*/ |
|
static const CIMScope INDICATION; |
|
|
|
/** |
|
Indicates that the qualifier may be used with properties |
|
*/ |
|
static const CIMScope PROPERTY; |
|
|
|
/** |
|
Indicates that the qualifier may be used with references |
|
*/ |
|
static const CIMScope REFERENCE; |
|
|
|
/** |
|
Indicates that the qualifier may be used with methods |
|
*/ |
|
static const CIMScope METHOD; |
|
|
|
/** |
|
Indicates that the qualifier may be used with parameters |
|
*/ |
|
static const CIMScope PARAMETER; |
|
|
|
/** |
|
Indicates that the qualifier may be used with any of the types |
|
of objects (classes, associations, indications, properties, references, |
|
methods, parameters) |
|
*/ |
|
static const CIMScope ANY; |
|
|
|
private: |
|
|
|
/** |
|
Constructs a CIMScope object with the specified value. |
|
|
|
@param scope a Uint32 scope value to initialize with |
|
*/ |
|
CIMScope (const Uint32 scope); |
|
|
|
Uint32 cimScope; |
|
}; | }; |
| |
|
/** The behavior of this method is undefined and is subject to change */ |
|
PEGASUS_COMMON_LINKAGE String ScopeToString(Uint32 scope); |
|
|
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
| |
#endif /* Pegasus_Scope_h */ | #endif /* Pegasus_Scope_h */ |