pegasus/src/Pegasus/Common/CIMScope.h - diff

Return to CIMScope.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/CIMScope.h between version 1.1 and 1.13

version 1.1, 2001/02/18 18:39:06

version 1.13, 2002/08/05 16:14:41

Line 1

//BEGIN_LICENSE

//%/////////////////////////////////////////////////////////////////////////////

// The Open Group, Tivoli Systems

// Permission is hereby granted, free of charge, to any person obtaining a

// Permission is hereby granted, free of charge, to any person obtaining a copy

// copy of this software and associated documentation files (the "Software"),

// of this software and associated documentation files (the "Software"), to

// to deal in the Software without restriction, including without limitation

// deal in the Software without restriction, including without limitation the

// the rights to use, copy, modify, merge, publish, distribute, sublicense,

// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

// and/or sell copies of the Software, and to permit persons to whom the

// sell copies of the Software, and to permit persons to whom the Software is

// Software is furnished to do so, subject to the following conditions:

// 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.

// 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.

//END_LICENSE

// Author: Mike Brasher (mbrasher@bmc.com)

//BEGIN_HISTORY

// Author:

// Modified By: Carol Ann Krug Graves, Hewlett-Packard Company

// (carolann_graves@hp.com)

// $Log$

//%/////////////////////////////////////////////////////////////////////////////

// Revision 1.1 2001/02/18 18:39:06 mike

// new

// Revision 1.1 2001/02/16 02:07:06 mike

// Renamed many classes and headers (using new CIM prefixes).

// Revision 1.2 2001/01/30 23:39:00 karl

// Add doc++ Documentation to header files

// Revision 1.1.1.1 2001/01/14 19:53:12 mike

// Pegasus import

//END_HISTORY

CIMScope.h This file declares qualifier scope constants.

#ifndef Pegasus_Scope_h

#define Pegasus_Scope_h

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Array.h>

#include <Pegasus/Common/String.h>

#include <Pegasus/Common/Linkage.h>

PEGASUS_NAMESPACE_BEGIN

/**

The CIMQualifier Scopes are as follows:

The CIMScope class implements the concept of the scope of a CIM qualifier

NONE, Class, ASSOCIATION,INDICATION,PROPERTY, REFERENCE, METHOD, PARAMETER, ANY

object. The scope of a qualifier defines the set of types of CIM objects

with which the qualifier may be used. The possible values are:

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.

namespace CIMScope

class PEGASUS_COMMON_LINKAGE CIMScope

{

PEGASUS_COMMON_LINKAGE extern const Uint32 NONE;

public:

PEGASUS_COMMON_LINKAGE extern const Uint32 CLASS;

PEGASUS_COMMON_LINKAGE extern const Uint32 ASSOCIATION;

/**

PEGASUS_COMMON_LINKAGE extern const Uint32 INDICATION;

Constructs a CIMScope object with no value set (default constructor).

PEGASUS_COMMON_LINKAGE extern const Uint32 PROPERTY;

PEGASUS_COMMON_LINKAGE extern const Uint32 REFERENCE;

CIMScope ();

PEGASUS_COMMON_LINKAGE extern const Uint32 METHOD;

PEGASUS_COMMON_LINKAGE extern const Uint32 PARAMETER;

/**

PEGASUS_COMMON_LINKAGE extern const Uint32 ANY;

Constructs a CIMScope object from an existing CIMScope object (copy

}

constructor).

@param scope another CIMScope object

CIMScope (const CIMScope & scope);

/**

Constructs a CIMScope object with the specified value.

@param scope a Uint32 scope value

@exception InvalidScope if the scope value is invalid

CIMScope (const Uint32 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 scope is included in the

CIMScope object.

@param scope a scope value

@return True if every value in the scope is included in the CIMScope

object,

False otherwise

Boolean hasScope (const Uint32 scope) const;

/**

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 Uint32 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;

/**

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 Uint32 NONE;

/**

Indicates that the qualifier may be used with classes

static const Uint32 CLASS;

/**

Indicates that the qualifier may be used with associations

static const Uint32 ASSOCIATION;

/**

Indicates that the qualifier may be used with indications

static const Uint32 INDICATION;

/**

Indicates that the qualifier may be used with properties

static const Uint32 PROPERTY;

/**

Indicates that the qualifier may be used with references

static const Uint32 REFERENCE;

/**

Indicates that the qualifier may be used with methods

static const Uint32 METHOD;

/**

Indicates that the qualifier may be used with parameters

static const Uint32 PARAMETER;

/**

Indicates that the qualifier may be used with any of the types

of objects (classes, associations, indications, properties, references,

methods, parameters)

static const Uint32 ANY;

PEGASUS_COMMON_LINKAGE String ScopeToString(Uint32 scope);

private:

PEGASUS_COMMON_LINKAGE void ScopeToXml(Array<Sint8>& out, Uint32 scope);

Uint32 cimScope;

};

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.1
changed lines
	Added in v.1.13

No CVS admin address has been configured