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

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

version 1.23, 2006/01/30 16:16:47

Line 1

//BEGIN_LICENSE

//%2006////////////////////////////////////////////////////////////////////////

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

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

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; Symantec Corporation; The Open Group.

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

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

//BEGIN_HISTORY

// Author:

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

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

PEGASUS_COMMON_LINKAGE extern const Uint32 INDICATION;

The values are null.

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;

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

PEGASUS_COMMON_LINKAGE extern const Uint32 ANY;

constructor).

}

@param scope Specifies an instance of CIMScope object.

CIMScope (const CIMScope & scope);

/** Assigns the value of one CIMScope object to another (assignment

operator).

@param scope Specifies the name of a CIMScope object that contains

the values that you want to assign to another CIMScope object.

@return The CIMScope object with the values of the specified CIMScope

object. For example:

<pre>

CIMScope s0;

CIMScope s1(s0);

</pre>

The values in CIMScope s0 are assigned to the CIMScope s1 instance.

CIMScope & operator= (const CIMScope & scope);

/** Determines if every value in the specified CIMScope object is included

in this CIMScope object.

@param scope - Specifies a name of a CIMScope object.

@return True if every value in the specified CIMScope object is

included in the CIMScope object; otherwise, false.

Boolean hasScope (const CIMScope & scope) const;

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

@param scope - Specifies a scope value. For example:

<pre>

CIMScope s0;

s0.addScope (CIMScope::INDICATION);

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

... ..

</pre>

void addScope (const CIMScope & scope);

PEGASUS_COMMON_LINKAGE String ScopeToString(Uint32 scope);

/** Compares two CIMScope objects.

@param scope - Specifies a CIMScope object.

@return True if the two CIMScope objects are equal; otherwise, false.

For example,

<pre>

CIMScope s0;

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

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

... ..

</pre>

Boolean equal (const CIMScope & scope) const;

/** Combines two CIMScope objects.

@param scope - Specifies 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;

/** 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);

// Private member for storing he CIMScope

Uint32 cimScope;

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

friend class BinaryStreamer;

};

PEGASUS_NAMESPACE_END

Legend:

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

No CVS admin address has been configured