CIMConstParameter Class Reference

#include <CIMParameter.h>

Public Member Functions

 CIMConstParameter ()
 
 CIMConstParameter (const CIMConstParameter &x)
 
 CIMConstParameter (const CIMParameter &x)
 
 CIMConstParameter (const CIMName &name, CIMType type, Boolean isArray=false, Uint32 arraySize=0, const CIMName &referenceClassName=CIMName())
 
 ~CIMConstParameter ()
 
CIMConstParameteroperator= (const CIMConstParameter &x)
 
CIMConstParameteroperator= (const CIMParameter &x)
 
const CIMNamegetName () const
 
Boolean isArray () const
 
Uint32 getArraySize () const
 
const CIMNamegetReferenceClassName () const
 
CIMType getType () const
 
Uint32 findQualifier (const CIMName &name) const
 
CIMConstQualifier getQualifier (Uint32 index) const
 
Uint32 getQualifierCount () const
 
Boolean isUninitialized () const
 
Boolean identical (const CIMConstParameter &x) const
 
CIMParameter clone () const
 

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() [1/4]

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() [2/4]

CIMConstParameter::CIMConstParameter ( const CIMConstParameter x)

Constructs a CIMConstParameter object from the value of a specified CIMConstParameter object, so that both objects refer to the same data copy.

Parameters
xThe CIMConstParameter object from which to construct a new CIMConstParameter object.

◆ CIMConstParameter() [3/4]

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
xThe CIMParameter object from which to construct a new CIMConstParameter object.

◆ CIMConstParameter() [4/4]

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
nameA CIMName specifying the name of the parameter.
typeA CIMType defining the parameter type.
isArrayA Boolean indicating whether it is an Array parameter.
arraySizeA Uint32 indicating the size of the Array, if the parameter is an Array parameter. The default value of zero indicates a variable size array.
referenceClassNameA CIMName containing the reference class name for this parameter, if the parameter is of reference type.
Exceptions
TypeMismatchExceptionIf the parameter is of reference type and referenceClassName is null.
TypeMismatchExceptionIf isArray is true and arraySize is not zero.

◆ ~CIMConstParameter()

CIMConstParameter::~CIMConstParameter ( )

Destructs the CIMConstParameter object.

Member Function Documentation

◆ clone()

CIMParameter CIMConstParameter::clone ( ) const

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
UninitializedObjectExceptionIf the object is not initialized.

◆ findQualifier()

Uint32 CIMConstParameter::findQualifier ( const CIMName name) const

Finds a qualifier by name.

Parameters
nameA 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
UninitializedObjectExceptionIf the object is not initialized.

◆ getArraySize()

Uint32 CIMConstParameter::getArraySize ( ) const

Gets the array size for the parameter.

Returns
Uint32 array size.
Exceptions
UninitializedObjectExceptionIf the object is not initialized.

◆ getName()

const CIMName& CIMConstParameter::getName ( ) const

Gets the parameter name.

Returns
A CIMName containing the name of the parameter.
Exceptions
UninitializedObjectExceptionIf the object is not initialized.

◆ getQualifier()

CIMConstQualifier CIMConstParameter::getQualifier ( Uint32  index) const

Gets the qualifier at the specified index.

Parameters
indexThe index of the qualifier to be retrieved.
Returns
The CIMConstQualifier at the specified index.
Exceptions
IndexOutOfBoundsExceptionIf the index is outside the range of qualifiers available for the CIMParameter.
UninitializedObjectExceptionIf the object is not initialized.

◆ getQualifierCount()

Uint32 CIMConstParameter::getQualifierCount ( ) const

Gets the number of qualifiers in the parameter.

Returns
An integer count of the qualifiers in the CIMParameter.
Exceptions
UninitializedObjectExceptionIf the object is not initialized.

◆ getReferenceClassName()

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
UninitializedObjectExceptionIf the object is not initialized.

◆ getType()

CIMType CIMConstParameter::getType ( ) const

Gets the parameter type.

Returns
A CIMType indicating the type of this parameter.
Exceptions
UninitializedObjectExceptionIf the object is not initialized.

◆ identical()

Boolean CIMConstParameter::identical ( const CIMConstParameter x) const

Compares the parameter with another parameter.

Parameters
xThe CIMConstParameter to be compared.
Returns
True if this parameter is identical to the one specified, false otherwise.
Exceptions
UninitializedObjectExceptionIf either of the objects is not initialized.

◆ isArray()

Boolean CIMConstParameter::isArray ( ) const

Checks whether the parameter is an Array parameter.

Returns
True if the parameter is an Array parameter, false otherwise.
Exceptions
UninitializedObjectExceptionIf the object is not initialized.

◆ isUninitialized()

Boolean CIMConstParameter::isUninitialized ( ) const

Determines whether the object has been initialized.

Returns
True if the object has not been initialized, false otherwise.

◆ operator=() [1/2]

CIMConstParameter& CIMConstParameter::operator= ( const CIMConstParameter x)

Assigns the value of the specified CIMConstParameter object to this object, so that both objects refer to the same data copy.

Parameters
xThe CIMConstParameter object from which to assign this CIMConstParameter object.
Returns
A reference to this CIMConstParameter object.

◆ operator=() [2/2]

CIMConstParameter& CIMConstParameter::operator= ( const CIMParameter x)

Assigns the value of the specified CIMParameter object to this object, so that both objects refer to the same data copy.

Parameters
xThe CIMParameter object from which to assign this CIMConstParameter object.
Returns
A reference to this CIMConstParameter object.

The documentation for this class was generated from the following file: