|
CIMConstProperty Class Reference#include <CIMProperty.h>
List of all members.
Detailed Description
The CIMConstProperty class provides a const interface to a CIMProperty object. This class is needed because the shared representation model used by CIMProperty does not prevent modification to a const CIMProperty object. Note that the value of a CIMConstProperty object could still be modified by a CIMProperty object that refers to the same data copy.
Constructor & Destructor Documentation
CIMConstProperty::CIMConstProperty |
( |
|
) |
|
Constructs an uninitialized CIMConstProperty 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.
CIMConstProperty::CIMConstProperty |
( |
const CIMProperty & |
x |
) |
|
Constructs a CIMConstProperty object from the value of a specified CIMProperty object, so that both objects refer to the same data copy. - Parameters:
-
CIMConstProperty::CIMConstProperty |
( |
const CIMName & |
name, |
|
|
const CIMValue & |
value, |
|
|
Uint32 |
arraySize = 0 , |
|
|
const CIMName & |
referenceClassName = CIMName() , |
|
|
const CIMName & |
classOrigin = CIMName() , |
|
|
Boolean |
propagated = false | |
|
) |
| | |
Constructs a CIMConstProperty object with the specified attributes. - Parameters:
-
| name | A CIMName specifying the name of the property. |
| value | A CIMValue specifying the property value, and implicitly defining the property type and whether the property is an Array property. |
| arraySize | A Uint32 indicating the size of the Array, if the property is an Array property. The default value of zero indicates a variable size array. |
| referenceClassName | A CIMName containing the reference class name for this property, if the property is of reference type. |
| classOrigin | A CIMName indicating the class in which the property is locally defined (optional). |
| propagated | A Boolean indicating whether the property is local to the class or instance in which it appears or was propagated (without modification) from other schema. |
- Exceptions:
-
CIMConstProperty::~CIMConstProperty |
( |
|
) |
|
Member Function Documentation
Makes a deep copy of the property. This creates a new copy of all the property attributes including qualifiers. - Returns:
- A CIMProperty object with a separate copy of the CIMConstProperty object.
- Exceptions:
-
Uint32 CIMConstProperty::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:
-
Uint32 CIMConstProperty::getArraySize |
( |
|
) |
const |
Gets the array size for the property. - Returns:
- Uint32 array size.
- Exceptions:
-
const CIMName& CIMConstProperty::getClassOrigin |
( |
|
) |
const |
Gets the class in which this property is locally defined. This information is normally available with properties that are part of schema returned from a CIM Server. - Returns:
- CIMName containing the classOrigin attribute.
- Exceptions:
-
const CIMName& CIMConstProperty::getName |
( |
|
) |
const |
Gets the name of the property. - Returns:
- A CIMName containing the name of the property.
- Exceptions:
-
Boolean CIMConstProperty::getPropagated |
( |
|
) |
const |
Tests the propagated attribute of the object. The propagated attribute indicates whether this property was propagated from a higher-level class. Normally this attribute is set as part of defining a property in the context of a schema. It is set in properties retrieved from a CIM Server. - Returns:
- True if property is propagated; otherwise, false.
- Exceptions:
-
Gets the qualifier at the specified index. - Parameters:
-
| index | The index of the qualifier to be retrieved. |
- Returns:
- The CIMConstQualifier object at the specified index.
- Exceptions:
-
Uint32 CIMConstProperty::getQualifierCount |
( |
|
) |
const |
Gets the number of qualifiers in the property. - Returns:
- An integer count of the qualifiers in the CIMConstProperty.
- Exceptions:
-
const CIMName& CIMConstProperty::getReferenceClassName |
( |
|
) |
const |
Gets the reference class name for the property. - Returns:
- A CIMName containing the reference class name for the property if the property is of reference type, a null CIMName otherwise.
- Exceptions:
-
CIMType CIMConstProperty::getType |
( |
|
) |
const |
Gets the property type. - Returns:
- A CIMType containing the property type.
- Exceptions:
-
const CIMValue& CIMConstProperty::getValue |
( |
|
) |
const |
Gets the property value. - Returns:
- A CIMValue containing the property value.
- Exceptions:
-
Compares the property with another property. - Parameters:
-
- Returns:
- True if this property is identical to the one specified, false otherwise.
- Exceptions:
-
Boolean CIMConstProperty::isArray |
( |
|
) |
const |
Checks whether the property is an Array property. - Returns:
- True if the property is an Array property, false otherwise.
- Exceptions:
-
Boolean CIMConstProperty::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 CIMProperty object to this object, so that both objects refer to the same data copy. - Parameters:
-
- Returns:
- A reference to this CIMConstProperty object.
Assigns the value of the specified CIMConstProperty object to this object, so that both objects refer to the same data copy. - Parameters:
-
- Returns:
- A reference to this CIMConstProperty object.
The documentation for this class was generated from the following file:
- /scratch/rpmbuild.22230.L22270/pegasus/src/Pegasus/Common/CIMProperty.h
|