CIMConstObject Class Reference
#include <CIMObject.h>
List of all members.
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.
Constructs a CIMConstObject object from the value of a specified CIMConstObject object, so that both objects refer to the same data copy.
- Parameters:
-
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:
-
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:
-
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:
-
Constructs a CIMConstObject object from the value of a specified CIMConstClass object, so that both objects refer to the same data copy.
- Parameters:
-
Constructs a CIMConstObject object from the value of a specified CIMConstInstance object, so that both objects refer to the same data copy.
- Parameters:
-
CIMConstObject::~CIMConstObject |
( |
|
) |
|
Member Function Documentation
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:
-
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:
-
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:
-
const CIMName& CIMConstObject::getClassName |
( |
|
) |
const |
Gets the class name of the object.
- Returns:
- A CIMName containing the class name.
- Exceptions:
-
Gets the object path for the object.
- Returns:
- A CIMObjectPath containing the object path.
- Exceptions:
-
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:
-
Uint32 CIMConstObject::getPropertyCount |
( |
|
) |
const |
Gets the number of properties in the object.
- Returns:
- An integer count of the properties in the CIMConstObject.
- Exceptions:
-
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:
-
Uint32 CIMConstObject::getQualifierCount |
( |
|
) |
const |
Gets the number of qualifiers in the object.
- Returns:
- An integer count of the qualifiers in the CIMConstObject.
- Exceptions:
-
Compares the CIMConstObject with a specified CIMConstObject.
- Parameters:
-
- Returns:
- True if this object is identical to the one specified, false otherwise.
- Exceptions:
-
Boolean CIMConstObject::isClass |
( |
|
) |
const |
Boolean CIMConstObject::isInstance |
( |
|
) |
const |
Boolean CIMConstObject::isUninitialized |
( |
|
) |
const |
Determines whether the object has been initialized.
- Returns:
- True if the object has not been initialized, false otherwise.
Assigns the value of the specified CIMConstObject object to this object, so that both objects refer to the same data copy.
- Parameters:
-
- 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:
-
The documentation for this class was generated from the following file:
- /var/tmp/axbld-24884/rpm/BUILD/pegasus/src/Pegasus/Common/CIMObject.h