version 1.37, 2005/02/05 22:59:23
|
version 1.38, 2005/05/06 17:57:26
|
|
|
/** Construct a CIMParameter from another CIMParameter | /** Construct a CIMParameter from another CIMParameter |
@param CIMParameter from which the new object is to be constructed | @param CIMParameter from which the new object is to be constructed |
*/ | */ |
|
|
CIMParameter(const CIMParameter& x); | CIMParameter(const CIMParameter& x); |
| |
/** Constructs a CIMParameter object with properties. The Properties | /** Constructs a CIMParameter object with properties. The Properties |
|
|
class name. | class name. |
@param name Name of the parameter, a legal CIMName. | @param name Name of the parameter, a legal CIMName. |
@param type CIMType defining the CIM Type for this parameter | @param type CIMType defining the CIM Type for this parameter |
@param IsArray Boolean indicating whether this parameter defines an |
@param isArray Boolean indicating whether this parameter defines an |
array. | array. |
@param arraySize Size of the array if this is to be a fixed size | @param arraySize Size of the array if this is to be a fixed size |
array parameter. The default is zero which indicates variable size array. |
array parameter. The default is zero which indicates a variable size array. |
@param referenceClassName Optional property but required for reference | @param referenceClassName Optional property but required for reference |
type parameters. This defines the class for the reference. | type parameters. This defines the class for the reference. |
@exception TypeMismatchException - if reference type and referenceClassname |
@exception TypeMismatchException Thrown if reference type and referenceClassname |
is Null. | is Null. |
@exception TypeMismatchException - if arraysize != zero and isArray true. |
@exception TypeMismatchException Thrown if arraysize != zero and isArray true. |
*/ | */ |
CIMParameter( | CIMParameter( |
const CIMName& name, | const CIMName& name, |
|
|
Uint32 arraySize = 0, | Uint32 arraySize = 0, |
const CIMName& referenceClassName = CIMName()); | const CIMName& referenceClassName = CIMName()); |
| |
/// Destructor. |
/** Destroys the object. |
|
*/ |
~CIMParameter(); | ~CIMParameter(); |
| |
/** Assignment operator. Assigns one CIMParameter to | /** Assignment operator. Assigns one CIMParameter to |
|
|
const CIMName& getName() const ; | const CIMName& getName() const ; |
| |
/** Set the name field in the object with a valid CIMName | /** Set the name field in the object with a valid CIMName |
@param CIMName to set into name field. |
@param name CIMName to set into the name field. |
*/ | */ |
void setName(const CIMName& name); | void setName(const CIMName& name); |
| |
|
|
CIMType getType() const ; | CIMType getType() const ; |
| |
/** Add a single qualifier object to the CIMParameter. | /** Add a single qualifier object to the CIMParameter. |
@param CIMQualifier object to be added. |
@param x CIMQualifier object to be added. |
@exception AlreadyExistsException if a qualifier with the | @exception AlreadyExistsException if a qualifier with the |
same name already exists for this CIMParameter. | same name already exists for this CIMParameter. |
*/ | */ |
|
|
/** Find a qualifier by name. Finds a single qualifier | /** Find a qualifier by name. Finds a single qualifier |
based on the name input as parameter and returns an | based on the name input as parameter and returns an |
index to the name. | index to the name. |
@param CIMName with the name of the qualifier to be found |
@param name CIMName with the name of the qualifier to be found |
@return Uint32 with either the index (zero origin) of | @return Uint32 with either the index (zero origin) of |
the parameter that was to be found or the value | the parameter that was to be found or the value |
PEG_NOT_FOUND if no parameter is found with the | PEG_NOT_FOUND if no parameter is found with the |
|
|
/** Get qualifier at index defined by input. Gets the | /** Get qualifier at index defined by input. Gets the |
qualifier in the array of qualifiers for this parameter | qualifier in the array of qualifiers for this parameter |
defined by the index provided on input. | defined by the index provided on input. |
@param index defining the position in the qualifier array |
@param index Specifies the position in the qualifier array |
of the qualifier to be retrieved | of the qualifier to be retrieved |
@return CIMQualifier object containing the qualifer defined | @return CIMQualifier object containing the qualifer defined |
by the index | by the index |
@exception IndexOutOfBoundsException thrown if index outside | @exception IndexOutOfBoundsException thrown if index outside |
the array of qualifiers. | the array of qualifiers. |
|
|
*/ | */ |
CIMQualifier getQualifier(Uint32 index); | CIMQualifier getQualifier(Uint32 index); |
| |
/** Removes the CIMQualifier defined by the input parameter. | /** Removes the CIMQualifier defined by the input parameter. |
@param index - Index of the qualifier to be removed. |
@param index Index of the qualifier to be removed. |
@exception IndexOutOfBoundsException if the index is outside | @exception IndexOutOfBoundsException if the index is outside |
the range of qualifiers available for the CIMParameter. | the range of qualifiers available for the CIMParameter. |
@exception IndexOutOfBoundsException thrown if index outside | @exception IndexOutOfBoundsException thrown if index outside |
|
|
*/ | */ |
void removeQualifier (Uint32 index); | void removeQualifier (Uint32 index); |
| |
/// |
/** Get qualifier at index defined by input. Gets the |
|
qualifier in the array of qualifiers for this parameter |
|
defined by the index provided on input. |
|
@param index Specifies the position in the qualifier array |
|
of the qualifier to be retrieved |
|
@return CIMQualifier object containing the qualifer defined |
|
by the index |
|
@exception IndexOutOfBoundsException thrown if index outside |
|
the array of qualifiers. |
|
*/ |
CIMConstQualifier getQualifier(Uint32 index) const; | CIMConstQualifier getQualifier(Uint32 index) const; |
| |
/** Gets the count of qualifiers attached to this CIMParameter. | /** Gets the count of qualifiers attached to this CIMParameter. |
|
|
/// | /// |
Boolean identical(const CIMConstParameter& x) const; | Boolean identical(const CIMConstParameter& x) const; |
| |
/// |
/** Creates a deep copy, i.e. a clone, of the associated object. |
|
@return The deep copy of the associated object. |
|
*/ |
CIMParameter clone() const; | CIMParameter clone() const; |
| |
private: | private: |