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.4 and 1.17

version 1.4, 2001/05/20 20:33:59

version 1.17, 2003/10/22 14:26:02

Line 1

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

//%2003////////////////////////////////////////////////////////////////////////

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

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

// Company, L. P., IBM Corp., The Open Group, Tivoli Systems.

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

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

// IBM Corp.; EMC Corporation, The Open Group.

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

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

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

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

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

// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

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

// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

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

// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

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

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

// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

// DEALINGS IN THE SOFTWARE.

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

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

// (carolann_graves@hp.com)

// Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)

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

Line 29

Line 35

#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,

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

PARAMETER, ANY

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.

struct PEGASUS_COMMON_LINKAGE CIMScope

class PEGASUS_COMMON_LINKAGE CIMScope

{

static const Uint32 NONE;

public:

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;

/** Constructs a CIMScope object from an existing CIMScope object (copy

static const Uint32 PARAMETER;

constructor).

static const Uint32 ANY;

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

<pre>

CimScope s0;

CIMScope s1(s0);

</pre>

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.

<pre>

CIMScope s0;

CIMScope s2;

s0.addScope (CIMScope::INDICATION);

s3 = s0;

</pre>

Boolean hasScope (const CIMScope & scope) const;

/** Adds the specified scope value to the CIMScope object.

@param scope - a scope value.

<pre>

CIMScope s0;

s0.addScope (CIMScope::INDICATION);

if(s0.hasScope (CIMScope::INDICATION))

... ..

</pre>

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.

<pre>

CIMScope s0;

s0.addScope (CIMScope::CLASS + CIMScope::PARAMETER);

if(s0.hasScope (CIMScope::CLASS))

... ..

</pre>

Boolean equal (const CIMScope & scope) const;

PEGASUS_COMMON_LINKAGE String ScopeToString(Uint32 scope);

/** Combines two CIMScope objects.

@param scope - a CIMScope object to add.

@return A new CIMScope object that represents the combination of this

scope object with the specified scope object.

<pre>

CIMScope s0(CIMScope::CLASS);

CIMScope s1(CIMScope::PARAMETER);

CIMScope s3 = s0 + S1;

</pre>

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;

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

/** 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:

///

CIMScope (const Uint32 scope);

Uint32 cimScope;

};

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.4
changed lines
	Added in v.1.17

No CVS admin address has been configured