#include <CIMObject.h>
List of all members.
Detailed Description
The CIMObject class represents the DMTF standard CIM object definition, which may represent a CIMClass or a CIMInstance.
The CIMObject class uses a shared representation model, such that multiple CIMObject objects may refer to the same data copy. Assignment and copy operators create new references to the same data, not distinct copies. An update to a CIMObject object affects all the CIMObject objects that refer to the same data copy. The data remains valid until all the CIMObject objects that refer to it are destructed. A separate copy of the data may be created using the clone method.
Constructor & Destructor Documentation
Constructs an uninitialized CIMObject 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 CIMObject object from the value of a specified CIMObject object, so that both objects refer to the same data copy.
- Parameters:
-
CIMObject::CIMObject |
( |
const CIMClass & |
x |
) |
|
Constructs a CIMObject object from the value of a specified CIMClass object, so that both objects refer to the same data copy.
- Parameters:
-
Constructs a CIMObject object from the value of a specified CIMInstance object, so that both objects refer to the same data copy.
- Parameters:
-
CIMObject::~CIMObject |
( |
|
) |
|
Member Function Documentation
Adds a property to the object.
- Parameters:
-
- Returns:
- A reference to this CIMObject object.
- Exceptions:
-
Adds a qualifier to the object.
- Parameters:
-
- Returns:
- A reference to this CIMObject object.
- Exceptions:
-
Makes a deep copy of the object. This creates a new copy of all the object attributes including qualifiers and properties.
- Returns:
- A new copy of the CIMObject object.
- Exceptions:
-
Uint32 CIMObject::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 CIMObject::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& CIMObject::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 CIMProperty at the specified index.
- 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 CIMObject::getPropertyCount |
( |
|
) |
const |
Gets the number of properties in the object.
- Returns:
- An integer count of the properties in the CIMObject.
- 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:
-
Gets the qualifier at the specified index.
- Parameters:
-
| index | The index of the qualifier to be retrieved. |
- Returns:
- The CIMQualifier at the specified index.
- Exceptions:
-
Uint32 CIMObject::getQualifierCount |
( |
|
) |
const |
Gets the number of qualifiers in the object.
- Returns:
- An integer count of the qualifiers in the CIMObject.
- Exceptions:
-
Compares the CIMObject with a specified CIMConstObject.
- Parameters:
-
- Returns:
- True if this object is identical to the one specified, false otherwise.
- Exceptions:
-
Boolean CIMObject::isClass |
( |
|
) |
const |
Indicates whether the object represents a CIMClass.
- Returns:
- True if the object represents a CIMClass; false otherwise.
Boolean CIMObject::isInstance |
( |
|
) |
const |
Indicates whether the object represents a CIMInstance.
- Returns:
- True if the object represents a CIMInstance; false otherwise.
Boolean CIMObject::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 CIMObject object to this object, so that both objects refer to the same data copy.
- Parameters:
-
- Returns:
- A reference to this CIMObject object.
void CIMObject::removeProperty |
( |
Uint32 |
index |
) |
|
Removes a property from the object.
- Parameters:
-
| index | The index of the property to remove. |
- Exceptions:
-
void CIMObject::removeQualifier |
( |
Uint32 |
index |
) |
|
Removes a qualifier from the object.
- Parameters:
-
| index | The index of the qualifier to remove. |
- Exceptions:
-
Sets the object path for the object.
- Parameters:
-
- Exceptions:
-
String CIMObject::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:
- /home/builduser/trunk/pkgs/tog-pegasus/BUILD/pegasus/src/Pegasus/Common/CIMObject.h