CIMConstClass Class Reference

#include <CIMClass.h>

List of all members.

Public Member Functions

 CIMConstClass ()
 CIMConstClass (const CIMConstClass &x)
 CIMConstClass (const CIMClass &x)
 CIMConstClass (const CIMObject &x)
 CIMConstClass (const CIMConstObject &x)
 CIMConstClass (const CIMName &className, const CIMName &superClassName=CIMName())
CIMConstClassoperator= (const CIMConstClass &x)
CIMConstClassoperator= (const CIMClass &x)
 ~CIMConstClass ()
Boolean isAssociation () const
Boolean isAbstract () const
const CIMNamegetClassName () const
const CIMObjectPathgetPath () const
const CIMNamegetSuperClassName () const
Uint32 findQualifier (const CIMName &name) const
CIMConstQualifier getQualifier (Uint32 index) const
Uint32 getQualifierCount () const
Uint32 findProperty (const CIMName &name) const
CIMConstProperty getProperty (Uint32 index) const
Uint32 getPropertyCount () const
Uint32 findMethod (const CIMName &name) const
CIMConstMethod getMethod (Uint32 index) const
Uint32 getMethodCount () const
void getKeyNames (Array< CIMName > &keyNames) const
Boolean hasKeys () const
CIMClass clone () const
Boolean identical (const CIMConstClass &x) const
Boolean isUninitialized () const


Detailed Description

The CIMConstClass class provides a const interface to a CIMClass object. This class is needed because the shared representation model used by CIMClass does not prevent modification to a const CIMClass object. Note that the value of a CIMConstClass object could still be modified by a CIMClass object that refers to the same data copy.


Constructor & Destructor Documentation

CIMConstClass::CIMConstClass (  ) 

Constructs an uninitialized CIMConstClass object. A method invocation on an uninitialized object will result in the throwing of an UninitializedObjectException. An uninitialized object may be converted into an initialized object only by using the assignment operator with an initialized object.

CIMConstClass::CIMConstClass ( const CIMConstClass x  ) 

Constructs a CIMConstClass object from the value of a specified CIMConstClass object, so that both objects refer to the same data copy.

Parameters:
x The CIMConstClass object from which to construct a new CIMConstClass object.

CIMConstClass::CIMConstClass ( const CIMClass x  ) 

Constructs a CIMConstClass object from the value of a specified CIMClass object, so that both objects refer to the same data copy.

Parameters:
x The CIMClass object from which to construct a new CIMConstClass object.

CIMConstClass::CIMConstClass ( const CIMObject x  )  [explicit]

Constructs a CIMConstClass object from the value of a specified CIMObject object, so that both objects refer to the same data copy.

Parameters:
x The CIMObject object from which to construct the CIMConstClass object.
Exceptions:
DynamicCastFailedException If a CIMConstClass can not be created from the given CIMObject.

CIMConstClass::CIMConstClass ( const CIMConstObject x  )  [explicit]

Constructs a CIMConstClass object from the value of a specified CIMConstObject object, so that both objects refer to the same data copy.

Parameters:
x The CIMConstObject object from which to construct the CIMConstClass object.
Exceptions:
DynamicCastFailedException If a CIMConstClass can not be created from the given CIMConstObject.

CIMConstClass::CIMConstClass ( const CIMName className,
const CIMName superClassName = CIMName() 
)

Constructs a CIMConstClass object with the specified attributes.

Parameters:
className A CIMName specifying the name of the class.
superClassName A CIMName specifying name of the parent class. (A null value indicates no superclass.)

CIMConstClass::~CIMConstClass (  ) 

Destructs the CIMConstClass object.


Member Function Documentation

CIMClass CIMConstClass::clone (  )  const

Makes a deep copy of the class. This creates a new copy of all the class attributes including qualifiers, properties, and methods.

Returns:
A CIMClass object with a separate copy of the CIMConstClass object.
Exceptions:
UninitializedObjectException If the object is not initialized.

Uint32 CIMConstClass::findMethod ( const CIMName name  )  const

Finds a method by name.

Parameters:
name A CIMName specifying the name of the method to be found.
Returns:
Index of the method if found or PEG_NOT_FOUND if not found.
Exceptions:
UninitializedObjectException If the object is not initialized.

Uint32 CIMConstClass::findProperty ( const CIMName name  )  const

Finds a property by name.

Parameters:
name A CIMName specifying the name of the property to be found.
Returns:
Index of the property if found or PEG_NOT_FOUND if not found.
Exceptions:
UninitializedObjectException If the object is not initialized.

Uint32 CIMConstClass::findQualifier ( const CIMName name  )  const

Finds a qualifier by name.

Parameters:
name A CIMName specifying the name of the qualifier to be found.
Returns:
Index of the qualifier if found or PEG_NOT_FOUND if not found.
Exceptions:
UninitializedObjectException If the object is not initialized.

