CIMConstObject Class Reference

#include <CIMObject.h>

List of all members.

Public Member Functions

 CIMConstObject ()
 CIMConstObject (const CIMConstObject &x)
 CIMConstObject (const CIMObject &x)
 CIMConstObject (const CIMClass &x)
 CIMConstObject (const CIMInstance &x)
 CIMConstObject (const CIMConstClass &x)
 CIMConstObject (const CIMConstInstance &x)
CIMConstObjectoperator= (const CIMConstObject &x)
 ~CIMConstObject ()
const CIMNamegetClassName () const
const CIMObjectPathgetPath () 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
CIMObject clone () const
Boolean identical (const CIMConstObject &x) const
Boolean isUninitialized () const
String toString () const
Boolean isClass () const
Boolean isInstance () const

Detailed Description

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


Constructor & Destructor Documentation

CIMConstObject::CIMConstObject (  ) 

Constructs an uninitialized CIMConstObject 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.

CIMConstObject::CIMConstObject ( const CIMConstObject x  ) 

Constructs a CIMConstObject 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 a new CIMConstObject object.
CIMConstObject::CIMConstObject ( const CIMObject x  ) 

Constructs a CIMConstObject 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 a new CIMConstObject object.
CIMConstObject::CIMConstObject ( const CIMClass x  ) 

Constructs a CIMConstObject 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 the CIMConstObject object.
CIMConstObject::CIMConstObject ( const CIMInstance x  ) 

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

Parameters:
x The CIMInstance object from which to construct the CIMConstObject object.
CIMConstObject::CIMConstObject ( const CIMConstClass x  ) 

Constructs a CIMConstObject 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 the CIMConstObject object.
CIMConstObject::CIMConstObject ( const CIMConstInstance x  ) 

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

Parameters:
x The CIMConstInstance object from which to construct the CIMConstObject object.
CIMConstObject::~CIMConstObject (  ) 

Destructs the CIMConstObject object.


Member Function Documentation

CIMObject CIMConstObject::clone (  )  const

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

Returns:
A CIMObject object with a separate copy of the CIMConstObject object.
Exceptions:
UninitializedObjectException If the object is not initialized.
Uint32 CIMConstObject::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 CIMConstObject::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& CIMConstObject::getClassName (  )  const

Gets the class name of the object.

Returns:
A CIMName containing the class name.
Exceptions:
UninitializedObjectException If the object is not initialized.
const CIMObjectPath& CIMConstObject::getPath (  )  const

Gets the object path for the object.

Returns:
A CIMObjectPath containing the object path.
Exceptions:
UninitializedObjectException If the object is not initialized.
CIMConstProperty CIMConstObject::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 CIMConstObject.
UninitializedObjectException If the object is not initialized.
Uint32 CIMConstObject::getPropertyCount (  )  const

Gets the number of properties in the object.

Returns:
An integer count of the properties in the CIMConstObject.
Exceptions:
UninitializedObjectException If the object is not initialized.
CIMConstQualifier CIMConstObject::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 CIMConstObject.
UninitializedObjectException If the object is not initialized.
Uint32 CIMConstObject::getQualifierCount (  )  const

Gets the number of qualifiers in the object.

Returns:
An integer count of the qualifiers in the CIMConstObject.
Exceptions:
UninitializedObjectException If the object is not initialized.
Boolean CIMConstObject::identical ( const CIMConstObject x  )  const

Compares the CIMConstObject with a specified CIMConstObject.

Parameters:
x The CIMConstObject to be compared.
Returns:
True if this object is identical to the one specified, false otherwise.
Exceptions:
UninitializedObjectException If the object is not initialized.
Boolean CIMConstObject::isClass (  )  const

Indicates whether the object represents a CIMConstClass.

Returns:
True if the object represents a CIMConstClass; false otherwise.
Boolean CIMConstObject::isInstance (  )  const

Indicates whether the object represents a CIMConstInstance.

Returns:
True if the object represents a CIMConstInstance; false otherwise.
Boolean CIMConstObject::isUninitialized (  )  const

Determines whether the object has been initialized.

Returns:
True if the object has not been initialized, false otherwise.
CIMConstObject& CIMConstObject::operator= ( const CIMConstObject x  ) 

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

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

Generates a human-readable String representing the value of the CIMObject. The String may be in MOF format, but the format is not guaranteed and may change without notice.

Returns:
A human-readable String representing the CIMObject value.
Exceptions:
UninitializedObjectException If the object is not initialized.

The documentation for this class was generated from the following file:
  • /var/tmp/axbld-11697/rpm/BUILD/pegasus/src/Pegasus/Common/CIMObject.h