CIMScope Class Reference

#include <CIMScope.h>

List of all members.

Public Member Functions

 CIMScope ()
 CIMScope (const CIMScope &scope)
CIMScopeoperator= (const CIMScope &scope)
Boolean hasScope (const CIMScope &scope) const
void addScope (const CIMScope &scope)
Boolean equal (const CIMScope &scope) const
CIMScope operator+ (const CIMScope &scope) const
String toString () const

Static Public Attributes

static const CIMScope NONE
static const CIMScope CLASS
static const CIMScope ASSOCIATION
static const CIMScope INDICATION
static const CIMScope PROPERTY
static const CIMScope REFERENCE
static const CIMScope METHOD
static const CIMScope PARAMETER
static const CIMScope ANY

Detailed Description

The CIMScope class represents the DMTF standard CIM qualifier scope definition. The scope of a qualifier defines the types of CIM objects with which the qualifier may be used. A CIMScope contains zero or more of these values: CLASS, ASSOCIATION, INDICATION, PROPERTY, REFERENCE, METHOD, PARAMETER.


Constructor & Destructor Documentation

CIMScope::CIMScope (  ) 

Constructs a CIMScope object with the value NONE.

CIMScope::CIMScope ( const CIMScope scope  ) 

Constructs a CIMScope object from the value of a specified CIMScope object.

Parameters:
scope The CIMScope object from which to construct a new CIMScope object.

Member Function Documentation

void CIMScope::addScope ( const CIMScope scope  ) 

Adds scopes value to the CIMScope object.

Example:

            CIMScope s;
            s.addScope(CIMScope::INDICATION);
            assert(s.hasScope(CIMScope::INDICATION));
        
Parameters:
scope A CIMScope containing the scope values to add.
Boolean CIMScope::equal ( const CIMScope scope  )  const

Compares the CIMScope with a specified CIMScope.

Parameters:
scope The CIMScope to be compared.
Returns:
True if this scope has the same set of values as the specified scope, false otherwise.
Boolean CIMScope::hasScope ( const CIMScope scope  )  const

Checks whether the scope contains specified scope values.

Parameters:
scope A CIMScope specifying the scope values to check.
Returns:
True if the scope contains all the values in the specified CIMScope object, false otherwise.
CIMScope CIMScope::operator+ ( const CIMScope scope  )  const

Adds two scope values.

Example:

            CIMScope s0(CIMScope::CLASS);
            CIMScope s1(CIMScope::PARAMETER);
            CIMScope s3 = s0 + S1;
        
Parameters:
scope A CIMScope containing the scope value to add to this scope.
Returns:
A new CIMScope object containing a union of the values in the two scope objects.
CIMScope& CIMScope::operator= ( const CIMScope scope  ) 

Assigns the value of the specified CIMScope object to this object.

Parameters:
scope The CIMScope object from which to assign this CIMScope object.
Returns:
A reference to this CIMScope object.
String CIMScope::toString (  )  const

Returns a String representation of the CIMScope object. This method is for diagnostic purposes. The format of the output is subject to change.

Returns:
A String containing a human-readable representation of the scope value.

Member Data Documentation

const CIMScope CIMScope::ANY [static]

Indicates that the qualifier may be used with any of the types of objects (classes, associations, indications, properties, references, methods, parameters).

Indicates that the qualifier may be used with associations.

const CIMScope CIMScope::CLASS [static]

Indicates that the qualifier may be used with classes.

Indicates that the qualifier may be used with indications.

const CIMScope CIMScope::METHOD [static]

Indicates that the qualifier may be used with methods.

const CIMScope CIMScope::NONE [static]

Indicates that the CIMScope object has no value (is uninitialized). This is not a valid qualifier scope.

const CIMScope CIMScope::PARAMETER [static]

Indicates that the qualifier may be used with parameters.

const CIMScope CIMScope::PROPERTY [static]

Indicates that the qualifier may be used with properties.

const CIMScope CIMScope::REFERENCE [static]

Indicates that the qualifier may be used with references.


The documentation for this class was generated from the following file:
  • /builddir/build/BUILD/pegasus/src/Pegasus/Common/CIMScope.h