|
CIMParameter Class Reference#include <CIMParameter.h>
List of all members.
Detailed Description
The CIMParameter class represents the DMTF standard CIM parameter definition. A CIMParameter is generally defined in the context of a CIMMethod. A CIM Parameter consists of:
-
A CIMName containing the name of the parameter
-
A CIMType defining the parameter type
-
A Boolean indicating whether it is an Array parameter
-
A Uint32 indicating the size of the Array, if the parameter is an Array parameter
-
A CIMName containing the reference class name for this parameter, if the parameter is of reference type
-
Zero or more CIMQualifier objects
The CIMParameter class uses a shared representation model, such that multiple CIMParameter 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 CIMParameter object affects all the CIMParameter objects that refer to the same data copy. The data remains valid until all the CIMParameter objects that refer to it are destructed. A separate copy of the data may be created using the clone method.
Constructor & Destructor Documentation
CIMParameter::CIMParameter |
( |
|
) |
|
Constructs an uninitialized CIMParameter 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 CIMParameter object from the value of a specified CIMParameter object, so that both objects refer to the same data copy. - Parameters:
-
CIMParameter::CIMParameter |
( |
const CIMName & |
name, |
|
|
CIMType |
type, |
|
|
Boolean |
isArray = false , |
|
|
Uint32 |
arraySize = 0 , |
|
|
const CIMName & |
referenceClassName = CIMName() | |
|
) |
| | |
Constructs a CIMParameter 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:
-
CIMParameter::~CIMParameter |
( |
|
) |
|
Member Function Documentation
Adds a qualifier to the parameter. - Parameters:
-
- Returns:
- A reference to this CIMParameter object.
- Exceptions:
-
Makes a deep copy of the parameter. This creates a new copy of all the parameter attributes including qualifiers. - Returns:
- A new copy of the CIMParameter object.
- Exceptions:
-
Uint32 CIMParameter::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 CIMParameter::getArraySize |
( |
|
) |
const |
Gets the array size for the parameter. - Returns:
- Uint32 array size.
- Exceptions:
-
const CIMName& CIMParameter::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:
-
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 CIMParameter::getQualifierCount |
( |
|
) |
const |
Gets the number of qualifiers in the parameter.
loop to access all qualifiers in a CIMparameter
CIMParameter parm;
.... // build the parameter
for (Uint32 i = 0 ; i < parm.getQualifierCount() ; i++)
....
- Returns:
- An integer count of the CIMQualifiers in the CIMParameter.
- Exceptions:
-
const CIMName& CIMParameter::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 CIMParameter::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 CIMParameter::isArray |
( |
|
) |
const |
Checks whether the parameter is an Array parameter. - Returns:
- True if the parameter is an Array parameter, false otherwise.
- Exceptions:
-
Boolean CIMParameter::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 CIMParameter object.
void CIMParameter::removeQualifier |
( |
Uint32 |
index |
) |
|
Removes a qualifier from the parameter. - Parameters:
-
| index | Index of the qualifier to be removed. |
- Exceptions:
-
void CIMParameter::setName |
( |
const CIMName & |
name |
) |
|
Sets the parameter name. - Parameters:
-
| name | A CIMName indicating the new name for the parameter. |
- Exceptions:
-
The documentation for this class was generated from the following file:
- /scratch/rpmbuild.22230.L22270/pegasus/src/Pegasus/Common/CIMParameter.h
|