CIMConstParameter Class Reference
#include <CIMParameter.h>
List of all members.
Detailed Description
The CIMConstParameter class provides a const interface to a CIMParameter object. This class is needed because the shared representation model used by CIMParameter does not prevent modification to a const CIMParameter object. Note that the value of a CIMConstParameter object could still be modified by a CIMParameter object that refers to the same data copy.
Constructor & Destructor Documentation
CIMConstParameter::CIMConstParameter |
( |
|
) |
|
Constructs an uninitialized CIMConstParameter 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.
CIMConstParameter::CIMConstParameter |
( |
const CIMParameter & |
x |
) |
|
Constructs a CIMConstParameter object from the value of a specified CIMParameter object, so that both objects refer to the same data copy.
- Parameters:
-
CIMConstParameter::CIMConstParameter |
( |
const CIMName & |
name, |
|
|
CIMType |
type, |
|
|
Boolean |
isArray = false , |
|
|
Uint32 |
arraySize = 0 , |
|
|
const CIMName & |
referenceClassName = CIMName() | |
|
) |
| | |
Constructs a CIMConstParameter object with the specified attributes.
- Parameters:
-
| name | A CIMName specifying the name of the parameter. |
| type | A CIMType defining the parameter type. |
| isArray | A Boolean indicating whether it is an Array parameter. |
| arraySize | A Uint32 indicating the size of the Array, if the parameter is an Array parameter. The default value of zero indicates a variable size array. |
| referenceClassName | A CIMName containing the reference class name for this parameter, if the parameter is of reference type. |
- Exceptions:
-
CIMConstParameter::~CIMConstParameter |
( |
|
) |
|
Member Function Documentation
Makes a deep copy of the parameter. This creates a new copy of all the parameter attributes including qualifiers.
- Returns:
- A CIMParameter object with a separate copy of the CIMConstParameter object.
- Exceptions:
-
Uint32 CIMConstParameter::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 CIMConstParameter::getArraySize |
( |
|
) |
const |
Gets the array size for the parameter.
- Returns:
- Uint32 array size.
- Exceptions:
-
const CIMName& CIMConstParameter::getName |
( |
|
) |
const |
Gets the parameter name.
- Returns:
- A CIMName containing the name of the parameter.
- 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 CIMConstParameter::getQualifierCount |
( |
|
) |
const |
Gets the number of qualifiers in the parameter.
- Returns:
- An integer count of the qualifiers in the CIMParameter.
- Exceptions:
-
const CIMName& CIMConstParameter::getReferenceClassName |
( |
|
) |
const |
Gets the reference class name for the parameter.
- Returns:
- A CIMName containing the reference class name for the parameter if the parameter is of reference type, a null CIMName otherwise.
- Exceptions:
-
CIMType CIMConstParameter::getType |
( |
|
) |
const |
Gets the parameter type.
- Returns:
- A CIMType indicating the type of this parameter.
- Exceptions:
-
Compares the parameter with another parameter.
- Parameters:
-
- Returns:
- True if this parameter is identical to the one specified, false otherwise.
- Exceptions:
-
Boolean CIMConstParameter::isArray |
( |
|
) |
const |
Checks whether the parameter is an Array parameter.
- Returns:
- True if the parameter is an Array parameter, false otherwise.
- Exceptions:
-
Boolean CIMConstParameter::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 CIMParameter object to this object, so that both objects refer to the same data copy.
- Parameters:
-
- Returns:
- A reference to this CIMConstParameter object.
Assigns the value of the specified CIMConstParameter object to this object, so that both objects refer to the same data copy.
- Parameters:
-
- Returns:
- A reference to this CIMConstParameter object.
The documentation for this class was generated from the following file:
- /var/tmp/axbld-24884/rpm/BUILD/pegasus/src/Pegasus/Common/CIMParameter.h