const CIMName& CIMConstClass::getClassName (  )  const

Gets the name of the class.

Returns:
A CIMName containing the class name.
Exceptions:
UninitializedObjectException If the object is not initialized.

void CIMConstClass::getKeyNames ( Array< CIMName > &  keyNames  )  const

Gets the list of key properties in this class. The Key qualifier on CIMConstProperty objects is used to locate key properties.

Returns:
An Array of CIMName objects containing the names of the key properties.
Exceptions:
UninitializedObjectException If the object is not initialized.

CIMConstMethod CIMConstClass::getMethod ( Uint32  index  )  const

Gets the method at the specified index.

Parameters:
index The index of the method to be retrieved.
Returns:
The CIMConstMethod at the specified index.
Exceptions:
IndexOutOfBoundsException If the index is outside the range of methods available for the CIMConstClass.
UninitializedObjectException If the object is not initialized.

Uint32 CIMConstClass::getMethodCount (  )  const

Gets the number of methods in the class.

Returns:
An integer count of the methods in the CIMConstClass.
Exceptions:
UninitializedObjectException If the object is not initialized.

const CIMObjectPath& CIMConstClass::getPath (  )  const

Gets the object path for the class.

Returns:
A CIMObjectPath containing the object path.
Exceptions:
UninitializedObjectException If the object is not initialized.

CIMConstProperty CIMConstClass::getProperty ( Uint32  index  )  const

Gets the property at the specified index.

Parameters:
index The index of the property to be retrieved.
Returns:
The CIMConstProperty at the specified index.
Exceptions:
IndexOutOfBoundsException If the index is outside the range of properties available for the CIMConstClass.
UninitializedObjectException If the object is not initialized.

Uint32 CIMConstClass::getPropertyCount (  )  const

Gets the number of properties in the class.

Returns:
An integer count of the properties in the CIMConstClass.
Exceptions:
UninitializedObjectException If the object is not initialized.

CIMConstQualifier CIMConstClass::getQualifier ( Uint32  index  )  const

Gets the qualifier at the specified index.

Parameters:
index The index of the qualifier to be retrieved.
Returns:
The CIMConstQualifier at the specified index.
Exceptions:
IndexOutOfBoundsException If the index is outside the range of qualifiers available for the CIMConstClass.
UninitializedObjectException If the object is not initialized.

Uint32 CIMConstClass::getQualifierCount (  )  const

Gets the number of qualifiers in the class.

Returns:
An integer count of the qualifiers in the CIMConstClass.
Exceptions:
UninitializedObjectException If the object is not initialized.

const CIMName& CIMConstClass::getSuperClassName (  )  const

Gets the name of the parent class of this class.

Returns:
A CIMName containing parent class name.
Exceptions:
UninitializedObjectException If the object is not initialized.

Boolean CIMConstClass::hasKeys (  )  const

Indicates whether this class contains key properties. The Key qualifier on CIMConstProperty objects is used to make this determination.

Returns:
True if this class contains key properties, false otherwise.
Exceptions:
UninitializedObjectException If the object is not initialized.

Boolean CIMConstClass::identical ( const CIMConstClass x  )  const

Compares the CIMConstClass with a specified CIMConstClass.

Parameters:
x The CIMConstClass to be compared.
Returns:
True if this class is identical to the one specified, false otherwise.
Exceptions:
UninitializedObjectException If the object is not initialized.

Boolean CIMConstClass::isAbstract (  )  const

Indicates whether this class is an abstract class. The Abstract qualifier is used to make this determination.

Returns:
True if this class is an abstract class, false otherwise.
Exceptions:
UninitializedObjectException If the object is not initialized.

Boolean CIMConstClass::isAssociation (  )  const

Indicates whether this class is an association class. An association is a relationship between two (or more) classes or instances. The Association qualifier is used to make this determination.

Returns:
True if this class is an association class, false otherwise.
Exceptions:
UninitializedObjectException If the object is not initialized.

Boolean CIMConstClass::isUninitialized (  )  const

Determines whether the object has been initialized.

Returns:
True if the object has not been initialized, false otherwise.

CIMConstClass& CIMConstClass::operator= ( const CIMClass x  ) 

Assigns the value of the specified CIMClass object to this object, so that both objects refer to the same data copy.

Parameters:
x The CIMClass object from which to assign this CIMConstClass object.
Returns:
A reference to this CIMConstClass object.

CIMConstClass& CIMConstClass::operator= ( const CIMConstClass x  ) 

Assigns the value of the specified CIMConstClass object to this object, so that both objects refer to the same data copy.

Parameters:
x The CIMConstClass object from which to assign this CIMConstClass object.
Returns:
A reference to this CIMConstClass object.


The documentation for this class was generated from the following file:
  • /scratch/rpmbuild.16050.r16097/pegasus/src/Pegasus/Common/CIMClass.h