|
CIMInstance Class Reference#include <CIMInstance.h>
List of all members.
Detailed Description
The CIMInstance class represents the DMTF standard CIM instance definition.
The CIMInstance class uses a shared representation model, such that multiple CIMInstance 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 CIMInstance object affects all the CIMInstance objects that refer to the same data copy. The data remains valid until all the CIMInstance objects that refer to it are destructed. A separate copy of the data may be created using the clone method.
Constructor & Destructor Documentation
CIMInstance::CIMInstance |
( |
|
) |
|
Constructs an uninitialized CIMInstance 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 CIMInstance object from the value of a specified CIMInstance object, so that both objects refer to the same data copy. - Parameters:
-
CIMInstance::CIMInstance |
( |
const CIMObject & |
x |
) |
[explicit] |
Constructs a CIMInstance object from the value of a specified CIMObject object, so that both objects refer to the same data copy. - Parameters:
-
- Exceptions:
-
CIMInstance::CIMInstance |
( |
const CIMName & |
className |
) |
|
Constructs a CIMInstance object with the specified class name. - Parameters:
-
| className | A CIMName specifying the class name of the instance. |
CIMInstance::~CIMInstance |
( |
|
) |
|
Member Function Documentation
Adds a property to the instance. - Parameters:
-
- Returns:
- A reference to this CIMInstance object.
- Exceptions:
-
Adds a qualifier to the instance. - Parameters:
-
- Returns:
- A reference to this CIMInstance object.
- Exceptions:
-
Builds the object path for this instance, based on the class name and property values in the instance and the Key qualifiers on the properties in the class definition. The returned object path does not include hostname and namespace attributes. Note that this method does not update the path attribute of the CIMInstance. - Returns:
- A CIMObjectPath containing the object path for the instance.
- Exceptions:
-
Makes a deep copy of the instance. This creates a new copy of all the instance attributes including qualifiers and properties. - Returns:
- A new copy of the CIMInstance object.
- Exceptions:
-
Uint32 CIMInstance::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 CIMInstance::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& CIMInstance::getClassName |
( |
|
) |
const |
Gets the class name of the instance. - Returns:
- A CIMName containing the class name.
- Exceptions:
-
Gets the object path for the instance. - 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:
-
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:
-
Uint32 CIMInstance::getPropertyCount |
( |
|
) |
const |
Gets the number of properties in the instance. - Returns:
- An integer count of the properties in the CIMInstance.
- 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 CIMInstance::getQualifierCount |
( |
|
) |
const |
Gets the number of qualifiers in the instance. - Returns:
- An integer count of the qualifiers in the CIMInstance.
- Exceptions:
-
Compares the CIMInstance with a specified CIMConstInstance. - Parameters:
-
- Returns:
- True if this instance is identical to the one specified, false otherwise.
- Exceptions:
-
Boolean CIMInstance::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 CIMInstance object to this object, so that both objects refer to the same data copy. - Parameters:
-
- Returns:
- A reference to this CIMInstance object.
void CIMInstance::removeProperty |
( |
Uint32 |
index |
) |
|
Removes a property from the instance. - Parameters:
-
| index | The index of the property to remove. |
- Exceptions:
-
void CIMInstance::removeQualifier |
( |
Uint32 |
index |
) |
|
Removes a qualifier from the instance. - Parameters:
-
| index | The index of the qualifier to remove. |
- Exceptions:
-
Sets the object path for the instance. - Parameters:
-
- Exceptions:
-
The documentation for this class was generated from the following file:
- /scratch/rpmbuild.17644.V17674/pegasus/src/Pegasus/Common/CIMInstance.h
|